From 75fa230c87ad6d09ee46d7aa43e25bb961aed4ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 13:57:48 +0200 Subject: [PATCH 01/16] RDoc-3724 - Fix broken intra-version links in legacy docs (snmp, replication, backup, counters, setup-wizard) --- .../server/administration/monitoring/snmp/setup-zabbix.mdx | 2 +- .../version-4.0/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../version-4.1/client-api/smuggler/what-is-smuggler.mdx | 2 +- .../version-4.1/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../version-4.2/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../version-5.0/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../version-5.1/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../version-5.2/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../version-5.3/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../document-extensions/counters/including-counters.mdx | 2 +- .../version-5.4/server/administration/snmp/setup-zabbix.mdx | 2 +- .../maintenance/connection-strings/add-connection-string.mdx | 2 +- .../client-api/operations/server-wide/restore-backup.mdx | 2 +- .../document-extensions/counters/including-counters.mdx | 2 +- .../version-6.0/server/administration/snmp/setup-zabbix.mdx | 2 +- .../start/installation/setup-wizard/finish-setup.mdx | 2 +- 30 files changed, 30 insertions(+), 30 deletions(-) diff --git a/versioned_docs/version-3.5/server/administration/monitoring/snmp/setup-zabbix.mdx b/versioned_docs/version-3.5/server/administration/monitoring/snmp/setup-zabbix.mdx index 61e2804d77..54fe1efe91 100644 --- a/versioned_docs/version-3.5/server/administration/monitoring/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-3.5/server/administration/monitoring/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Monitoring: How to Setup Zabbix Monitoring -RavenDB 3.5 supports [SNNP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB 3.5 supports [SNNP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-4.0/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-4.0/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-4.0/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-4.0/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-4.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-4.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index 0f365c3f38..083357442b 100644 --- a/versioned_docs/version-4.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-4.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-4.1/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-4.1/client-api/operations/server-wide/restore-backup.mdx index 9d62b17570..02ef9ded95 100644 --- a/versioned_docs/version-4.1/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-4.1/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-4.1/client-api/smuggler/what-is-smuggler.mdx b/versioned_docs/version-4.1/client-api/smuggler/what-is-smuggler.mdx index fc440df4c2..7ad4013cc4 100644 --- a/versioned_docs/version-4.1/client-api/smuggler/what-is-smuggler.mdx +++ b/versioned_docs/version-4.1/client-api/smuggler/what-is-smuggler.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Operations > Server-Maintenance" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-4.1/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-4.1/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-4.1/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-4.1/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-4.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-4.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index 0f365c3f38..083357442b 100644 --- a/versioned_docs/version-4.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-4.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-4.2/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-4.2/client-api/operations/server-wide/restore-backup.mdx index 9d62b17570..02ef9ded95 100644 --- a/versioned_docs/version-4.2/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-4.2/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-4.2/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-4.2/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-4.2/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-4.2/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-5.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-5.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index 0f365c3f38..083357442b 100644 --- a/versioned_docs/version-5.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-5.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-5.0/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-5.0/client-api/operations/server-wide/restore-backup.mdx index 9d62b17570..02ef9ded95 100644 --- a/versioned_docs/version-5.0/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-5.0/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-5.0/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-5.0/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-5.0/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-5.0/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-5.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-5.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index 0f365c3f38..083357442b 100644 --- a/versioned_docs/version-5.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-5.1/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-5.1/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-5.1/client-api/operations/server-wide/restore-backup.mdx index eb760d32e0..1ee278cf73 100644 --- a/versioned_docs/version-5.1/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-5.1/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-5.1/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-5.1/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-5.1/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-5.1/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-5.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-5.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index b36fd5c19f..b4318f6863 100644 --- a/versioned_docs/version-5.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-5.2/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio > Database Management > Tasks > Ongoing Tasks" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-5.2/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-5.2/client-api/operations/server-wide/restore-backup.mdx index 0fa6d2b067..504ee5874c 100644 --- a/versioned_docs/version-5.2/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-5.2/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-5.2/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-5.2/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-5.2/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-5.2/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-5.3/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-5.3/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index b36fd5c19f..b4318f6863 100644 --- a/versioned_docs/version-5.3/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-5.3/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio > Database Management > Tasks > Ongoing Tasks" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-5.3/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-5.3/client-api/operations/server-wide/restore-backup.mdx index 0fa6d2b067..504ee5874c 100644 --- a/versioned_docs/version-5.3/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-5.3/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-5.3/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-5.3/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-5.3/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-5.3/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-5.4/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-5.4/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index b36fd5c19f..b4318f6863 100644 --- a/versioned_docs/version-5.4/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-5.4/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio > Database Management > Tasks > Ongoing Tasks" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-5.4/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-5.4/client-api/operations/server-wide/restore-backup.mdx index 0fa6d2b067..504ee5874c 100644 --- a/versioned_docs/version-5.4/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-5.4/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-5.4/document-extensions/counters/including-counters.mdx b/versioned_docs/version-5.4/document-extensions/counters/including-counters.mdx index 3086898190..6b4a00f27c 100644 --- a/versioned_docs/version-5.4/document-extensions/counters/including-counters.mdx +++ b/versioned_docs/version-5.4/document-extensions/counters/including-counters.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Document Extensions > Counters" - title: "Counters in a cluster" - link: "document-extensions/counters/counters-in-a-cluster" + link: "document-extensions/counters/counters-in-clusters" source: "docs" path: "Document Extensions > Counters" - title: "Counters Operations" diff --git a/versioned_docs/version-5.4/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-5.4/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-5.4/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-5.4/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-6.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx b/versioned_docs/version-6.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx index b36fd5c19f..b4318f6863 100644 --- a/versioned_docs/version-6.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx +++ b/versioned_docs/version-6.0/client-api/operations/maintenance/connection-strings/add-connection-string.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Studio > Database Management > Tasks > Ongoing Tasks" - title: "How Replication Works" - link: "server/clustering/replication/replication" + link: "server/clustering/replication/replication-overview" source: "docs" path: "Server > Clustering > Replication" --- diff --git a/versioned_docs/version-6.0/client-api/operations/server-wide/restore-backup.mdx b/versioned_docs/version-6.0/client-api/operations/server-wide/restore-backup.mdx index 0fa6d2b067..504ee5874c 100644 --- a/versioned_docs/version-6.0/client-api/operations/server-wide/restore-backup.mdx +++ b/versioned_docs/version-6.0/client-api/operations/server-wide/restore-backup.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Client API > Smuggler" - title: "Backup" - link: "client-api/operations/maintenance/backup/backup" + link: "client-api/operations/maintenance/backup/backup-overview" source: "docs" path: "Client API > Operations > Maintenance Operations > Backup" - title: "Backup Overview" diff --git a/versioned_docs/version-6.0/document-extensions/counters/including-counters.mdx b/versioned_docs/version-6.0/document-extensions/counters/including-counters.mdx index 3086898190..6b4a00f27c 100644 --- a/versioned_docs/version-6.0/document-extensions/counters/including-counters.mdx +++ b/versioned_docs/version-6.0/document-extensions/counters/including-counters.mdx @@ -25,7 +25,7 @@ see_also: source: "docs" path: "Document Extensions > Counters" - title: "Counters in a cluster" - link: "document-extensions/counters/counters-in-a-cluster" + link: "document-extensions/counters/counters-in-clusters" source: "docs" path: "Document Extensions > Counters" - title: "Counters Operations" diff --git a/versioned_docs/version-6.0/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-6.0/server/administration/snmp/setup-zabbix.mdx index de95cb1828..c3bd79be7b 100644 --- a/versioned_docs/version-6.0/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-6.0/server/administration/snmp/setup-zabbix.mdx @@ -13,7 +13,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # How to Setup Zabbix Monitoring -RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix. +RavenDB supports [SNMP](./snmp-overview), which means that with a few quick steps you can monitor your server using Zabbix. ### Installation diff --git a/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx b/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx index 81be6f8580..170d9874eb 100644 --- a/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx +++ b/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx @@ -31,7 +31,7 @@ import Panel from '@site/src/components/Panel'; The wizard performs several background tasks and displays them in a real-time configuration log. While the process depends on your [Setup method](../../../start/installation/setup-wizard/choose-setup-method.mdx) -and [Chosen security method](../../../start/installation/setup-wizard/choose-security-method.mdx), it generally follows these stages: +and [Chosen security method](../../../start/installation/setup-wizard/choose-security-option.mdx), it generally follows these stages: * **Validation**: RavenDB verifies the configuration you provided in earlier steps, including file paths, network settings, and license validity. From f69f3ac2b9624a86ef18e1fc6ee7447ccd1ba625 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 13:58:28 +0200 Subject: [PATCH 02/16] RDoc-3724 - Remove todo placeholder link in 7.0 finish-setup --- .../start/installation/setup-wizard/finish-setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx b/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx index 170d9874eb..6890590b84 100644 --- a/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx +++ b/versioned_docs/version-7.0/start/installation/setup-wizard/finish-setup.mdx @@ -126,7 +126,7 @@ Once the configuration completes successfully: It contains all the necessary cluster configuration files and certificates. * If you are setting up a multi-node cluster, copy this _.zip_ file to each of your remaining server machines. - You will use it to set up the other nodes. See [Use setup package](../../../todo). + You will use it to set up the other nodes. See Use setup package. * Here is an example of the extracted ZIP package contents for a **3-node secure** cluster: From 5790d32f890dcf5247a7897f59155523746ccb5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 14:08:05 +0200 Subject: [PATCH 03/16] RDoc-3724 - Retarget more broken legacy links (setup-wizard, query-index, cloud, querying overview, licensing) --- .../start/guides/cloudflare-workers/existing-project.mdx | 2 +- versioned_docs/version-6.0/indexes/javascript-indexes.mdx | 2 +- .../start/guides/cloudflare-workers/existing-project.mdx | 2 +- .../client-api/commands/documents/content/_get-csharp.mdx | 2 +- .../client-api/commands/documents/content/_get-nodejs.mdx | 2 +- .../querying/content/_how-to-customize-query-csharp.mdx | 4 ++-- .../querying/content/_how-to-customize-query-nodejs.mdx | 4 ++-- .../session/querying/content/_how-to-customize-query-php.mdx | 4 ++-- .../querying/content/_how-to-customize-query-python.mdx | 4 ++-- .../content/_how-to-filter-by-non-existing-field-csharp.mdx | 2 +- .../content/_how-to-filter-by-non-existing-field-nodejs.mdx | 4 ++-- .../content/_how-to-filter-by-non-existing-field-php.mdx | 2 +- .../content/_how-to-filter-by-non-existing-field-python.mdx | 2 +- .../content/_how-to-perform-queries-lazily-csharp.mdx | 2 +- .../content/_how-to-perform-queries-lazily-nodejs.mdx | 2 +- .../querying/content/_how-to-perform-queries-lazily-php.mdx | 2 +- .../content/_how-to-perform-queries-lazily-python.mdx | 2 +- .../querying/content/_how-to-work-with-suggestions-csharp.mdx | 2 +- .../querying/content/_how-to-work-with-suggestions-nodejs.mdx | 2 +- .../querying/content/_how-to-work-with-suggestions-php.mdx | 2 +- .../querying/content/_how-to-work-with-suggestions-python.mdx | 2 +- .../version-7.0/start/containers/requirements/security.mdx | 2 +- .../start/guides/cloudflare-workers/existing-project.mdx | 2 +- .../start/installation/setup-wizard/provide-license-key.mdx | 4 ++-- 24 files changed, 30 insertions(+), 30 deletions(-) diff --git a/versioned_docs/version-5.4/start/guides/cloudflare-workers/existing-project.mdx b/versioned_docs/version-5.4/start/guides/cloudflare-workers/existing-project.mdx index fe72a1d693..8cbef535d8 100644 --- a/versioned_docs/version-5.4/start/guides/cloudflare-workers/existing-project.mdx +++ b/versioned_docs/version-5.4/start/guides/cloudflare-workers/existing-project.mdx @@ -423,7 +423,7 @@ Navigate to your Worker **Settings > Variables > Environment Variables** a [docs-nodejs]: ../../../client-api/session/what-is-a-session-and-how-does-it-work [docs-what-is-document-store]: ../../../client-api/what-is-a-document-store [docs-create-db]: ../../../studio/database/create-new-database/general-flow -[docs-cloud-certs]: ../../../cloud/cloud-security +[docs-cloud-certs]: /cloud/cloud-security [docs-on-prem-certs]: ../../../studio/overview [docs-generate-client-certificate]: ../../../server/security/authentication/certificate-management#generate-client-certificate [npm-ravendb-client]: https://npmjs.com/package/ravendb diff --git a/versioned_docs/version-6.0/indexes/javascript-indexes.mdx b/versioned_docs/version-6.0/indexes/javascript-indexes.mdx index 19d98e5a8d..b49bee2fc1 100644 --- a/versioned_docs/version-6.0/indexes/javascript-indexes.mdx +++ b/versioned_docs/version-6.0/indexes/javascript-indexes.mdx @@ -29,7 +29,7 @@ see_also: source: "docs" path: "Indexes > Querying" - title: "Basics" - link: "indexes/querying/basics" + link: "indexes/querying/query-index" source: "docs" path: "Indexes > Querying" --- diff --git a/versioned_docs/version-6.0/start/guides/cloudflare-workers/existing-project.mdx b/versioned_docs/version-6.0/start/guides/cloudflare-workers/existing-project.mdx index fe72a1d693..8cbef535d8 100644 --- a/versioned_docs/version-6.0/start/guides/cloudflare-workers/existing-project.mdx +++ b/versioned_docs/version-6.0/start/guides/cloudflare-workers/existing-project.mdx @@ -423,7 +423,7 @@ Navigate to your Worker **Settings > Variables > Environment Variables** a [docs-nodejs]: ../../../client-api/session/what-is-a-session-and-how-does-it-work [docs-what-is-document-store]: ../../../client-api/what-is-a-document-store [docs-create-db]: ../../../studio/database/create-new-database/general-flow -[docs-cloud-certs]: ../../../cloud/cloud-security +[docs-cloud-certs]: /cloud/cloud-security [docs-on-prem-certs]: ../../../studio/overview [docs-generate-client-certificate]: ../../../server/security/authentication/certificate-management#generate-client-certificate [npm-ravendb-client]: https://npmjs.com/package/ravendb diff --git a/versioned_docs/version-7.0/client-api/commands/documents/content/_get-csharp.mdx b/versioned_docs/version-7.0/client-api/commands/documents/content/_get-csharp.mdx index 07181a74c3..0ef4a8e33d 100644 --- a/versioned_docs/version-7.0/client-api/commands/documents/content/_get-csharp.mdx +++ b/versioned_docs/version-7.0/client-api/commands/documents/content/_get-csharp.mdx @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock'; * Use the low-level `GetDocumentsCommand` to retrieve documents from the database. -* To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../querying/overview.mdx). +* To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) diff --git a/versioned_docs/version-7.0/client-api/commands/documents/content/_get-nodejs.mdx b/versioned_docs/version-7.0/client-api/commands/documents/content/_get-nodejs.mdx index 1cfcddf3b4..b4664b65fd 100644 --- a/versioned_docs/version-7.0/client-api/commands/documents/content/_get-nodejs.mdx +++ b/versioned_docs/version-7.0/client-api/commands/documents/content/_get-nodejs.mdx @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock'; * Use the low-level `GetDocumentsCommand` to retrieve documents from the database. -* To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../querying/overview.mdx). +* To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-csharp.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-csharp.mdx index 0c7c15fa7a..6f72ff4b78 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-csharp.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-csharp.mdx @@ -5,7 +5,7 @@ import CodeBlock from '@theme/CodeBlock'; -* Use `Customize()` to set the following customization options on a specific [Query](../../../../querying/overview.mdx). +* Use `Customize()` to set the following customization options on a specific [Query](../../../../client-api/session/querying/how-to-query.mdx). Can be set for both **dynamic** and **index** queries. * Each such customization can also be implemented via the [DocumentQuery](../../../../client-api/session/querying/document-query/what-is-document-query.mdx) API. @@ -785,7 +785,7 @@ IDocumentQueryCustomization RandomOrdering(string seed); ## WaitForNonStaleResults * All queries in RavenDB provide results using an index, even when you don't specify one. - See detailed explanation in [Queries always provide results using an index](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). + See detailed explanation in [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). * Use `WaitForNonStaleResults` to instruct the query to wait for non-stale results from the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx index ea7a918c25..b0846bfd60 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx @@ -10,7 +10,7 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can be used for both a dynamic-query and an index-query. -* A [query](../../../../querying/overview.mdx) can also be customized on the Store or Session level by subscribing to the `beforeQuery` event. +* A [query](../../../../client-api/session/querying/how-to-query.mdx) can also be customized on the Store or Session level by subscribing to the `beforeQuery` event. Learn more in [Subscribing to Events](../../../../client-api/session/how-to/subscribe-to-events.mdx). * Customization methods available: @@ -451,7 +451,7 @@ const results = await session.query(\{ collection: "Products" \}) ## waitForNonStaleResults * All queries in RavenDB provide results using an index, even when you don't specify one. - See detailed explanation in [Queries always provide results using an index](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). + See detailed explanation in [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). * Use `waitForNonStaleResults` to instruct the query to wait for non-stale results from the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-php.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-php.mdx index cf702e2348..05e3077616 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-php.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-php.mdx @@ -5,7 +5,7 @@ import CodeBlock from '@theme/CodeBlock'; -* Use the below methods to set customization options on a specific [query](../../../../querying/overview.mdx). +* Use the below methods to set customization options on a specific [query](../../../../client-api/session/querying/how-to-query.mdx). Customizations can be set for both **dynamic** and **index** queries. * A query can also be customized on the store or session level by @@ -287,7 +287,7 @@ public function randomOrdering(?string $seed): DocumentQueryCustomizationInterfa ## `waitForNonStaleResults` * All queries in RavenDB provide results using an index, even when you don't specify one. - See detailed explanation in [Queries always provide results using an index](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). + See detailed explanation in [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). * Use `waitForNonStaleResults` to instruct the query to wait for non-stale results from the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-python.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-python.mdx index 7959649976..59971c84cd 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-python.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-customize-query-python.mdx @@ -5,7 +5,7 @@ import CodeBlock from '@theme/CodeBlock'; -* Use the below customization methods over a specific [query](../../../../querying/overview.mdx). +* Use the below customization methods over a specific [query](../../../../client-api/session/querying/how-to-query.mdx). * The customization methods can be set for both **dynamic** and **index** queries. @@ -530,7 +530,7 @@ results = list( ## `wait_for_non_stale_results` * All RavenDB queries provide results using an index, even when an index is not specified. - See detailed explanation in [Queries always provide results using an index](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). + See detailed explanation in [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). * If `wait_for_non_stale_results` is used, the query will wait for non-stale results from the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx index 63410fc77f..7b2fbf3277 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx @@ -22,7 +22,7 @@ use the `Not` and `WhereExists` extension methods, accessible from the [Document as shown below. This will either create a new auto-index or add the queried field to an existing auto-index. -Learn more about the dynamic query flow [here](../../../../querying/overview.mdx#dynamicquery). +Learn more about the dynamic query flow [here](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery). **Example** diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx index a9258b4950..19d3be38ef 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; ## Query the collection (dynamic query) To run a dynamic query over a collection and find which documents are missing a specified field, -use the `not` and `whereExists` extension methods, accessible from the [query](../../../../querying/overview.mdx) API, +use the `not` and `whereExists` extension methods, accessible from the [query](../../../../client-api/session/querying/how-to-query.mdx) API, as shown below. This will either create a new auto-index or add the queried field to an existing auto-index. -Learn more about the dynamic query flow [here](../../../../querying/overview.mdx#dynamicquery). +Learn more about the dynamic query flow [here](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery). **Example** diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx index 46cff8037d..d9232aad1e 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx @@ -21,7 +21,7 @@ use the `not` and `whereExists` extension methods, accessible from the [document as shown below. This will either create a new auto-index or add the queried field to an existing auto-index. -Learn more about the dynamic query flow [here](../../../../querying/overview.mdx#dynamicquery). +Learn more about the dynamic query flow [here](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery). **Example** diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx index ef08535260..e0978388fe 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx @@ -22,7 +22,7 @@ use the `not_` and `where_exists` methods, accessible from the [document_query]( API, as demonstrated below. This will either create a new auto-index or add the queried field to an existing auto-index. -Learn more about the dynamic query flow [here](../../../../querying/overview.mdx#dynamicquery). +Learn more about the dynamic query flow [here](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery). **Example** diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx index d09504cfcb..4fdf7472f7 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx @@ -65,7 +65,7 @@ IEnumerable employees = lazyEmployees.Value; // DocumentQuery is execu -* Learn more about queries in this [query overview](../../../../querying/overview.mdx). +* Learn more about queries in this [query overview](../../../../client-api/session/querying/how-to-query.mdx). diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx index 12c83d4003..652167ed64 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx @@ -37,7 +37,7 @@ const employees = await lazyEmployees.getValue(); // Query is executed here -* Learn more about queries in this [query overview](../../../../querying/overview.mdx). +* Learn more about queries in this [query overview](../../../../client-api/session/querying/how-to-query.mdx). diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx index 05e564c598..8531414868 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about RavenDB's lazy behavior and other request types that can be executed lazily within a session. -* Learn more about queries in this [query overview](../../../../querying/overview.mdx). +* Learn more about queries in this [query overview](../../../../client-api/session/querying/how-to-query.mdx). * In this page: * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx index d88061c808..d667aab40e 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; ## Lazy query -To run a [regular query](../../../../querying/overview.mdx) +To run a [regular query](../../../../client-api/session/querying/how-to-query.mdx) (not a [suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx) query or a [faceted search](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx)) lazily, use `.lazily()` as follows. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx index 376c694350..70cc313fd6 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx @@ -29,7 +29,7 @@ import CodeBlock from '@theme/CodeBlock'; ## What are terms -* All queries in RavenDB use an index - learn more about that [here](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). +* All queries in RavenDB use an index - learn more about that [here](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). Whether making a dynamic query which generates an auto-index or using a static index, the data from your documents is 'broken' into **terms** that are kept in the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx index 7e4d4478d1..ba55785cca 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx @@ -29,7 +29,7 @@ import CodeBlock from '@theme/CodeBlock'; ## What are terms -* All queries in RavenDB use an index - learn more about that [here](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). +* All queries in RavenDB use an index - learn more about that [here](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). Whether making a dynamic query which generates an auto-index or using a static index, the data from your documents is 'broken' into **terms** that are kept in the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx index d57e71dcb4..8b7100a036 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx @@ -27,7 +27,7 @@ import CodeBlock from '@theme/CodeBlock'; ## What are terms -* All queries in RavenDB use an index - learn more about that [here](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). +* All queries in RavenDB use an index - learn more about that [here](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). Whether making a dynamic query which generates an auto-index or using a static index, the data from your documents is 'broken' into **terms** that are kept in the index. diff --git a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx index 1fda5df34c..9d6ed237b1 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx @@ -29,7 +29,7 @@ import CodeBlock from '@theme/CodeBlock'; ## What are terms -* All queries in RavenDB use an index - learn more about that [here](../../../../querying/overview.mdx#queries-always-provide-results-using-an-index). +* All queries in RavenDB use an index - learn more about that [here](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). Whether making a dynamic query which generates an auto-index or using a static index, the data from your documents is 'broken' into **terms** that are kept in the index. diff --git a/versioned_docs/version-7.0/start/containers/requirements/security.mdx b/versioned_docs/version-7.0/start/containers/requirements/security.mdx index b67f4d6dfe..2e96f6aea0 100644 --- a/versioned_docs/version-7.0/start/containers/requirements/security.mdx +++ b/versioned_docs/version-7.0/start/containers/requirements/security.mdx @@ -25,7 +25,7 @@ This documentation page will describe the crucial aspects of using certificates ## Getting the certificate #### Setup Wizard You can use the `Setup.Mode: Initial` configuration option to run the Setup Wizard if you need it. It can generate the LetsEncrypt certificate for you, create a setup package for your other nodes, and more. -Check what it's fully capable of here: [Setup Wizard Docs](../../installation/setup-wizard.mdx) +Check what it's fully capable of here: [Setup Wizard Docs](../../installation/setup-wizard/overview.mdx) Setup Wizard will be a no-go for you in some containerized or orchestrated setups because of the quirks of containerized (stateless) or declarative world. Fortunately, RavenDB is aware of that and provides many different ways to handle it, like certificate management script injection, to cover your case. diff --git a/versioned_docs/version-7.0/start/guides/cloudflare-workers/existing-project.mdx b/versioned_docs/version-7.0/start/guides/cloudflare-workers/existing-project.mdx index fe72a1d693..8cbef535d8 100644 --- a/versioned_docs/version-7.0/start/guides/cloudflare-workers/existing-project.mdx +++ b/versioned_docs/version-7.0/start/guides/cloudflare-workers/existing-project.mdx @@ -423,7 +423,7 @@ Navigate to your Worker **Settings > Variables > Environment Variables** a [docs-nodejs]: ../../../client-api/session/what-is-a-session-and-how-does-it-work [docs-what-is-document-store]: ../../../client-api/what-is-a-document-store [docs-create-db]: ../../../studio/database/create-new-database/general-flow -[docs-cloud-certs]: ../../../cloud/cloud-security +[docs-cloud-certs]: /cloud/cloud-security [docs-on-prem-certs]: ../../../studio/overview [docs-generate-client-certificate]: ../../../server/security/authentication/certificate-management#generate-client-certificate [npm-ravendb-client]: https://npmjs.com/package/ravendb diff --git a/versioned_docs/version-7.0/start/installation/setup-wizard/provide-license-key.mdx b/versioned_docs/version-7.0/start/installation/setup-wizard/provide-license-key.mdx index 3d3a118865..2e0450f99d 100644 --- a/versioned_docs/version-7.0/start/installation/setup-wizard/provide-license-key.mdx +++ b/versioned_docs/version-7.0/start/installation/setup-wizard/provide-license-key.mdx @@ -24,7 +24,7 @@ import Panel from '@site/src/components/Panel'; * The license grants legal permission to use RavenDB in production, unlocks features based on license type (AGPL features only without a license), defines cluster and hardware limits, and enables support, updates, and SLA. - Learn more about licensing in [Licensing overview](../../../licensing/overview.mdx). + Learn more about licensing in [Licensing overview](../../../start/licensing/licensing-overview.mdx). * In this article: * [Enter license key](../../../start/installation/setup-wizard/provide-license-key.mdx#enter-license-key) @@ -54,7 +54,7 @@ import Panel from '@site/src/components/Panel'; ![Get free license](./assets/license-2.png) -1. Use the toggle to choose whether to obtain a free [Developer](../../../licensing/overview.mdx#developer-license) or [Community](../../../licensing/overview.mdx#community-license) license. +1. Use the toggle to choose whether to obtain a free [Developer](../../../start/licensing/licensing-overview.mdx#developer-license) or [Community](../../../start/licensing/licensing-overview.mdx#community-license) license. 2. Enter your details in the form. From a87785ddcd060232cdec81ee2aef56197245c6ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 14:21:09 +0200 Subject: [PATCH 04/16] RDoc-3724 - Fix broken test-driver (embedded casing) and backup-overview (general-info) links in 4.x-5.x --- .../version-4.1/start/content/_test-driver-csharp.mdx | 2 +- versioned_docs/version-4.1/start/test-driver.mdx | 2 +- .../version-4.2/start/content/_test-driver-csharp.mdx | 4 ++-- versioned_docs/version-4.2/start/test-driver.mdx | 2 +- .../version-5.0/start/content/_test-driver-csharp.mdx | 4 ++-- versioned_docs/version-5.0/start/test-driver.mdx | 2 +- .../version-5.1/server/ongoing-tasks/backup-overview.mdx | 2 +- .../version-5.1/start/content/_test-driver-csharp.mdx | 4 ++-- versioned_docs/version-5.1/start/test-driver.mdx | 2 +- .../version-5.2/server/ongoing-tasks/backup-overview.mdx | 2 +- .../version-5.2/start/content/_test-driver-csharp.mdx | 4 ++-- versioned_docs/version-5.2/start/test-driver.mdx | 2 +- .../version-5.3/server/ongoing-tasks/backup-overview.mdx | 2 +- .../version-5.3/start/content/_test-driver-csharp.mdx | 4 ++-- versioned_docs/version-5.3/start/test-driver.mdx | 2 +- .../version-5.4/server/ongoing-tasks/backup-overview.mdx | 2 +- .../version-5.4/start/content/_test-driver-csharp.mdx | 2 +- 17 files changed, 22 insertions(+), 22 deletions(-) diff --git a/versioned_docs/version-4.1/start/content/_test-driver-csharp.mdx b/versioned_docs/version-4.1/start/content/_test-driver-csharp.mdx index 7aededf2c9..6d0d812252 100644 --- a/versioned_docs/version-4.1/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-4.1/start/content/_test-driver-csharp.mdx @@ -106,7 +106,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b -`TestServerOptions` inherits from [ServerOptions](../../server/Embedded.mdx#getting-started). In that way you can be more in control of how the embedded server is going to run +`TestServerOptions` inherits from [ServerOptions](../../server/embedded.mdx#getting-started). In that way you can be more in control of how the embedded server is going to run with just a minor change. Here you can change your ServerDirectory. diff --git a/versioned_docs/version-4.1/start/test-driver.mdx b/versioned_docs/version-4.1/start/test-driver.mdx index 0815a2c7cb..e62d81feb1 100644 --- a/versioned_docs/version-4.1/start/test-driver.mdx +++ b/versioned_docs/version-4.1/start/test-driver.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 supported_languages: ["csharp", "java"] see_also: - title: "Running an Embedded Instance" - link: "server/Embedded" + link: "server/embedded" source: "docs" path: "Server" --- diff --git a/versioned_docs/version-4.2/start/content/_test-driver-csharp.mdx b/versioned_docs/version-4.2/start/content/_test-driver-csharp.mdx index 0a5e4e38d4..26bea6edf1 100644 --- a/versioned_docs/version-4.2/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-4.2/start/content/_test-driver-csharp.mdx @@ -132,8 +132,8 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). -* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/Embedded.mdx#getting-started). -* It's important to be sure that the correct [.NET FrameworkVersion](../../server/Embedded.mdx#net-frameworkversion) is set. +* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#getting-started). +* It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. diff --git a/versioned_docs/version-4.2/start/test-driver.mdx b/versioned_docs/version-4.2/start/test-driver.mdx index 7cf625893f..187053e814 100644 --- a/versioned_docs/version-4.2/start/test-driver.mdx +++ b/versioned_docs/version-4.2/start/test-driver.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 supported_languages: ["csharp", "java"] see_also: - title: "Running an Embedded Instance" - link: "server/Embedded" + link: "server/embedded" source: "docs" path: "Server" - title: "Running an Embedded Instance" diff --git a/versioned_docs/version-5.0/start/content/_test-driver-csharp.mdx b/versioned_docs/version-5.0/start/content/_test-driver-csharp.mdx index 0a5e4e38d4..26bea6edf1 100644 --- a/versioned_docs/version-5.0/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-5.0/start/content/_test-driver-csharp.mdx @@ -132,8 +132,8 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). -* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/Embedded.mdx#getting-started). -* It's important to be sure that the correct [.NET FrameworkVersion](../../server/Embedded.mdx#net-frameworkversion) is set. +* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#getting-started). +* It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. diff --git a/versioned_docs/version-5.0/start/test-driver.mdx b/versioned_docs/version-5.0/start/test-driver.mdx index 7cf625893f..187053e814 100644 --- a/versioned_docs/version-5.0/start/test-driver.mdx +++ b/versioned_docs/version-5.0/start/test-driver.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 supported_languages: ["csharp", "java"] see_also: - title: "Running an Embedded Instance" - link: "server/Embedded" + link: "server/embedded" source: "docs" path: "Server" - title: "Running an Embedded Instance" diff --git a/versioned_docs/version-5.1/server/ongoing-tasks/backup-overview.mdx b/versioned_docs/version-5.1/server/ongoing-tasks/backup-overview.mdx index b769bd4d16..cb2a2632d4 100644 --- a/versioned_docs/version-5.1/server/ongoing-tasks/backup-overview.mdx +++ b/versioned_docs/version-5.1/server/ongoing-tasks/backup-overview.mdx @@ -84,7 +84,7 @@ Backed-up data includes both database-level and cluster-level contents, as detai | [Compare-exchange values](../../client-api/operations/compare-exchange/overview.mdx) | ✔ | ✔ | | [Identities](../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) | ✔ | ✔ | | [Indexes](../../indexes/creating-and-deploying.mdx) | Index definitions are saved and used to rebuild indexes during database restoration | ✔ | -| [Ongoing Tasks configuration](../../../server/ongoing-tasks/general-info.mdx) | ✔ | ✔ | +| [Ongoing Tasks configuration](../../studio/database/tasks/ongoing-tasks/general-info.mdx) | ✔ | ✔ | | [Subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) | ✔ | ✔ | diff --git a/versioned_docs/version-5.1/start/content/_test-driver-csharp.mdx b/versioned_docs/version-5.1/start/content/_test-driver-csharp.mdx index 0a5e4e38d4..26bea6edf1 100644 --- a/versioned_docs/version-5.1/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-5.1/start/content/_test-driver-csharp.mdx @@ -132,8 +132,8 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). -* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/Embedded.mdx#getting-started). -* It's important to be sure that the correct [.NET FrameworkVersion](../../server/Embedded.mdx#net-frameworkversion) is set. +* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#getting-started). +* It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. diff --git a/versioned_docs/version-5.1/start/test-driver.mdx b/versioned_docs/version-5.1/start/test-driver.mdx index 7cf625893f..187053e814 100644 --- a/versioned_docs/version-5.1/start/test-driver.mdx +++ b/versioned_docs/version-5.1/start/test-driver.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 supported_languages: ["csharp", "java"] see_also: - title: "Running an Embedded Instance" - link: "server/Embedded" + link: "server/embedded" source: "docs" path: "Server" - title: "Running an Embedded Instance" diff --git a/versioned_docs/version-5.2/server/ongoing-tasks/backup-overview.mdx b/versioned_docs/version-5.2/server/ongoing-tasks/backup-overview.mdx index b769bd4d16..cb2a2632d4 100644 --- a/versioned_docs/version-5.2/server/ongoing-tasks/backup-overview.mdx +++ b/versioned_docs/version-5.2/server/ongoing-tasks/backup-overview.mdx @@ -84,7 +84,7 @@ Backed-up data includes both database-level and cluster-level contents, as detai | [Compare-exchange values](../../client-api/operations/compare-exchange/overview.mdx) | ✔ | ✔ | | [Identities](../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) | ✔ | ✔ | | [Indexes](../../indexes/creating-and-deploying.mdx) | Index definitions are saved and used to rebuild indexes during database restoration | ✔ | -| [Ongoing Tasks configuration](../../../server/ongoing-tasks/general-info.mdx) | ✔ | ✔ | +| [Ongoing Tasks configuration](../../studio/database/tasks/ongoing-tasks/general-info.mdx) | ✔ | ✔ | | [Subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) | ✔ | ✔ | diff --git a/versioned_docs/version-5.2/start/content/_test-driver-csharp.mdx b/versioned_docs/version-5.2/start/content/_test-driver-csharp.mdx index 0a5e4e38d4..26bea6edf1 100644 --- a/versioned_docs/version-5.2/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-5.2/start/content/_test-driver-csharp.mdx @@ -132,8 +132,8 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). -* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/Embedded.mdx#getting-started). -* It's important to be sure that the correct [.NET FrameworkVersion](../../server/Embedded.mdx#net-frameworkversion) is set. +* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#getting-started). +* It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. diff --git a/versioned_docs/version-5.2/start/test-driver.mdx b/versioned_docs/version-5.2/start/test-driver.mdx index 7cf625893f..187053e814 100644 --- a/versioned_docs/version-5.2/start/test-driver.mdx +++ b/versioned_docs/version-5.2/start/test-driver.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 supported_languages: ["csharp", "java"] see_also: - title: "Running an Embedded Instance" - link: "server/Embedded" + link: "server/embedded" source: "docs" path: "Server" - title: "Running an Embedded Instance" diff --git a/versioned_docs/version-5.3/server/ongoing-tasks/backup-overview.mdx b/versioned_docs/version-5.3/server/ongoing-tasks/backup-overview.mdx index b769bd4d16..cb2a2632d4 100644 --- a/versioned_docs/version-5.3/server/ongoing-tasks/backup-overview.mdx +++ b/versioned_docs/version-5.3/server/ongoing-tasks/backup-overview.mdx @@ -84,7 +84,7 @@ Backed-up data includes both database-level and cluster-level contents, as detai | [Compare-exchange values](../../client-api/operations/compare-exchange/overview.mdx) | ✔ | ✔ | | [Identities](../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) | ✔ | ✔ | | [Indexes](../../indexes/creating-and-deploying.mdx) | Index definitions are saved and used to rebuild indexes during database restoration | ✔ | -| [Ongoing Tasks configuration](../../../server/ongoing-tasks/general-info.mdx) | ✔ | ✔ | +| [Ongoing Tasks configuration](../../studio/database/tasks/ongoing-tasks/general-info.mdx) | ✔ | ✔ | | [Subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) | ✔ | ✔ | diff --git a/versioned_docs/version-5.3/start/content/_test-driver-csharp.mdx b/versioned_docs/version-5.3/start/content/_test-driver-csharp.mdx index 0a5e4e38d4..26bea6edf1 100644 --- a/versioned_docs/version-5.3/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-5.3/start/content/_test-driver-csharp.mdx @@ -132,8 +132,8 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). -* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/Embedded.mdx#getting-started). -* It's important to be sure that the correct [.NET FrameworkVersion](../../server/Embedded.mdx#net-frameworkversion) is set. +* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#getting-started). +* It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. diff --git a/versioned_docs/version-5.3/start/test-driver.mdx b/versioned_docs/version-5.3/start/test-driver.mdx index 7cf625893f..187053e814 100644 --- a/versioned_docs/version-5.3/start/test-driver.mdx +++ b/versioned_docs/version-5.3/start/test-driver.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 supported_languages: ["csharp", "java"] see_also: - title: "Running an Embedded Instance" - link: "server/Embedded" + link: "server/embedded" source: "docs" path: "Server" - title: "Running an Embedded Instance" diff --git a/versioned_docs/version-5.4/server/ongoing-tasks/backup-overview.mdx b/versioned_docs/version-5.4/server/ongoing-tasks/backup-overview.mdx index b769bd4d16..cb2a2632d4 100644 --- a/versioned_docs/version-5.4/server/ongoing-tasks/backup-overview.mdx +++ b/versioned_docs/version-5.4/server/ongoing-tasks/backup-overview.mdx @@ -84,7 +84,7 @@ Backed-up data includes both database-level and cluster-level contents, as detai | [Compare-exchange values](../../client-api/operations/compare-exchange/overview.mdx) | ✔ | ✔ | | [Identities](../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) | ✔ | ✔ | | [Indexes](../../indexes/creating-and-deploying.mdx) | Index definitions are saved and used to rebuild indexes during database restoration | ✔ | -| [Ongoing Tasks configuration](../../../server/ongoing-tasks/general-info.mdx) | ✔ | ✔ | +| [Ongoing Tasks configuration](../../studio/database/tasks/ongoing-tasks/general-info.mdx) | ✔ | ✔ | | [Subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) | ✔ | ✔ | diff --git a/versioned_docs/version-5.4/start/content/_test-driver-csharp.mdx b/versioned_docs/version-5.4/start/content/_test-driver-csharp.mdx index b1b3ef189f..ecbc28a52a 100644 --- a/versioned_docs/version-5.4/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-5.4/start/content/_test-driver-csharp.mdx @@ -177,7 +177,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). -* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/Embedded.mdx#serveroptions). +* To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#serveroptions). * It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. From dd255b02cbea4a9aaaa80043882b50e1ff023668 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 14:31:23 +0200 Subject: [PATCH 05/16] RDoc-3724 - Fix over-relative (../) links in 3.0 whats-new and 3.5 streaming-files --- versioned_docs/version-3.0/whats-new.mdx | 84 +++++++++---------- .../client-api/session/streaming-files.mdx | 2 +- 2 files changed, 43 insertions(+), 43 deletions(-) diff --git a/versioned_docs/version-3.0/whats-new.mdx b/versioned_docs/version-3.0/whats-new.mdx index 00d86776c9..7a16d25427 100644 --- a/versioned_docs/version-3.0/whats-new.mdx +++ b/versioned_docs/version-3.0/whats-new.mdx @@ -512,12 +512,12 @@ This is an aggregated build containing fixes released in hotfix versions since t - Properly dispose of timer instance when shutting down a database using expiration bundle, - Prevent an error loading ICSharpCode.NRefactory from killing RavenDB client startup -#### [Configuration](../server/configuration/configuration-options) +#### [Configuration](server/configuration/configuration-options) -- Increased `Raven/Voron/MaxScratchBufferSize` from 1024 to 6144. More [here](../server/configuration/configuration-options#voron-settings), -- Added `Raven/Voron/ScratchBufferSizeNotificationThreshold`. More [here](../server/configuration/configuration-options#voron-settings), -- Added `Raven/MaxClauseCount`. More [here](../server/configuration/configuration-options#index-settings), -- Added `Raven/Indexing/DisableIndexingFreeSpaceThreshold`. More [here](../server/configuration/configuration-options#index-settings) +- Increased `Raven/Voron/MaxScratchBufferSize` from 1024 to 6144. More [here](server/configuration/configuration-options#voron-settings), +- Added `Raven/Voron/ScratchBufferSizeNotificationThreshold`. More [here](server/configuration/configuration-options#voron-settings), +- Added `Raven/MaxClauseCount`. More [here](server/configuration/configuration-options#index-settings), +- Added `Raven/Indexing/DisableIndexingFreeSpaceThreshold`. More [here](server/configuration/configuration-options#index-settings) ### File systems @@ -532,22 +532,22 @@ This is an aggregated build containing fixes released in hotfix versions since t ### Client API -- Added `AbstractScriptedIndexCreationTask`. More [here](../server/bundles/scripted-index-results#example-ii---abstractscriptedindexcreationtask), -- Added `SetTransformerLock` command. More [here](../client-api/commands/transformers/how-to/change-transformer-lock-mode), -- Added `PutIndexes` command. More [here](../client-api/commands/indexes/put#putindexes), +- Added `AbstractScriptedIndexCreationTask`. More [here](server/bundles/scripted-index-results#example-ii---abstractscriptedindexcreationtask), +- Added `SetTransformerLock` command. More [here](client-api/commands/transformers/how-to/change-transformer-lock-mode), +- Added `PutIndexes` command. More [here](client-api/commands/indexes/put#putindexes), - Added `Include(Expression> path)` to async session, - Implemented `GetMetadataForAsync(T instance)` in advanced options of async session of `ShardedDocumentStore`, -- `WithinRadiusOf` marked as obsolete in spatial querying because of the parameter order inconsistency. `WithinRadius` is designated to be used instead. More [here](../indexes/querying/spatial), -- Added `StartEtag` to `SubscriptionCriteria`. More [here](../client-api/data-subscriptions/how-to-create-data-subscription), -- Added opening strategies to data subscriptions. More [here](../client-api/data-subscriptions/how-to-open-data-subscription), -- Added `BeforeAcknowledgment` and `AfterAcknowledgment` events to data subscription. More [here](../client-api/data-subscriptions/events), -- Added "Query parsing" measure for `ShowTimings` query customization. More [here](../client-api/session/querying/how-to-customize-query#showtimings), -- Added `TransformerLockMode`. More [here](../client-api/commands/transformers/how-to/change-transformer-lock-mode), -- Added `Load` overload with transformer to `ILoaderWithInclude`. More [here](../client-api/session/loading-entities#example-iii-1), +- `WithinRadiusOf` marked as obsolete in spatial querying because of the parameter order inconsistency. `WithinRadius` is designated to be used instead. More [here](indexes/querying/spatial), +- Added `StartEtag` to `SubscriptionCriteria`. More [here](client-api/data-subscriptions/how-to-create-data-subscription), +- Added opening strategies to data subscriptions. More [here](client-api/data-subscriptions/how-to-open-data-subscription), +- Added `BeforeAcknowledgment` and `AfterAcknowledgment` events to data subscription. More [here](client-api/data-subscriptions/events), +- Added "Query parsing" measure for `ShowTimings` query customization. More [here](client-api/session/querying/how-to-customize-query#showtimings), +- Added `TransformerLockMode`. More [here](client-api/commands/transformers/how-to/change-transformer-lock-mode), +- Added `Load` overload with transformer to `ILoaderWithInclude`. More [here](client-api/session/loading-entities#example-iii-1), - `IndexCreation.CreateIndexes` creates indexes in a single request, - `DocumentStore.SideBySideExecuteIndexes` and `DocumentStore.SideBySideExecuteIndexesAsync` creates side by side indexes in a single request, - Implemented bulk inserts for `ShardedDocumentStore`, -- Optimized memory allocation and better performance in [profiling](../client-api/how-to/enable-profiling), +- Optimized memory allocation and better performance in [profiling](client-api/how-to/enable-profiling), - Fixed implementations of sync methods to avoid hangs, - Fixed caching of `HttpClient`, - Extended IEnumerable implementation of `DynamicList` - more available extensions in an index definition @@ -556,10 +556,10 @@ This is an aggregated build containing fixes released in hotfix versions since t ### Studio -- Environment based studio themes. More [here](../studio/management/studio-config), +- Environment based studio themes. More [here](studio/management/studio-config), - Added `Status -> Debug -> Currently indexing`, -- Added IO Test. More [here](../studio/management/io-test), -- Added License server information. More [here](../studio/management/license-information), +- Added IO Test. More [here](studio/management/io-test), +- Added License server information. More [here](studio/management/license-information), - Fixed authentication by API keys, - Fixed inconsistency bug in Query intellisense, - Exposed option StoreAllFields (Edit index view), @@ -586,16 +586,16 @@ This is an aggregated build containing fixes released in hotfix versions since t ### Server -- `[JavaScript]` Added `IncreaseNumberOfAllowedStepsBy` method. More [here](../client-api/commands/patches/how-to-use-javascript-to-patch-your-documents#methods-objects-and-variables), +- `[JavaScript]` Added `IncreaseNumberOfAllowedStepsBy` method. More [here](client-api/commands/patches/how-to-use-javascript-to-patch-your-documents#methods-objects-and-variables), - `[JavaScript]` Debug information now contains number of steps that script took, - `[Voron]` Less aggresive disk space allocation, - Various performance improvements -#### [Configuration](../server/configuration/configuration-options) +#### [Configuration](server/configuration/configuration-options) -- Added `Raven/AllowScriptsToAdjustNumberOfSteps`. More [here](../server/configuration/configuration-options#javascript-parser), -- Added `Raven/Voron/AllowOn32Bits`. More [here](../server/configuration/configuration-options#voron-settings), -- Added `Raven/PreventSchemaUpdate`. More [here](../server/configuration/configuration-options#data-settings). +- Added `Raven/AllowScriptsToAdjustNumberOfSteps`. More [here](server/configuration/configuration-options#javascript-parser), +- Added `Raven/Voron/AllowOn32Bits`. More [here](server/configuration/configuration-options#voron-settings), +- Added `Raven/PreventSchemaUpdate`. More [here](server/configuration/configuration-options#data-settings). #### Bundles @@ -646,17 +646,17 @@ This is an aggregated build containing fixes released in hotfix versions since t - Recognize Windows users with admin rights to system database as server admins, - Facets can now have very large number of facets -#### [Configuration](../server/configuration/configuration-options) +#### [Configuration](server/configuration/configuration-options) -- Added `Raven/WorkingDir`. More [here](../server/configuration/configuration-options#data-settings), -- Added `Raven/AdditionalStepsForScriptBasedOnDocumentSize` (5 by default). More [here](../server/configuration/configuration-options#javascript-parser), -- Added `Raven/MaxServicePointIdleTime`. More [here](../server/configuration/configuration-options#http-settings), -- Added `Raven/ImplicitFetchFieldsFromDocumentMode`. More [here](../server/configuration/configuration-options#index-settings), -- Added `Raven/Replication/ForceReplicationRequestBuffering`. More [here](../server/configuration/configuration-options#replication) +- Added `Raven/WorkingDir`. More [here](server/configuration/configuration-options#data-settings), +- Added `Raven/AdditionalStepsForScriptBasedOnDocumentSize` (5 by default). More [here](server/configuration/configuration-options#javascript-parser), +- Added `Raven/MaxServicePointIdleTime`. More [here](server/configuration/configuration-options#http-settings), +- Added `Raven/ImplicitFetchFieldsFromDocumentMode`. More [here](server/configuration/configuration-options#index-settings), +- Added `Raven/Replication/ForceReplicationRequestBuffering`. More [here](server/configuration/configuration-options#replication) #### Indexes -- [`AbstractIndexCreationTask`](../indexes/creating-and-deploying#using-abstractindexcreationtask) will add sorting to numerical fields automatically +- [`AbstractIndexCreationTask`](indexes/creating-and-deploying#using-abstractindexcreationtask) will add sorting to numerical fields automatically #### Bundles @@ -671,8 +671,8 @@ This is an aggregated build containing fixes released in hotfix versions since t - Indexes can be deployed side-by-side using `SideBySideExecute` from `AbstractIndexCreationTask`, `SideBySideCreateIndexes` from `IndexCreation` and directly from `DocumentStore` using `SideBySideExecuteIndex`, - Added the ability to provide additional query to MoreLikeThis queries, -- Added `SetIndexLock` to `IDatabaseCommands`. More [here](../client-api/commands/indexes/how-to/change-index-lock-mode), -- Added `SetIndexPriority` to `IDatabaseCommands`. More [here](../client-api/commands/indexes/how-to/change-index-priority), +- Added `SetIndexLock` to `IDatabaseCommands`. More [here](client-api/commands/indexes/how-to/change-index-lock-mode), +- Added `SetIndexPriority` to `IDatabaseCommands`. More [here](client-api/commands/indexes/how-to/change-index-priority), - Index priority can be set through `IndexPriority` property in `IndexDefinition` or `Priority` property in `AbstractIndexCreationTask`,
@@ -712,13 +712,13 @@ This is an aggregated build containing fixes released in hotfix versions since t ### Server -- preventing, by default, unrestricted access (`Raven/AnonymousAccess` set to `Admin`) to server when license is used. More [here](../server/configuration/license-registration), +- preventing, by default, unrestricted access (`Raven/AnonymousAccess` set to `Admin`) to server when license is used. More [here](server/configuration/license-registration), - `[Voron]` added compaction, - added Data Subscriptions, - added _admin/low-memory-notification_ endpoint, - performance improvements -#### [Configuration](../server/configuration/configuration-options) +#### [Configuration](server/configuration/configuration-options) - added `Raven/Indexing/MaxNumberOfItemsToProcessInTestIndexes`, - added `Raven/Licensing/AllowAdminAnonymousAccessForCommercialUse`, @@ -734,9 +734,9 @@ This is an aggregated build containing fixes released in hotfix versions since t #### Indexes -- test indexes. More [here](../indexes/testing-indexes), -- side-by-side indexes. More [here](../indexes/side-by-side-indexes), -- added safe number parsing methods. More [here](../indexes/indexing-linq-extensions#parsing-numbers), +- test indexes. More [here](indexes/testing-indexes), +- side-by-side indexes. More [here](indexes/side-by-side-indexes), +- added safe number parsing methods. More [here](indexes/indexing-linq-extensions#parsing-numbers), - added the ability to replicate index and transformer definitions. #### Bundles @@ -748,10 +748,10 @@ This is an aggregated build containing fixes released in hotfix versions since t ### Client API -- added `PreserveDocumentPropertiesNotFoundOnModel` convention. More [here](../client-api/configuration/conventions/request-handling#preservedocumentpropertiesnotfoundonmodel), -- **highlights** can be accessed when performing **projection** or querying **map-reduce** index. More [here](../indexes/querying/highlights#highlights--projections), -- added `IndexAndTransformerReplicationMode` convention that indicates if index and transformer definitions should be replicated when they are created using `AbstractIndexCreationTask` or `AbstractTransformerCreationTask`. More [here](../client-api/configuration/conventions/misc#indexandtransformerreplicationmode), -- added [Data Subscriptions](../client-api/data-subscriptions/what-are-data-subscriptions). +- added `PreserveDocumentPropertiesNotFoundOnModel` convention. More [here](client-api/configuration/conventions/request-handling#preservedocumentpropertiesnotfoundonmodel), +- **highlights** can be accessed when performing **projection** or querying **map-reduce** index. More [here](indexes/querying/highlights#highlights--projections), +- added `IndexAndTransformerReplicationMode` convention that indicates if index and transformer definitions should be replicated when they are created using `AbstractIndexCreationTask` or `AbstractTransformerCreationTask`. More [here](client-api/configuration/conventions/misc#indexandtransformerreplicationmode), +- added [Data Subscriptions](client-api/data-subscriptions/what-are-data-subscriptions).
diff --git a/versioned_docs/version-3.5/file-system/client-api/session/streaming-files.mdx b/versioned_docs/version-3.5/file-system/client-api/session/streaming-files.mdx index f3fcd63e87..339ca40910 100644 --- a/versioned_docs/version-3.5/file-system/client-api/session/streaming-files.mdx +++ b/versioned_docs/version-3.5/file-system/client-api/session/streaming-files.mdx @@ -33,7 +33,7 @@ File Header can be streamed With **StreamFileHeadersAsync** method from Advanced | Return Value | | | ------------- | ------------- | -| **Task<IAsyncEnumerator<FileHeader>>** | A task that represents the asynchronous operation. The task result is the enumerator of [`FileHeaders`](../../../../../../glossary/file-header.mdx) objects. | +| **Task<IAsyncEnumerator<FileHeader>>** | A task that represents the asynchronous operation. The task result is the enumerator of [`FileHeaders`](../../../glossary/file-header.mdx) objects. | ## Example From 086b162adb2f17b19a43da4193d0924560a94403 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 14:36:48 +0200 Subject: [PATCH 06/16] RDoc-3724 - Remove dead 'Querying' see_also entries in 6.0 (page doesn't exist; matches maintained versions) --- .../version-6.0/client-api/configuration/conventions.mdx | 4 ---- .../version-6.0/client-api/configuration/deserialization.mdx | 4 ---- .../configuration/load-balance/load-balance-behavior.mdx | 4 ---- .../configuration/load-balance/read-balance-behavior.mdx | 4 ---- .../version-6.0/client-api/configuration/serialization.mdx | 4 ---- .../client-api/session/querying/how-to-customize-query.mdx | 4 ---- 6 files changed, 24 deletions(-) diff --git a/versioned_docs/version-6.0/client-api/configuration/conventions.mdx b/versioned_docs/version-6.0/client-api/configuration/conventions.mdx index 7d5f2423ae..5ee478d24d 100644 --- a/versioned_docs/version-6.0/client-api/configuration/conventions.mdx +++ b/versioned_docs/version-6.0/client-api/configuration/conventions.mdx @@ -4,10 +4,6 @@ sidebar_label: Conventions sidebar_position: 0 supported_languages: ["csharp", "nodejs"] see_also: - - title: "Querying" - link: "client-api/configuration/querying" - source: "docs" - path: "Client API > Configuration" - title: "Serialization" link: "client-api/configuration/serialization" source: "docs" diff --git a/versioned_docs/version-6.0/client-api/configuration/deserialization.mdx b/versioned_docs/version-6.0/client-api/configuration/deserialization.mdx index d19d36d40d..64041661d1 100644 --- a/versioned_docs/version-6.0/client-api/configuration/deserialization.mdx +++ b/versioned_docs/version-6.0/client-api/configuration/deserialization.mdx @@ -8,10 +8,6 @@ see_also: link: "client-api/configuration/conventions" source: "docs" path: "Client API > Configuration" - - title: "Querying" - link: "client-api/configuration/querying" - source: "docs" - path: "Client API > Configuration" - title: "Load Balance & Failover" link: "client-api/configuration/load-balance/overview" source: "docs" diff --git a/versioned_docs/version-6.0/client-api/configuration/load-balance/load-balance-behavior.mdx b/versioned_docs/version-6.0/client-api/configuration/load-balance/load-balance-behavior.mdx index ececaf3d7a..4e6ffe88c8 100644 --- a/versioned_docs/version-6.0/client-api/configuration/load-balance/load-balance-behavior.mdx +++ b/versioned_docs/version-6.0/client-api/configuration/load-balance/load-balance-behavior.mdx @@ -20,10 +20,6 @@ see_also: link: "client-api/configuration/conventions" source: "docs" path: "Client API > Configuration" - - title: "Querying" - link: "client-api/configuration/querying" - source: "docs" - path: "Client API > Configuration" - title: "Requests Configuration in Studio" link: "studio/server/client-configuration" source: "docs" diff --git a/versioned_docs/version-6.0/client-api/configuration/load-balance/read-balance-behavior.mdx b/versioned_docs/version-6.0/client-api/configuration/load-balance/read-balance-behavior.mdx index bd94b7a9b6..93e37a1054 100644 --- a/versioned_docs/version-6.0/client-api/configuration/load-balance/read-balance-behavior.mdx +++ b/versioned_docs/version-6.0/client-api/configuration/load-balance/read-balance-behavior.mdx @@ -20,10 +20,6 @@ see_also: link: "client-api/configuration/conventions" source: "docs" path: "Client API > Configuration" - - title: "Querying" - link: "client-api/configuration/querying" - source: "docs" - path: "Client API > Configuration" - title: "Requests Configuration in Studio" link: "studio/server/client-configuration" source: "docs" diff --git a/versioned_docs/version-6.0/client-api/configuration/serialization.mdx b/versioned_docs/version-6.0/client-api/configuration/serialization.mdx index 1a45383aec..15c8eff831 100644 --- a/versioned_docs/version-6.0/client-api/configuration/serialization.mdx +++ b/versioned_docs/version-6.0/client-api/configuration/serialization.mdx @@ -8,10 +8,6 @@ see_also: link: "client-api/configuration/conventions" source: "docs" path: "Client API > Configuration" - - title: "Querying" - link: "client-api/configuration/querying" - source: "docs" - path: "Client API > Configuration" - title: "Load Balance & Failover" link: "client-api/configuration/load-balance/overview" source: "docs" diff --git a/versioned_docs/version-6.0/client-api/session/querying/how-to-customize-query.mdx b/versioned_docs/version-6.0/client-api/session/querying/how-to-customize-query.mdx index fb96f4b315..9e3ec8a978 100644 --- a/versioned_docs/version-6.0/client-api/session/querying/how-to-customize-query.mdx +++ b/versioned_docs/version-6.0/client-api/session/querying/how-to-customize-query.mdx @@ -20,10 +20,6 @@ see_also: link: "client-api/configuration/conventions" source: "docs" path: "Client API > Configuration" - - title: "Querying" - link: "client-api/configuration/querying" - source: "docs" - path: "Client API > Configuration" - title: "Stale Indexes" link: "indexes/stale-indexes" source: "docs" From 6148454104bc748de5ae2dd9c729b6f5fe4add83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 14:44:49 +0200 Subject: [PATCH 07/16] RDoc-3724 - Fix counters/revisions/metadata cross-links in 5.x-6.0 (csharp-prefix, revert-revisions, indexing-metadata) --- .../counters/content/_overview-csharp.mdx | 2 +- .../counters/content/_overview-csharp.mdx | 2 +- .../counters/content/_overview-csharp.mdx | 2 +- .../counters/content/_overview-csharp.mdx | 2 +- .../counters/content/_overview-nodejs.mdx | 2 +- .../counters/content/_overview-python.mdx | 2 +- .../revisions/content/_overview-csharp.mdx | 2 +- .../revisions/content/_overview-nodejs.mdx | 2 +- .../revisions/content/_overview-python.mdx | 2 +- .../revisions/content/_revisions-and-other-features-php.mdx | 6 +++--- .../content/_revisions-and-other-features-python.mdx | 6 +++--- .../session/how-to/get-and-modify-entity-metadata.mdx | 4 ++-- .../content/_revisions-and-other-features-csharp.mdx | 6 +++--- 13 files changed, 20 insertions(+), 20 deletions(-) diff --git a/versioned_docs/version-5.0/document-extensions/counters/content/_overview-csharp.mdx b/versioned_docs/version-5.0/document-extensions/counters/content/_overview-csharp.mdx index 028f668640..e6a1f9e373 100644 --- a/versioned_docs/version-5.0/document-extensions/counters/content/_overview-csharp.mdx +++ b/versioned_docs/version-5.0/document-extensions/counters/content/_overview-csharp.mdx @@ -12,7 +12,7 @@ import CodeBlock from '@theme/CodeBlock'; * Any event related to the document * Counters interact with and can trigger other RavenDB features. - To find out how to use counters with other features, read [Counters and Other Features](../../../../csharp/document-extensions/counters/counters-and-other-features.mdx). + To find out how to use counters with other features, read [Counters and Other Features](../../../document-extensions/counters/counters-and-other-features.mdx). * Create and manage Counters using API methods, or through the [Studio](../../../studio/database/document-extensions/counters.mdx). diff --git a/versioned_docs/version-5.1/document-extensions/counters/content/_overview-csharp.mdx b/versioned_docs/version-5.1/document-extensions/counters/content/_overview-csharp.mdx index 028f668640..e6a1f9e373 100644 --- a/versioned_docs/version-5.1/document-extensions/counters/content/_overview-csharp.mdx +++ b/versioned_docs/version-5.1/document-extensions/counters/content/_overview-csharp.mdx @@ -12,7 +12,7 @@ import CodeBlock from '@theme/CodeBlock'; * Any event related to the document * Counters interact with and can trigger other RavenDB features. - To find out how to use counters with other features, read [Counters and Other Features](../../../../csharp/document-extensions/counters/counters-and-other-features.mdx). + To find out how to use counters with other features, read [Counters and Other Features](../../../document-extensions/counters/counters-and-other-features.mdx). * Create and manage Counters using API methods, or through the [Studio](../../../studio/database/document-extensions/counters.mdx). diff --git a/versioned_docs/version-5.2/document-extensions/counters/content/_overview-csharp.mdx b/versioned_docs/version-5.2/document-extensions/counters/content/_overview-csharp.mdx index 028f668640..e6a1f9e373 100644 --- a/versioned_docs/version-5.2/document-extensions/counters/content/_overview-csharp.mdx +++ b/versioned_docs/version-5.2/document-extensions/counters/content/_overview-csharp.mdx @@ -12,7 +12,7 @@ import CodeBlock from '@theme/CodeBlock'; * Any event related to the document * Counters interact with and can trigger other RavenDB features. - To find out how to use counters with other features, read [Counters and Other Features](../../../../csharp/document-extensions/counters/counters-and-other-features.mdx). + To find out how to use counters with other features, read [Counters and Other Features](../../../document-extensions/counters/counters-and-other-features.mdx). * Create and manage Counters using API methods, or through the [Studio](../../../studio/database/document-extensions/counters.mdx). diff --git a/versioned_docs/version-5.3/document-extensions/counters/content/_overview-csharp.mdx b/versioned_docs/version-5.3/document-extensions/counters/content/_overview-csharp.mdx index 028f668640..e6a1f9e373 100644 --- a/versioned_docs/version-5.3/document-extensions/counters/content/_overview-csharp.mdx +++ b/versioned_docs/version-5.3/document-extensions/counters/content/_overview-csharp.mdx @@ -12,7 +12,7 @@ import CodeBlock from '@theme/CodeBlock'; * Any event related to the document * Counters interact with and can trigger other RavenDB features. - To find out how to use counters with other features, read [Counters and Other Features](../../../../csharp/document-extensions/counters/counters-and-other-features.mdx). + To find out how to use counters with other features, read [Counters and Other Features](../../../document-extensions/counters/counters-and-other-features.mdx). * Create and manage Counters using API methods, or through the [Studio](../../../studio/database/document-extensions/counters.mdx). diff --git a/versioned_docs/version-5.4/document-extensions/counters/content/_overview-nodejs.mdx b/versioned_docs/version-5.4/document-extensions/counters/content/_overview-nodejs.mdx index f633e067de..55125a4171 100644 --- a/versioned_docs/version-5.4/document-extensions/counters/content/_overview-nodejs.mdx +++ b/versioned_docs/version-5.4/document-extensions/counters/content/_overview-nodejs.mdx @@ -12,7 +12,7 @@ import CodeBlock from '@theme/CodeBlock'; * Any event related to the document * Counters interact with and can trigger other RavenDB features. - To find out how to use counters with other features, read [Counters and Other Features](../../../../csharp/document-extensions/counters/counters-and-other-features.mdx). + To find out how to use counters with other features, read [Counters and Other Features](../../../document-extensions/counters/counters-and-other-features.mdx). * Create and manage Counters using API methods, or through the [Studio](../../../studio/database/document-extensions/counters.mdx). diff --git a/versioned_docs/version-5.4/document-extensions/counters/content/_overview-python.mdx b/versioned_docs/version-5.4/document-extensions/counters/content/_overview-python.mdx index 2bf7394aa2..b4ee656dbd 100644 --- a/versioned_docs/version-5.4/document-extensions/counters/content/_overview-python.mdx +++ b/versioned_docs/version-5.4/document-extensions/counters/content/_overview-python.mdx @@ -12,7 +12,7 @@ import CodeBlock from '@theme/CodeBlock'; * Any event related to the document * Counters interact with and can trigger other RavenDB features. - To find out how to use counters with other features, read [Counters and Other Features](../../../../csharp/document-extensions/counters/counters-and-other-features.mdx). + To find out how to use counters with other features, read [Counters and Other Features](../../../document-extensions/counters/counters-and-other-features.mdx). * Create and manage Counters using API methods, or through the [Studio](../../../studio/database/document-extensions/counters.mdx). diff --git a/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-csharp.mdx b/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-csharp.mdx index 1e1e8553cf..9535f147e7 100644 --- a/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-csharp.mdx +++ b/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-csharp.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Document Revisions** are snapshots of documents and their extensions: * The trail of revisions created for a document can be inspected to track changes made in the document over time. - * A document's live version can be [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to any of its recorded revisions. + * A document's live version can be [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to any of its recorded revisions. For example, tracking document revisions allows you to check how an employee's contract has changed over time, restore a single corrupted document without requiring a backup file, or conduct a full-scale audit of your data. diff --git a/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-nodejs.mdx b/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-nodejs.mdx index 5a5f757a5d..d4eb5ec923 100644 --- a/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-nodejs.mdx +++ b/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-nodejs.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Document Revisions** are snapshots of documents and their extensions: * The trail of revisions created for a document can be inspected to track changes made in the document over time. - * A document's live version can be [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to any of its recorded revisions. + * A document's live version can be [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to any of its recorded revisions. For example, tracking document revisions allows you to check how an employee's contract has changed over time, restore a single corrupted document without requiring a backup file, or conduct a full-scale audit of your data. diff --git a/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-python.mdx b/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-python.mdx index 5d0011ebe2..b0ca250b05 100644 --- a/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-python.mdx +++ b/versioned_docs/version-5.4/document-extensions/revisions/content/_overview-python.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Document Revisions** are snapshots of documents and their extensions: * The trail of revisions created for a document can be inspected to track changes made in the document over time. - * A document's live version can be [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to any of its recorded revisions. + * A document's live version can be [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to any of its recorded revisions. For example, tracking document revisions allows you to check how an employee's contract has changed over time, restore a single corrupted document without requiring a backup file, or conduct a full-scale audit of your data. diff --git a/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-php.mdx b/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-php.mdx index b1874fdfd3..1d933be1db 100644 --- a/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-php.mdx +++ b/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-php.mdx @@ -56,7 +56,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Reverted data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has counters, +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has counters, the counters from the revision are restored to functionality along with their values. @@ -110,7 +110,7 @@ the counters from the revision are restored to functionality along with their va ### Reverted Data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has a time series: +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has a time series: * If the current document **contains** a time series name as in the revision: * The reverted document will keep the time series entries & values as it was in the current document. @@ -169,7 +169,7 @@ A document revision will be created when: ### Reverted Data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has attachments, +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has attachments, the attachments are restored to their state when the revision was created. diff --git a/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-python.mdx b/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-python.mdx index c7701ce3e3..8f2173671c 100644 --- a/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-python.mdx +++ b/versioned_docs/version-5.4/document-extensions/revisions/content/_revisions-and-other-features-python.mdx @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Reverted data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has counters, +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has counters, the counters from the revision are restored to functionality along with their values. @@ -111,7 +111,7 @@ the counters from the revision are restored to functionality along with their va ### Reverted Data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has a time series: +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has a time series: * If the current document **contains** a time series name as in the revision: * The reverted document will keep the time series entries & values as it was in the current document. @@ -170,7 +170,7 @@ A document revision will be created when: ### Reverted Data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has attachments, +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has attachments, the attachments are restored to their state when the revision was created. diff --git a/versioned_docs/version-6.0/client-api/session/how-to/get-and-modify-entity-metadata.mdx b/versioned_docs/version-6.0/client-api/session/how-to/get-and-modify-entity-metadata.mdx index 7a4954de86..931e184033 100644 --- a/versioned_docs/version-6.0/client-api/session/how-to/get-and-modify-entity-metadata.mdx +++ b/versioned_docs/version-6.0/client-api/session/how-to/get-and-modify-entity-metadata.mdx @@ -16,8 +16,8 @@ see_also: link: "client-api/session/how-to/get-entity-last-modified" source: "docs" path: "Client API > Session > How to..." - - title: "Converting to JSON and Accessing Metadata" - link: "indexes/converting-to-json-and-accessing-metadata" + - title: "Indexing Metadata" + link: "indexes/indexing-metadata" source: "docs" path: "Indexes" --- diff --git a/versioned_docs/version-6.0/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx b/versioned_docs/version-6.0/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx index bb06b071bf..167d228132 100644 --- a/versioned_docs/version-6.0/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx +++ b/versioned_docs/version-6.0/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Reverted data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has counters, +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has counters, the counters from the revision are restored to functionality along with their values. ### Extract counters data from revisions: @@ -150,7 +150,7 @@ List countersDataInRevisions = revisionsMetadata ### Reverted Data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has a time series: +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has a time series: * If the current document **contains** a time series name as in the revision: * The reverted document will keep the time series entries & values as it was in the current document. @@ -209,7 +209,7 @@ A document revision will be created when: ### Reverted Data: -When a document is [reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx) to a revision that has attachments, +When a document is [reverted](../../../document-extensions/revisions/revert-revisions.mdx) to a revision that has attachments, the attachments are restored to their state when the revision was created. From 42ca87ffb7b3be0e83082a0dd3535256a7d315a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 14:49:40 +0200 Subject: [PATCH 08/16] RDoc-3724 - Fix document-view links in 4.1/4.2 (renamed to document-view-overview + depth) --- .../studio/database/documents/create-new-document.mdx | 2 +- .../documents/document-view/document-view-overview.mdx | 4 ++-- .../studio/database/documents/documents-and-collections.mdx | 2 +- .../studio/database/documents/create-new-document.mdx | 2 +- .../documents/document-view/document-view-overview.mdx | 4 ++-- .../studio/database/documents/documents-and-collections.mdx | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/versioned_docs/version-4.1/studio/database/documents/create-new-document.mdx b/versioned_docs/version-4.1/studio/database/documents/create-new-document.mdx index af62e641f0..ac1340bbc9 100644 --- a/versioned_docs/version-4.1/studio/database/documents/create-new-document.mdx +++ b/versioned_docs/version-4.1/studio/database/documents/create-new-document.mdx @@ -87,7 +87,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Create New Document from Clone - * A new document can be created by cloning (creating a copy without attachments) from an opened [document view](../../../../studio/database/documents/document-view/document-view.mdx) + * A new document can be created by cloning (creating a copy without attachments) from an opened [document view](../../../studio/database/documents/document-view/document-view-overview.mdx) * The clone can be saved with a new ID diff --git a/versioned_docs/version-4.1/studio/database/documents/document-view/document-view-overview.mdx b/versioned_docs/version-4.1/studio/database/documents/document-view/document-view-overview.mdx index d82c2ff7e7..2b0ced7d3d 100644 --- a/versioned_docs/version-4.1/studio/database/documents/document-view/document-view-overview.mdx +++ b/versioned_docs/version-4.1/studio/database/documents/document-view/document-view-overview.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions such as cloning the document, deleting, adding attachments, and much more can be performed. * In this page: - * [Document View](../../../../../studio/database/documents/document-view/document-view.mdx#the-document-view) - * [Documents View - Actions](../../../../../studio/database/documents/document-view/document-view.mdx#document-view---actions) + * [Document View](../../../../studio/database/documents/document-view/document-view-overview.mdx#the-document-view) + * [Documents View - Actions](../../../../studio/database/documents/document-view/document-view-overview.mdx#document-view---actions) ## The Document View diff --git a/versioned_docs/version-4.1/studio/database/documents/documents-and-collections.mdx b/versioned_docs/version-4.1/studio/database/documents/documents-and-collections.mdx index 6a207ae67e..05180e53b1 100644 --- a/versioned_docs/version-4.1/studio/database/documents/documents-and-collections.mdx +++ b/versioned_docs/version-4.1/studio/database/documents/documents-and-collections.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A document holds your data in a JSON format object -* For more information about documents, see [Document View](../../../../studio/database/documents/document-view/document-view.mdx) +* For more information about documents, see [Document View](../../../studio/database/documents/document-view/document-view-overview.mdx) diff --git a/versioned_docs/version-4.2/studio/database/documents/create-new-document.mdx b/versioned_docs/version-4.2/studio/database/documents/create-new-document.mdx index af62e641f0..ac1340bbc9 100644 --- a/versioned_docs/version-4.2/studio/database/documents/create-new-document.mdx +++ b/versioned_docs/version-4.2/studio/database/documents/create-new-document.mdx @@ -87,7 +87,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Create New Document from Clone - * A new document can be created by cloning (creating a copy without attachments) from an opened [document view](../../../../studio/database/documents/document-view/document-view.mdx) + * A new document can be created by cloning (creating a copy without attachments) from an opened [document view](../../../studio/database/documents/document-view/document-view-overview.mdx) * The clone can be saved with a new ID diff --git a/versioned_docs/version-4.2/studio/database/documents/document-view/document-view-overview.mdx b/versioned_docs/version-4.2/studio/database/documents/document-view/document-view-overview.mdx index d82c2ff7e7..2b0ced7d3d 100644 --- a/versioned_docs/version-4.2/studio/database/documents/document-view/document-view-overview.mdx +++ b/versioned_docs/version-4.2/studio/database/documents/document-view/document-view-overview.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions such as cloning the document, deleting, adding attachments, and much more can be performed. * In this page: - * [Document View](../../../../../studio/database/documents/document-view/document-view.mdx#the-document-view) - * [Documents View - Actions](../../../../../studio/database/documents/document-view/document-view.mdx#document-view---actions) + * [Document View](../../../../studio/database/documents/document-view/document-view-overview.mdx#the-document-view) + * [Documents View - Actions](../../../../studio/database/documents/document-view/document-view-overview.mdx#document-view---actions) ## The Document View diff --git a/versioned_docs/version-4.2/studio/database/documents/documents-and-collections.mdx b/versioned_docs/version-4.2/studio/database/documents/documents-and-collections.mdx index 6a207ae67e..05180e53b1 100644 --- a/versioned_docs/version-4.2/studio/database/documents/documents-and-collections.mdx +++ b/versioned_docs/version-4.2/studio/database/documents/documents-and-collections.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A document holds your data in a JSON format object -* For more information about documents, see [Document View](../../../../studio/database/documents/document-view/document-view.mdx) +* For more information about documents, see [Document View](../../../studio/database/documents/document-view/document-view-overview.mdx) From e85ac507f0223ea77ee1493c574ae590b70e1426 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 15:14:46 +0200 Subject: [PATCH 09/16] RDoc-3724 Simplify self-referential internal links to bare anchors (docs, cloud, 7.1, 6.2) --- cloud/cloud-account.mdx | 4 +- cloud/cloud-aws-marketplace.mdx | 8 +- cloud/cloud-backup-and-restore.mdx | 20 +- cloud/cloud-instances.mdx | 32 ++-- cloud/cloud-microsoft-azure-marketplace.mdx | 10 +- cloud/cloud-overview.mdx | 40 ++-- cloud/cloud-pricing-payment-billing.mdx | 22 +-- cloud/cloud-scaling.mdx | 10 +- cloud/cloud-security.mdx | 2 +- cloud/cloud-settings.mdx | 4 +- cloud/cloud-support.mdx | 4 +- cloud/portal/cloud-portal-account-tab.mdx | 6 +- cloud/portal/cloud-portal-api-tab.mdx | 8 +- cloud/portal/cloud-portal-backups-tab.mdx | 2 +- cloud/portal/cloud-portal-billing-tab.mdx | 10 +- cloud/portal/cloud-portal-home-tab.mdx | 2 +- cloud/portal/cloud-portal-products-tab.mdx | 26 +-- cloud/portal/cloud-portal-support-tab.mdx | 8 +- cloud/portal/cloud-portal.mdx | 2 +- .../_reading-conversation-history-csharp.mdx | 46 ++--- .../_creating-ai-agents_api-csharp.mdx | 114 ++++++------ .../_creating-ai-agents_api-nodejs.mdx | 72 +++---- .../_creating-ai-agents_api-python.mdx | 60 +++--- .../creating-ai-agents_studio.mdx | 32 ++-- .../ai-integration/ai-agents/multi-agents.mdx | 42 ++--- docs/ai-integration/ai-agents/overview.mdx | 32 ++-- .../ai-agents/security-concerns.mdx | 14 +- docs/ai-integration/ai-tasks-list-view.mdx | 2 +- .../content/_azure-open-ai-csharp.mdx | 12 +- .../content/_azure-open-ai-nodejs.mdx | 12 +- .../content/_azure-open-ai-python.mdx | 12 +- .../content/_embedded-csharp.mdx | 6 +- .../content/_embedded-nodejs.mdx | 6 +- .../content/_embedded-python.mdx | 6 +- .../content/_google-ai-csharp.mdx | 12 +- .../content/_google-ai-nodejs.mdx | 12 +- .../content/_google-ai-python.mdx | 12 +- .../content/_hugging-face-csharp.mdx | 6 +- .../content/_hugging-face-nodejs.mdx | 6 +- .../content/_hugging-face-python.mdx | 6 +- .../content/_mistral-ai-csharp.mdx | 6 +- .../content/_mistral-ai-nodejs.mdx | 6 +- .../content/_mistral-ai-python.mdx | 6 +- .../content/_ollama-csharp.mdx | 12 +- .../content/_ollama-nodejs.mdx | 12 +- .../content/_ollama-python.mdx | 12 +- .../content/_open-ai-csharp.mdx | 12 +- .../content/_open-ai-nodejs.mdx | 12 +- .../content/_open-ai-python.mdx | 12 +- .../content/_vertex-ai-csharp.mdx | 6 +- .../content/_vertex-ai-nodejs.mdx | 6 +- .../content/_vertex-ai-python.mdx | 6 +- .../connection-strings/overview.mdx | 4 +- .../_create-gen-ai-task_api-csharp.mdx | 8 +- .../_create-gen-ai-task_api-nodejs.mdx | 10 +- .../_create-gen-ai-task_api-python.mdx | 8 +- .../create-gen-ai-task_studio.mdx | 30 +-- .../gen-ai-security-concerns.mdx | 2 +- .../_modify-gen-ai-task_api-csharp.mdx | 4 +- .../_modify-gen-ai-task_api-nodejs.mdx | 4 +- .../_modify-gen-ai-task_api-python.mdx | 4 +- .../gen-ai-integration/overview.mdx | 30 +-- .../_processing-attachments_api-csharp.mdx | 2 +- .../_processing-attachments_api-nodejs.mdx | 2 +- .../_processing-attachments_api-python.mdx | 2 +- .../processing-attachments_studio.mdx | 14 +- .../_embeddings-generation-task-csharp.mdx | 30 +-- .../_embeddings-generation-task-nodejs.mdx | 26 +-- .../_embeddings-generation-task-python.mdx | 26 +-- .../content/_overview-csharp.mdx | 12 +- .../content/_overview-nodejs.mdx | 12 +- .../content/_overview-python.mdx | 12 +- .../embedding-collections.mdx | 4 +- docs/ai-integration/start.mdx | 2 +- .../_data-types-for-vector-search-csharp.mdx | 10 +- .../_data-types-for-vector-search-nodejs.mdx | 10 +- ...g-attachments-for-vector-search-csharp.mdx | 14 +- ...g-attachments-for-vector-search-nodejs.mdx | 12 +- ...g-attachments-for-vector-search-python.mdx | 12 +- ...ctor-search-using-dynamic-query-csharp.mdx | 66 +++---- ...ctor-search-using-dynamic-query-nodejs.mdx | 66 +++---- ...ctor-search-using-dynamic-query-python.mdx | 66 +++---- ...ector-search-using-static-index-csharp.mdx | 56 +++--- ...ector-search-using-static-index-nodejs.mdx | 48 ++--- ...ector-search-using-static-index-python.mdx | 48 ++--- .../ai-integration/vector-search/overview.mdx | 10 +- .../what-affects-vector-search-results.mdx | 18 +- docs/backup/configuration.mdx | 20 +- docs/backup/create/one-time-backup.mdx | 28 +-- .../create/periodic-tasks/database-backup.mdx | 92 ++++----- .../periodic-tasks/server-wide-backup.mdx | 46 ++--- docs/backup/overview.mdx | 82 ++++---- docs/backup/restore.mdx | 32 ++-- ...work-with-bulk-insert-operation-csharp.mdx | 42 ++--- ...to-subscribe-to-counter-changes-csharp.mdx | 18 +- ...w-to-subscribe-to-counter-changes-java.mdx | 18 +- ...o-subscribe-to-document-changes-csharp.mdx | 18 +- ...-to-subscribe-to-document-changes-java.mdx | 18 +- ...o-subscribe-to-document-changes-nodejs.mdx | 18 +- ...w-to-subscribe-to-index-changes-csharp.mdx | 10 +- ...how-to-subscribe-to-index-changes-java.mdx | 10 +- ...w-to-subscribe-to-index-changes-nodejs.mdx | 10 +- ...-subscribe-to-operation-changes-csharp.mdx | 14 +- ...to-subscribe-to-operation-changes-java.mdx | 8 +- ...-subscribe-to-operation-changes-nodejs.mdx | 8 +- ...ubscribe-to-time-series-changes-csharp.mdx | 16 +- .../content/_what-is-changes-api-csharp.mdx | 18 +- .../content/_what-is-changes-api-java.mdx | 12 +- .../content/_what-is-changes-api-nodejs.mdx | 16 +- ...es-with-replication-and-cluster-csharp.mdx | 10 +- ...ates-with-replication-and-cluster-java.mdx | 10 +- ...es-with-replication-and-cluster-nodejs.mdx | 10 +- ...multiple-commands-using-a-batch-csharp.mdx | 6 +- ...multiple-commands-using-a-batch-nodejs.mdx | 6 +- .../commands/content/_overview-csharp.mdx | 12 +- .../commands/content/_overview-java.mdx | 6 +- .../commands/content/_overview-nodejs.mdx | 12 +- .../documents/content/_delete-csharp.mdx | 4 +- .../documents/content/_delete-nodejs.mdx | 4 +- .../documents/content/_delete-php.mdx | 4 +- .../documents/content/_delete-python.mdx | 4 +- .../documents/content/_get-csharp.mdx | 14 +- .../commands/documents/content/_get-java.mdx | 10 +- .../documents/content/_get-nodejs.mdx | 14 +- .../commands/documents/content/_get-php.mdx | 8 +- .../documents/content/_get-python.mdx | 8 +- .../documents/content/_put-csharp.mdx | 4 +- .../documents/content/_put-nodejs.mdx | 4 +- .../commands/documents/content/_put-php.mdx | 4 +- .../documents/content/_put-python.mdx | 4 +- .../content/_conventions-csharp.mdx | 126 ++++++------- .../content/_conventions-nodejs.mdx | 64 +++---- .../content/_deserialization-csharp.mdx | 10 +- .../content/_serialization-csharp.mdx | 10 +- .../content/_load-balance-behavior-csharp.mdx | 14 +- .../content/_load-balance-behavior-nodejs.mdx | 14 +- .../content/_load-balance-behavior-php.mdx | 14 +- .../content/_load-balance-behavior-python.mdx | 14 +- .../content/_read-balance-behavior-csharp.mdx | 14 +- .../content/_read-balance-behavior-nodejs.mdx | 14 +- .../content/_read-balance-behavior-php.mdx | 14 +- .../content/_read-balance-behavior-python.mdx | 14 +- .../configuration/load-balance/overview.mdx | 12 +- .../_creating-document-store-csharp.mdx | 8 +- ...uthentication-and-authorization-csharp.mdx | 2 +- .../_setting-up-default-database-csharp.mdx | 4 +- .../_maintenance-operations-csharp.mdx | 14 +- .../content/_maintenance-operations-java.mdx | 10 +- .../_maintenance-operations-nodejs.mdx | 16 +- .../_subscription-with-revisioning-csharp.mdx | 14 +- .../_subscription-with-revisioning-java.mdx | 6 +- .../_subscription-with-revisioning-nodejs.mdx | 12 +- .../content/_api-overview-csharp.mdx | 22 +-- .../content/_api-overview-java.mdx | 16 +- .../content/_api-overview-nodejs.mdx | 22 +-- .../content/_api-overview-python.mdx | 14 +- .../consumption/content/_examples-csharp.mdx | 18 +- .../consumption/content/_examples-java.mdx | 14 +- .../consumption/content/_examples-nodejs.mdx | 14 +- .../consumption/content/_examples-python.mdx | 16 +- ...ow-to-consume-data-subscription-csharp.mdx | 18 +- ..._how-to-consume-data-subscription-java.mdx | 8 +- ...ow-to-consume-data-subscription-nodejs.mdx | 18 +- ...ow-to-consume-data-subscription-python.mdx | 18 +- .../_concurrent-subscriptions-csharp.mdx | 8 +- .../_concurrent-subscriptions-nodejs.mdx | 8 +- .../_what-are-data-subscriptions-csharp.mdx | 14 +- .../_what-are-data-subscriptions-java.mdx | 14 +- .../_what-are-data-subscriptions-nodejs.mdx | 14 +- .../creation/content/_api-overview-csharp.mdx | 22 +-- .../creation/content/_api-overview-nodejs.mdx | 28 +-- .../creation/content/_api-overview-python.mdx | 12 +- .../creation/content/_examples-csharp.mdx | 24 +-- .../creation/content/_examples-nodejs.mdx | 24 +-- .../creation/content/_examples-python.mdx | 20 +- ...how-to-create-data-subscription-csharp.mdx | 6 +- .../_how-to-create-data-subscription-java.mdx | 6 +- ...how-to-create-data-subscription-nodejs.mdx | 6 +- ...how-to-create-data-subscription-python.mdx | 6 +- .../content/_hilo-algorithm-csharp.mdx | 26 +-- ...rking-with-document-identifiers-csharp.mdx | 18 +- .../client-api/faq/backward-compatibility.mdx | 16 +- docs/client-api/faq/transaction-support.mdx | 24 +-- docs/client-api/faq/what-is-a-collection.mdx | 4 +- .../_handle-document-relationships-csharp.mdx | 16 +- .../_handle-document-relationships-nodejs.mdx | 16 +- .../_setup-aggressive-caching-csharp.mdx | 38 ++-- .../_setup-aggressive-caching-java.mdx | 38 ++-- .../_setup-aggressive-caching-python.mdx | 36 ++-- .../how-to/integrate-with-excel.mdx | 2 +- .../how-to/subscribe-to-store-events.mdx | 24 +-- .../how-to/using-timeonly-and-dateonly.mdx | 14 +- .../content/_delete-by-query-csharp.mdx | 6 +- .../content/_delete-by-query-nodejs.mdx | 6 +- .../common/content/_delete-by-query-php.mdx | 6 +- .../content/_delete-by-query-python.mdx | 4 +- .../content/_what-are-operations-csharp.mdx | 24 +-- .../content/_what-are-operations-nodejs.mdx | 24 +-- .../content/_what-are-operations-php.mdx | 22 +-- .../content/_what-are-operations-python.mdx | 24 +-- ...-operations-to-a-different-node-csharp.mdx | 2 +- ...-operations-to-a-different-node-nodejs.mdx | 2 +- ...tch-operations-to-a-different-node-php.mdx | 2 +- .../_database-settings-operation-csharp.mdx | 4 +- .../_database-settings-operation-nodejs.mdx | 4 +- .../_database-settings-operation-php.mdx | 4 +- .../_get-client-configuration-csharp.mdx | 4 +- .../_get-client-configuration-nodejs.mdx | 4 +- .../content/_get-client-configuration-php.mdx | 4 +- .../_get-client-configuration-python.mdx | 4 +- .../_put-client-configuration-csharp.mdx | 8 +- .../_put-client-configuration-nodejs.mdx | 8 +- .../content/_put-client-configuration-php.mdx | 8 +- .../_put-client-configuration-python.mdx | 8 +- .../content/_add-connection-string-csharp.mdx | 18 +- .../content/_get-connection-string-csharp.mdx | 6 +- .../_remove-connection-string-csharp.mdx | 4 +- .../maintenance/content/_get-stats-csharp.mdx | 12 +- .../maintenance/content/_get-stats-java.mdx | 12 +- .../maintenance/content/_get-stats-nodejs.mdx | 12 +- .../maintenance/content/_get-stats-php.mdx | 12 +- .../maintenance/content/_get-stats-python.mdx | 12 +- .../etl/content/_add-etl-csharp.mdx | 20 +- .../maintenance/etl/content/_add-etl-java.mdx | 8 +- .../etl/content/_add-etl-nodejs.mdx | 8 +- .../content/_get-identities-csharp.mdx | 4 +- .../content/_get-identities-nodejs.mdx | 4 +- .../content/_get-identities-php.mdx | 4 +- .../content/_get-identities-python.mdx | 4 +- .../_increment-next-identity-csharp.mdx | 4 +- .../_increment-next-identity-nodejs.mdx | 4 +- .../content/_increment-next-identity-php.mdx | 4 +- .../_increment-next-identity-python.mdx | 4 +- .../content/_seed-identity-csharp.mdx | 6 +- .../content/_seed-identity-nodejs.mdx | 6 +- .../identities/content/_seed-identity-php.mdx | 6 +- .../content/_seed-identity-python.mdx | 6 +- .../indexes/content/_delete-index-csharp.mdx | 4 +- .../content/_delete-index-errors-csharp.mdx | 6 +- .../content/_delete-index-errors-nodejs.mdx | 6 +- .../content/_delete-index-errors-php.mdx | 6 +- .../content/_delete-index-errors-python.mdx | 6 +- .../indexes/content/_delete-index-nodejs.mdx | 4 +- .../indexes/content/_delete-index-php.mdx | 4 +- .../indexes/content/_delete-index-python.mdx | 4 +- .../indexes/content/_disable-index-csharp.mdx | 20 +- .../indexes/content/_disable-index-nodejs.mdx | 20 +- .../indexes/content/_disable-index-php.mdx | 20 +- .../indexes/content/_disable-index-python.mdx | 20 +- .../indexes/content/_enable-index-csharp.mdx | 10 +- .../indexes/content/_enable-index-nodejs.mdx | 10 +- .../indexes/content/_enable-index-php.mdx | 10 +- .../indexes/content/_enable-index-python.mdx | 10 +- .../indexes/content/_get-index-csharp.mdx | 4 +- .../content/_get-index-errors-csharp.mdx | 6 +- .../content/_get-index-errors-nodejs.mdx | 6 +- .../indexes/content/_get-index-errors-php.mdx | 6 +- .../content/_get-index-errors-python.mdx | 6 +- .../content/_get-index-names-csharp.mdx | 4 +- .../content/_get-index-names-nodejs.mdx | 4 +- .../indexes/content/_get-index-names-php.mdx | 2 +- .../content/_get-index-names-python.mdx | 4 +- .../indexes/content/_get-index-nodejs.mdx | 4 +- .../indexes/content/_get-index-php.mdx | 4 +- .../indexes/content/_get-index-python.mdx | 4 +- .../indexes/content/_get-indexes-csharp.mdx | 4 +- .../indexes/content/_get-indexes-nodejs.mdx | 4 +- .../indexes/content/_get-indexes-php.mdx | 4 +- .../indexes/content/_get-indexes-python.mdx | 4 +- .../indexes/content/_get-terms-csharp.mdx | 4 +- .../indexes/content/_get-terms-nodejs.mdx | 4 +- .../indexes/content/_get-terms-php.mdx | 4 +- .../indexes/content/_get-terms-python.mdx | 4 +- .../content/_index-has-changed-csharp.mdx | 4 +- .../content/_index-has-changed-nodejs.mdx | 4 +- .../content/_index-has-changed-php.mdx | 4 +- .../content/_index-has-changed-python.mdx | 4 +- .../indexes/content/_put-indexes-csharp.mdx | 8 +- .../indexes/content/_put-indexes-nodejs.mdx | 6 +- .../indexes/content/_put-indexes-php.mdx | 8 +- .../indexes/content/_put-indexes-python.mdx | 8 +- .../indexes/content/_reset-index-php.mdx | 4 +- .../content/_set-index-lock-csharp.mdx | 10 +- .../content/_set-index-lock-nodejs.mdx | 10 +- .../indexes/content/_set-index-lock-php.mdx | 10 +- .../content/_set-index-lock-python.mdx | 10 +- .../content/_set-index-priority-csharp.mdx | 8 +- .../content/_set-index-priority-nodejs.mdx | 8 +- .../content/_set-index-priority-php.mdx | 8 +- .../content/_set-index-priority-python.mdx | 8 +- .../indexes/content/_start-index-csharp.mdx | 4 +- .../indexes/content/_start-index-nodejs.mdx | 4 +- .../indexes/content/_start-index-php.mdx | 4 +- .../indexes/content/_start-index-python.mdx | 4 +- .../content/_start-indexing-csharp.mdx | 4 +- .../content/_start-indexing-nodejs.mdx | 4 +- .../indexes/content/_start-indexing-php.mdx | 4 +- .../content/_start-indexing-python.mdx | 4 +- .../indexes/content/_stop-index-csharp.mdx | 6 +- .../indexes/content/_stop-index-nodejs.mdx | 6 +- .../indexes/content/_stop-index-php.mdx | 6 +- .../indexes/content/_stop-index-python.mdx | 6 +- .../indexes/content/_stop-indexing-csharp.mdx | 6 +- .../indexes/content/_stop-indexing-nodejs.mdx | 6 +- .../indexes/content/_stop-indexing-php.mdx | 6 +- .../indexes/content/_stop-indexing-python.mdx | 6 +- .../_ongoing-task-operations-csharp.mdx | 8 +- .../patching/content/_set-based-csharp.mdx | 6 +- .../patching/content/_set-based-java.mdx | 6 +- .../patching/content/_set-based-nodejs.mdx | 32 ++-- .../content/_single-document-csharp.mdx | 64 +++---- .../content/_single-document-java.mdx | 6 +- .../content/_single-document-nodejs.mdx | 62 +++--- .../operations/patching/json-patch-syntax.mdx | 20 +- .../_put-client-certificate-csharp.mdx | 4 +- .../content/_put-client-certificate-java.mdx | 4 +- .../_put-client-certificate-nodejs.mdx | 4 +- ...serverwide-client-configuration-csharp.mdx | 2 +- ...serverwide-client-configuration-nodejs.mdx | 2 +- .../content/_add-database-node-csharp.mdx | 6 +- .../content/_add-database-node-nodejs.mdx | 6 +- .../content/_add-database-node-php.mdx | 6 +- .../content/_add-database-node-python.mdx | 6 +- .../content/_compact-database-csharp.mdx | 16 +- .../content/_compact-database-nodejs.mdx | 16 +- .../content/_compact-database-php.mdx | 16 +- .../content/_compact-database-python.mdx | 12 +- .../content/_create-database-csharp.mdx | 14 +- .../content/_create-database-java.mdx | 8 +- .../_toggle-databases-state-csharp.mdx | 8 +- .../_toggle-databases-state-nodejs.mdx | 8 +- .../content/_toggle-databases-state-php.mdx | 8 +- .../_toggle-databases-state-python.mdx | 8 +- .../_get-logs-configuration-csharp.mdx | 4 +- .../_set-logs-configuration-csharp.mdx | 8 +- .../document-commands/batch-commands.mdx | 72 +++---- .../document-commands/delete-document.mdx | 6 +- .../document-commands/get-all-documents.mdx | 20 +- .../document-commands/get-documents-by-id.mdx | 24 +-- .../get-documents-by-prefix.mdx | 28 +-- .../document-commands/put-documents.mdx | 8 +- .../rest-api/queries/delete-by-query.mdx | 6 +- .../rest-api/queries/patch-by-query.mdx | 6 +- .../rest-api/queries/query-the-database.mdx | 16 +- docs/client-api/rest-api/rest-api-intro.mdx | 8 +- .../_deserialization-security-csharp.mdx | 20 +- .../content/_overview-csharp.mdx | 4 +- .../content/_overview-nodejs.mdx | 4 +- .../content/_overview-php.mdx | 4 +- .../content/_overview-python.mdx | 4 +- .../_how-to-disable-tracking-csharp.mdx | 12 +- .../_how-to-disable-tracking-nodejs.mdx | 10 +- .../content/_how-to-disable-tracking-php.mdx | 8 +- .../_how-to-disable-tracking-python.mdx | 10 +- ...o-enable-optimistic-concurrency-csharp.mdx | 34 ++-- ...o-enable-optimistic-concurrency-nodejs.mdx | 4 +- ...w-to-enable-optimistic-concurrency-php.mdx | 4 +- ...o-enable-optimistic-concurrency-python.mdx | 4 +- .../content/_loading-entities-csharp.mdx | 14 +- .../content/_loading-entities-java.mdx | 14 +- .../content/_loading-entities-nodejs.mdx | 14 +- .../session/content/_loading-entities-php.mdx | 12 +- .../content/_loading-entities-python.mdx | 14 +- .../content/_opening-a-session-csharp.mdx | 8 +- .../content/_opening-a-session-nodejs.mdx | 8 +- .../content/_opening-a-session-php.mdx | 10 +- .../content/_opening-a-session-python.mdx | 8 +- .../content/_updating-entities-csharp.mdx | 4 +- .../content/_updating-entities-nodejs.mdx | 4 +- .../content/_updating-entities-php.mdx | 4 +- .../content/_updating-entities-python.mdx | 4 +- ...-a-session-and-how-does-it-work-csharp.mdx | 24 +-- ...is-a-session-and-how-does-it-work-java.mdx | 22 +-- ...-a-session-and-how-does-it-work-nodejs.mdx | 22 +-- ...-is-a-session-and-how-does-it-work-php.mdx | 22 +-- ...-a-session-and-how-does-it-work-python.mdx | 22 +-- .../_check-if-attachment-exists-csharp.mdx | 4 +- .../_check-if-attachment-exists-java.mdx | 4 +- .../_check-if-attachment-exists-nodejs.mdx | 4 +- .../_check-if-attachment-exists-php.mdx | 4 +- .../_check-if-attachment-exists-python.mdx | 4 +- .../_check-if-document-exists-csharp.mdx | 4 +- .../_check-if-document-exists-java.mdx | 4 +- .../_check-if-document-exists-nodejs.mdx | 4 +- .../content/_check-if-document-exists-php.mdx | 4 +- .../_check-if-document-exists-python.mdx | 4 +- .../_check-if-entity-has-changed-csharp.mdx | 6 +- .../_check-if-entity-has-changed-nodejs.mdx | 6 +- .../_check-if-entity-has-changed-php.mdx | 6 +- .../_check-if-entity-has-changed-python.mdx | 6 +- ...re-are-any-changes-on-a-session-csharp.mdx | 6 +- ...re-are-any-changes-on-a-session-nodejs.mdx | 6 +- ...there-are-any-changes-on-a-session-php.mdx | 6 +- ...re-are-any-changes-on-a-session-python.mdx | 6 +- .../content/_clear-a-session-csharp.mdx | 4 +- .../content/_clear-a-session-nodejs.mdx | 4 +- .../content/_defer-operations-csharp.mdx | 6 +- .../content/_defer-operations-nodejs.mdx | 6 +- .../how-to/content/_defer-operations-php.mdx | 6 +- .../content/_defer-operations-python.mdx | 6 +- .../_evict-entity-from-a-session-csharp.mdx | 10 +- .../_evict-entity-from-a-session-nodejs.mdx | 10 +- .../content/_get-entity-counters-csharp.mdx | 4 +- .../content/_get-entity-counters-nodejs.mdx | 4 +- .../content/_get-entity-counters-php.mdx | 4 +- .../content/_get-entity-counters-python.mdx | 4 +- .../content/_get-tracked-entities-csharp.mdx | 4 +- .../content/_get-tracked-entities-nodejs.mdx | 4 +- .../_perform-operations-lazily-csharp.mdx | 22 +-- .../_perform-operations-lazily-nodejs.mdx | 22 +-- .../_perform-operations-lazily-php.mdx | 22 +-- .../_perform-operations-lazily-python.mdx | 22 +-- .../content/_subscribe-to-events-csharp.mdx | 24 +-- .../content/_subscribe-to-events-java.mdx | 22 +-- .../content/_subscribe-to-events-nodejs.mdx | 22 +-- .../_how-to-count-query-results-csharp.mdx | 6 +- .../_how-to-count-query-results-nodejs.mdx | 4 +- .../_how-to-count-query-results-php.mdx | 4 +- .../_how-to-count-query-results-python.mdx | 4 +- .../_how-to-filter-by-field-csharp.mdx | 6 +- .../content/_how-to-filter-by-field-java.mdx | 4 +- .../_how-to-filter-by-field-nodejs.mdx | 6 +- .../content/_how-to-filter-by-field-php.mdx | 6 +- .../_how-to-filter-by-field-python.mdx | 6 +- ...to-filter-by-non-existing-field-csharp.mdx | 4 +- ...to-filter-by-non-existing-field-nodejs.mdx | 4 +- ...ow-to-filter-by-non-existing-field-php.mdx | 4 +- ...to-filter-by-non-existing-field-python.mdx | 4 +- .../_how-to-get-query-statistics-csharp.mdx | 4 +- .../_how-to-get-query-statistics-nodejs.mdx | 4 +- .../_how-to-get-query-statistics-php.mdx | 4 +- .../_how-to-get-query-statistics-python.mdx | 4 +- .../_how-to-make-a-spatial-query-csharp.mdx | 32 ++-- .../_how-to-make-a-spatial-query-java.mdx | 32 ++-- .../_how-to-make-a-spatial-query-nodejs.mdx | 22 +-- .../_how-to-make-a-spatial-query-python.mdx | 32 ++-- .../_how-to-perform-group-by-query-python.mdx | 18 +- .../_how-to-perform-queries-lazily-csharp.mdx | 10 +- .../_how-to-perform-queries-lazily-nodejs.mdx | 10 +- .../_how-to-perform-queries-lazily-php.mdx | 10 +- .../_how-to-perform-queries-lazily-python.mdx | 10 +- .../_how-to-project-query-results-csharp.mdx | 16 +- .../_how-to-project-query-results-java.mdx | 4 +- .../_how-to-project-query-results-nodejs.mdx | 14 +- .../_how-to-project-query-results-php.mdx | 12 +- .../_how-to-project-query-results-python.mdx | 16 +- .../_how-to-work-with-suggestions-csharp.mdx | 18 +- .../_how-to-work-with-suggestions-nodejs.mdx | 18 +- .../_how-to-work-with-suggestions-php.mdx | 14 +- .../_how-to-work-with-suggestions-python.mdx | 18 +- .../content/_include-explanations-csharp.mdx | 6 +- .../content/_include-explanations-nodejs.mdx | 6 +- .../content/_include-explanations-php.mdx | 6 +- .../content/_include-explanations-python.mdx | 6 +- .../content/_query-timings-csharp.mdx | 8 +- .../debugging/content/_query-timings-java.mdx | 8 +- .../content/_query-timings-nodejs.mdx | 8 +- .../debugging/content/_query-timings-php.mdx | 8 +- .../content/_query-timings-python.mdx | 8 +- .../content/_boost-search-results-csharp.mdx | 4 +- .../content/_boost-search-results-nodejs.mdx | 4 +- .../content/_boost-search-results-php.mdx | 4 +- .../content/_boost-search-results-python.mdx | 4 +- .../content/_ends-with-query-csharp.mdx | 4 +- .../content/_ends-with-query-nodejs.mdx | 6 +- .../content/_ends-with-query-php.mdx | 4 +- .../content/_ends-with-query-python.mdx | 4 +- .../content/_exact-match-query-csharp.mdx | 6 +- .../content/_exact-match-query-nodejs.mdx | 6 +- .../content/_exact-match-query-php.mdx | 6 +- .../content/_exact-match-query-python.mdx | 6 +- .../content/_full-text-search-csharp.mdx | 20 +- .../content/_full-text-search-nodejs.mdx | 12 +- .../content/_full-text-search-php.mdx | 20 +- .../content/_full-text-search-python.mdx | 20 +- .../content/_fuzzy-search-csharp.mdx | 4 +- .../content/_fuzzy-search-nodejs.mdx | 4 +- .../text-search/content/_fuzzy-search-php.mdx | 4 +- .../content/_fuzzy-search-python.mdx | 4 +- .../_highlight-query-results-csharp.mdx | 14 +- .../_highlight-query-results-nodejs.mdx | 14 +- .../content/_highlight-query-results-php.mdx | 14 +- .../_highlight-query-results-python.mdx | 14 +- .../content/_proximity-search-csharp.mdx | 8 +- .../content/_proximity-search-nodejs.mdx | 8 +- .../content/_proximity-search-php.mdx | 8 +- .../content/_proximity-search-python.mdx | 8 +- .../content/_starts-with-query-csharp.mdx | 4 +- .../content/_starts-with-query-nodejs.mdx | 6 +- .../content/_starts-with-query-php.mdx | 4 +- .../content/_starts-with-query-python.mdx | 4 +- .../content/_what-is-smuggler-csharp.mdx | 8 +- .../content/_what-is-smuggler-java.mdx | 8 +- .../content/_what-is-smuggler-nodejs.mdx | 8 +- docs/compare-exchange/configuration.mdx | 8 +- .../content/_atomic-guards-csharp.mdx | 12 +- .../content/_atomic-guards-nodejs.mdx | 12 +- .../content/_atomic-guards-php.mdx | 12 +- .../content/_atomic-guards-python.mdx | 12 +- .../_cmpxchg-in-dynamic-queries-csharp.mdx | 12 +- .../_cmpxchg-in-dynamic-queries-nodejs.mdx | 12 +- .../_cmpxchg-item-expiration-csharp.mdx | 6 +- .../_cmpxchg-item-expiration-nodejs.mdx | 6 +- .../content/_create-cmpxchg-items-csharp.mdx | 22 +-- .../content/_create-cmpxchg-items-java.mdx | 6 +- .../content/_create-cmpxchg-items-nodejs.mdx | 18 +- .../content/_create-cmpxchg-items-php.mdx | 6 +- .../content/_create-cmpxchg-items-python.mdx | 6 +- .../content/_delete-cmpxchg-items-csharp.mdx | 14 +- .../content/_delete-cmpxchg-items-java.mdx | 6 +- .../content/_delete-cmpxchg-items-nodejs.mdx | 14 +- .../content/_delete-cmpxchg-items-php.mdx | 10 +- .../content/_delete-cmpxchg-items-python.mdx | 10 +- .../content/_get-cmpxchg-item-csharp.mdx | 16 +- .../content/_get-cmpxchg-item-java.mdx | 8 +- .../content/_get-cmpxchg-item-nodejs.mdx | 16 +- .../content/_get-cmpxchg-item-php.mdx | 4 +- .../content/_get-cmpxchg-item-python.mdx | 4 +- .../content/_get-cmpxchg-items-csharp.mdx | 10 +- .../content/_get-cmpxchg-items-java.mdx | 6 +- .../content/_get-cmpxchg-items-nodejs.mdx | 10 +- .../content/_get-cmpxchg-items-php.mdx | 2 +- .../content/_get-cmpxchg-items-python.mdx | 2 +- ..._include-compare-exchange-items-csharp.mdx | 8 +- ..._include-compare-exchange-items-nodejs.mdx | 8 +- ...ndexing-compare-exchange-values-csharp.mdx | 10 +- ..._indexing-compare-exchange-values-java.mdx | 6 +- ...ndexing-compare-exchange-values-nodejs.mdx | 10 +- .../content/_overview-csharp.mdx | 18 +- .../content/_overview-java.mdx | 18 +- .../content/_overview-php.mdx | 16 +- .../content/_overview-python.mdx | 18 +- .../content/_update-cmpxchg-item-csharp.mdx | 8 +- .../content/_update-cmpxchg-item-java.mdx | 6 +- .../content/_update-cmpxchg-item-nodejs.mdx | 8 +- ...ed-documents-and-other-features-csharp.mdx | 20 +- .../content/_enable-data-archiving-csharp.mdx | 4 +- .../_schedule-document-archiving-csharp.mdx | 10 +- .../content/_unarchiving-documents-csharp.mdx | 8 +- docs/data-archival/overview.mdx | 8 +- .../attachments-and-other-features.mdx | 8 +- .../_configure-remote-attachments-csharp.mdx | 14 +- .../content/_copy-move-rename-csharp.mdx | 12 +- .../content/_copy-move-rename-nodejs.mdx | 8 +- .../content/_delete-attachment-csharp.mdx | 12 +- .../content/_delete-attachment-java.mdx | 4 +- .../content/_delete-attachment-nodejs.mdx | 4 +- .../content/_get-attachments-csharp.mdx | 22 +-- .../content/_get-attachments-java.mdx | 4 +- .../content/_get-attachments-nodejs.mdx | 4 +- .../content/_indexing-attachments-csharp.mdx | 12 +- .../content/_indexing-attachments-java.mdx | 6 +- .../content/_indexing-attachments-nodejs.mdx | 12 +- .../content/_indexing-attachments-php.mdx | 6 +- .../content/_indexing-attachments-python.mdx | 6 +- .../attachments/content/_overview-csharp.mdx | 6 +- docs/document-extensions/attachments/faq.mdx | 14 +- .../content/_bulk-insert-csharp.mdx | 10 +- .../content/_bulk-insert-nodejs.mdx | 6 +- .../content/_bulk-insert-python.mdx | 4 +- .../_store-attachments-local-csharp.mdx | 20 +- .../content/_store-attachments-local-java.mdx | 4 +- .../_store-attachments-local-nodejs.mdx | 4 +- .../_store-attachments-remote-csharp.mdx | 26 +-- .../_counters-and-other-features-csharp.mdx | 40 ++-- .../_counters-and-other-features-java.mdx | 38 ++-- .../_counters-and-other-features-nodejs.mdx | 40 ++-- .../_counters-and-other-features-php.mdx | 30 +-- .../_counters-and-other-features-python.mdx | 38 ++-- .../content/_create-or-modify-csharp.mdx | 6 +- .../content/_create-or-modify-java.mdx | 6 +- .../content/_create-or-modify-nodejs.mdx | 6 +- .../content/_create-or-modify-php.mdx | 6 +- .../content/_create-or-modify-python.mdx | 6 +- .../counters/content/_delete-csharp.mdx | 6 +- .../counters/content/_delete-java.mdx | 6 +- .../counters/content/_delete-nodejs.mdx | 6 +- .../counters/content/_delete-php.mdx | 6 +- .../counters/content/_delete-python.mdx | 6 +- .../content/_including-counters-csharp.mdx | 28 +-- .../content/_including-counters-nodejs.mdx | 28 +-- .../counters/content/_indexing-csharp.mdx | 8 +- .../counters/content/_indexing-java.mdx | 8 +- .../counters/content/_indexing-nodejs.mdx | 8 +- .../counters/content/_indexing-php.mdx | 6 +- .../counters/content/_indexing-python.mdx | 6 +- .../counters/content/_overview-csharp.mdx | 10 +- .../counters/content/_overview-java.mdx | 10 +- .../counters/content/_overview-nodejs.mdx | 10 +- .../counters/content/_overview-php.mdx | 10 +- .../counters/content/_overview-python.mdx | 10 +- .../_retrieve-counter-values-csharp.mdx | 18 +- .../content/_retrieve-counter-values-java.mdx | 18 +- .../_retrieve-counter-values-nodejs.mdx | 18 +- .../content/_retrieve-counter-values-php.mdx | 18 +- .../_retrieve-counter-values-python.mdx | 18 +- .../counters/counters-in-clusters.mdx | 20 +- docs/document-extensions/overview.mdx | 4 +- .../client-api/content/_overview-csharp.mdx | 4 +- .../client-api/content/_overview-java.mdx | 4 +- .../client-api/content/_overview-nodejs.mdx | 4 +- .../client-api/content/_overview-php.mdx | 4 +- .../client-api/content/_overview-python.mdx | 4 +- .../content/_configure-revisions-csharp.mdx | 6 +- .../content/_configure-revisions-java.mdx | 18 +- .../content/_configure-revisions-nodejs.mdx | 6 +- .../content/_configure-revisions-php.mdx | 6 +- .../content/_configure-revisions-python.mdx | 6 +- ...onflict-revisions-configuration-csharp.mdx | 6 +- ...onflict-revisions-configuration-nodejs.mdx | 6 +- .../_conflict-revisions-configuration-php.mdx | 6 +- .../content/_delete-revisions-csharp.mdx | 10 +- ...enforce-revisions-configuration-csharp.mdx | 16 +- .../_enforce-revisions-configuration-java.mdx | 12 +- ...enforce-revisions-configuration-nodejs.mdx | 12 +- .../content/_get-revisions-csharp.mdx | 6 +- .../content/_get-revisions-nodejs.mdx | 6 +- .../operations/content/_get-revisions-php.mdx | 6 +- .../content/_get-revisions-python.mdx | 6 +- .../session/content/_counting-csharp.mdx | 4 +- .../session/content/_counting-nodejs.mdx | 4 +- .../session/content/_counting-php.mdx | 4 +- .../session/content/_counting-python.mdx | 4 +- .../session/content/_including-csharp.mdx | 30 +-- .../session/content/_including-nodejs.mdx | 30 +-- .../session/content/_including-php.mdx | 30 +-- .../session/content/_loading-csharp.mdx | 8 +- .../session/content/_loading-nodejs.mdx | 8 +- .../session/content/_loading-php.mdx | 8 +- .../session/content/_loading-python.mdx | 8 +- .../revisions/content/_overview-csharp.mdx | 26 +-- .../revisions/content/_overview-nodejs.mdx | 26 +-- .../revisions/content/_overview-python.mdx | 26 +-- .../_revisions-and-other-features-csharp.mdx | 16 +- .../_revisions-and-other-features-nodejs.mdx | 16 +- .../_revisions-and-other-features-php.mdx | 14 +- .../_revisions-and-other-features-python.mdx | 16 +- ...documents-to-specific-revisions-csharp.mdx | 12 +- .../revert-documents-to-specific-time.mdx | 18 +- .../revisions/revisions-bin-cleaner.mdx | 12 +- .../revisions/troubleshooting.mdx | 2 +- .../content/_append-in-bulk-csharp.mdx | 16 +- .../content/_append-in-bulk-nodejs.mdx | 16 +- .../content/_javascript-support-csharp.mdx | 12 +- .../content/_javascript-support-nodejs.mdx | 12 +- .../_named-time-series-values-csharp.mdx | 12 +- .../_named-time-series-values-nodejs.mdx | 12 +- .../client-api/content/_overview-csharp.mdx | 8 +- .../client-api/content/_overview-nodejs.mdx | 8 +- .../content/_append-and-delete-csharp.mdx | 14 +- .../content/_append-and-delete-nodejs.mdx | 14 +- .../operations/content/_get-csharp.mdx | 12 +- .../operations/content/_get-nodejs.mdx | 12 +- .../operations/content/_patch-csharp.mdx | 16 +- .../operations/content/_patch-nodejs.mdx | 16 +- .../session/content/_append-csharp.mdx | 10 +- .../session/content/_append-nodejs.mdx | 10 +- .../session/content/_append-php.mdx | 8 +- .../session/content/_append-python.mdx | 10 +- .../session/content/_delete-csharp.mdx | 10 +- .../session/content/_delete-nodejs.mdx | 12 +- .../session/content/_delete-php.mdx | 4 +- .../session/content/_delete-python.mdx | 6 +- .../session/content/_patch-csharp.mdx | 10 +- .../session/content/_patch-nodejs.mdx | 10 +- .../client-api/session/content/_patch-php.mdx | 10 +- .../session/content/_patch-python.mdx | 10 +- .../session/content/_querying-csharp.mdx | 24 +-- .../session/content/_querying-nodejs.mdx | 18 +- .../get/content/_get-entries-csharp.mdx | 16 +- .../get/content/_get-entries-nodejs.mdx | 16 +- .../session/get/content/_get-entries-php.mdx | 16 +- .../get/content/_get-entries-python.mdx | 16 +- .../session/get/content/_get-names-csharp.mdx | 6 +- .../session/get/content/_get-names-nodejs.mdx | 6 +- .../session/get/content/_get-names-php.mdx | 6 +- .../session/get/content/_get-names-python.mdx | 6 +- .../content/_with-raw-queries-csharp.mdx | 4 +- .../content/_with-raw-queries-nodejs.mdx | 4 +- .../content/_with-session-load-csharp.mdx | 4 +- .../content/_with-session-load-nodejs.mdx | 4 +- .../content/_with-session-query-csharp.mdx | 4 +- .../content/_with-session-query-nodejs.mdx | 4 +- .../timeseries/content/_design-csharp.mdx | 24 +-- .../timeseries/content/_design-nodejs.mdx | 24 +-- .../timeseries/content/_indexing-csharp.mdx | 32 ++-- .../timeseries/content/_indexing-nodejs.mdx | 24 +-- .../timeseries/content/_indexing-php.mdx | 16 +- .../timeseries/content/_indexing-python.mdx | 16 +- .../content/_rollup-and-retention-csharp.mdx | 10 +- .../content/_rollup-and-retention-nodejs.mdx | 10 +- .../content/_rollup-and-retention-php.mdx | 10 +- .../content/_rollup-and-retention-python.mdx | 10 +- ..._time-series-and-other-features-csharp.mdx | 8 +- ..._time-series-and-other-features-nodejs.mdx | 8 +- .../client-api/javascript-support.mdx | 10 +- .../client-api/operations/get.mdx | 8 +- .../client-api/session/delete.mdx | 8 +- .../client-api/session/get.mdx | 6 +- .../client-api/session/increment.mdx | 8 +- .../client-api/session/overview.mdx | 6 +- .../incremental-time-series/overview.mdx | 6 +- .../timeseries/overview.mdx | 38 ++-- .../_aggregation-and-projections-csharp.mdx | 20 +- .../_aggregation-and-projections-nodejs.mdx | 16 +- .../_aggregation-and-projections-php.mdx | 16 +- .../content/_choosing-query-range-csharp.mdx | 12 +- .../content/_choosing-query-range-nodejs.mdx | 12 +- .../content/_choosing-query-range-php.mdx | 12 +- .../content/_choosing-query-range-python.mdx | 12 +- .../querying/content/_filtering-csharp.mdx | 6 +- .../querying/content/_filtering-nodejs.mdx | 6 +- .../querying/content/_filtering-php.mdx | 6 +- .../querying/content/_filtering-python.mdx | 6 +- .../querying/content/_gap-filling-csharp.mdx | 4 +- .../querying/content/_gap-filling-java.mdx | 4 +- .../querying/content/_gap-filling-nodejs.mdx | 4 +- .../content/_overview-and-syntax-csharp.mdx | 22 +-- .../content/_overview-and-syntax-nodejs.mdx | 22 +-- .../content/_overview-and-syntax-php.mdx | 22 +-- .../content/_overview-and-syntax-python.mdx | 22 +-- .../content/_stream-timeseries-csharp.mdx | 4 +- .../content/_stream-timeseries-java.mdx | 4 +- .../content/_using-indexes-csharp.mdx | 18 +- .../content/_using-indexes-nodejs.mdx | 16 +- .../querying/content/_using-indexes-php.mdx | 16 +- .../content/_using-indexes-python.mdx | 16 +- .../timeseries/querying/statistics.mdx | 10 +- .../auditing-document-compliance_api.mdx | 24 +-- .../auditing-document-compliance_studio.mdx | 20 +- .../schema-validation/configuration.mdx | 6 +- docs/documents/schema-validation/overview.mdx | 14 +- .../write-validation/write-validation_api.mdx | 22 +-- .../write-validation_studio.mdx | 16 +- docs/indexes/additional-assemblies.mdx | 10 +- docs/indexes/content/_boosting-csharp.mdx | 12 +- docs/indexes/content/_boosting-java.mdx | 2 +- docs/indexes/content/_boosting-nodejs.mdx | 12 +- docs/indexes/content/_boosting-php.mdx | 12 +- .../_creating-and-deploying-csharp.mdx | 40 ++-- .../content/_creating-and-deploying-java.mdx | 32 ++-- .../_creating-and-deploying-nodejs.mdx | 40 ++-- .../content/_extending-indexes-csharp.mdx | 2 +- .../content/_extending-indexes-java.mdx | 2 +- .../content/_extending-indexes-nodejs.mdx | 2 +- .../_indexing-hierarchical-data-csharp.mdx | 8 +- .../_indexing-hierarchical-data-nodejs.mdx | 8 +- .../_indexing-hierarchical-data-php.mdx | 8 +- .../_indexing-hierarchical-data-python.mdx | 8 +- .../_indexing-linq-extensions-csharp.mdx | 10 +- .../_indexing-linq-extensions-java.mdx | 10 +- .../_indexing-linq-extensions-nodejs.mdx | 10 +- .../content/_indexing-metadata-csharp.mdx | 4 +- .../content/_indexing-metadata-java.mdx | 2 +- .../content/_indexing-metadata-nodejs.mdx | 4 +- .../content/_indexing-metadata-php.mdx | 4 +- .../content/_indexing-metadata-python.mdx | 4 +- .../content/_indexing-nested-data-csharp.mdx | 26 +-- .../content/_indexing-nested-data-nodejs.mdx | 26 +-- .../content/_indexing-nested-data-php.mdx | 26 +-- .../content/_indexing-nested-data-python.mdx | 26 +-- .../_indexing-polymorphic-data-csharp.mdx | 6 +- .../_indexing-polymorphic-data-java.mdx | 6 +- .../_indexing-polymorphic-data-nodejs.mdx | 10 +- .../_indexing-polymorphic-data-php.mdx | 6 +- .../_indexing-polymorphic-data-python.mdx | 6 +- .../_indexing-related-documents-csharp.mdx | 30 +-- .../_indexing-related-documents-nodejs.mdx | 26 +-- .../_indexing-related-documents-php.mdx | 30 +-- .../_indexing-related-documents-python.mdx | 30 +-- .../content/_indexing-spatial-data-csharp.mdx | 8 +- .../content/_indexing-spatial-data-nodejs.mdx | 8 +- .../content/_indexing-spatial-data-php.mdx | 8 +- .../content/_indexing-spatial-data-python.mdx | 8 +- .../content/_javascript-indexes-csharp.mdx | 16 +- docs/indexes/content/_map-indexes-csharp.mdx | 12 +- docs/indexes/content/_map-indexes-java.mdx | 8 +- docs/indexes/content/_map-indexes-nodejs.mdx | 10 +- docs/indexes/content/_map-indexes-php.mdx | 12 +- docs/indexes/content/_map-indexes-python.mdx | 12 +- .../content/_map-reduce-indexes-csharp.mdx | 16 +- .../content/_map-reduce-indexes-java.mdx | 14 +- .../content/_map-reduce-indexes-nodejs.mdx | 10 +- .../content/_map-reduce-indexes-php.mdx | 14 +- .../content/_map-reduce-indexes-python.mdx | 16 +- .../content/_multi-map-indexes-csharp.mdx | 6 +- .../content/_multi-map-indexes-java.mdx | 6 +- .../content/_multi-map-indexes-nodejs.mdx | 6 +- .../content/_multi-map-indexes-php.mdx | 6 +- .../content/_multi-map-indexes-python.mdx | 6 +- .../_number-type-conversion-csharp.mdx | 4 +- .../content/_storing-data-in-index-csharp.mdx | 12 +- .../content/_storing-data-in-index-java.mdx | 2 +- .../content/_storing-data-in-index-nodejs.mdx | 2 +- .../content/_storing-data-in-index-php.mdx | 2 +- .../content/_storing-data-in-index-python.mdx | 2 +- .../content/_using-analyzers-csharp.mdx | 80 ++++---- .../indexes/content/_using-analyzers-java.mdx | 14 +- .../content/_using-analyzers-nodejs.mdx | 80 ++++---- .../content/_using-dynamic-fields-csharp.mdx | 30 +-- .../content/_using-dynamic-fields-java.mdx | 30 +-- .../content/_using-dynamic-fields-nodejs.mdx | 30 +-- .../content/_using-dynamic-fields-php.mdx | 30 +-- .../content/_using-dynamic-fields-python.mdx | 30 +-- .../content/_using-term-vectors-csharp.mdx | 6 +- .../content/_what-are-indexes-csharp.mdx | 16 +- .../content/_what-are-indexes-java.mdx | 16 +- .../content/_what-are-indexes-nodejs.mdx | 16 +- .../indexes/content/_what-are-indexes-php.mdx | 16 +- .../content/_what-are-indexes-python.mdx | 16 +- docs/indexes/index-administration.mdx | 22 +-- docs/indexes/index-throttling.mdx | 18 +- .../querying/content/_distinct-csharp.mdx | 8 +- .../querying/content/_distinct-java.mdx | 8 +- .../querying/content/_distinct-nodejs.mdx | 8 +- .../content/_exploration-queries-csharp.mdx | 22 +-- .../content/_exploration-queries-nodejs.mdx | 20 +- .../content/_exploration-queries-php.mdx | 26 +-- .../content/_exploration-queries-python.mdx | 26 +-- .../content/_faceted-search-csharp.mdx | 12 +- .../content/_faceted-search-nodejs.mdx | 12 +- .../querying/content/_faceted-search-php.mdx | 12 +- .../content/_faceted-search-python.mdx | 12 +- .../querying/content/_highlighting-csharp.mdx | 6 +- .../querying/content/_highlighting-nodejs.mdx | 6 +- .../querying/content/_highlighting-php.mdx | 6 +- .../querying/content/_highlighting-python.mdx | 6 +- .../content/_include-explanations-csharp.mdx | 6 +- .../content/_include-explanations-nodejs.mdx | 6 +- .../querying/content/_intersection-csharp.mdx | 2 +- .../querying/content/_intersection-java.mdx | 2 +- .../querying/content/_intersection-nodejs.mdx | 2 +- .../querying/content/_intersection-php.mdx | 2 +- .../querying/content/_intersection-python.mdx | 2 +- .../querying/content/_morelikethis-csharp.mdx | 10 +- .../querying/content/_morelikethis-java.mdx | 10 +- .../querying/content/_morelikethis-nodejs.mdx | 10 +- .../querying/content/_morelikethis-php.mdx | 10 +- .../querying/content/_morelikethis-python.mdx | 10 +- .../querying/content/_paging-csharp.mdx | 10 +- .../indexes/querying/content/_paging-java.mdx | 10 +- .../querying/content/_paging-nodejs.mdx | 10 +- docs/indexes/querying/content/_paging-php.mdx | 10 +- .../querying/content/_paging-python.mdx | 10 +- .../querying/content/_projections-csharp.mdx | 18 +- .../querying/content/_projections-java.mdx | 4 +- .../querying/content/_projections-nodejs.mdx | 10 +- .../querying/content/_projections-php.mdx | 10 +- .../querying/content/_projections-python.mdx | 12 +- .../querying/content/_query-index-csharp.mdx | 10 +- .../querying/content/_query-index-nodejs.mdx | 6 +- .../querying/content/_query-index-php.mdx | 14 +- .../querying/content/_query-index-python.mdx | 8 +- .../querying/content/_searching-csharp.mdx | 24 +-- .../querying/content/_searching-nodejs.mdx | 24 +-- .../querying/content/_searching-php.mdx | 10 +- .../querying/content/_searching-python.mdx | 10 +- .../querying/content/_spatial-csharp.mdx | 6 +- .../querying/content/_spatial-nodejs.mdx | 6 +- .../indexes/querying/content/_spatial-php.mdx | 6 +- .../querying/content/_spatial-python.mdx | 6 +- .../querying/content/_suggestions-csharp.mdx | 12 +- .../querying/content/_suggestions-nodejs.mdx | 12 +- .../querying/content/_suggestions-php.mdx | 12 +- .../querying/content/_suggestions-python.mdx | 12 +- docs/indexes/rolling-index-deployment.mdx | 22 +-- docs/indexes/search-engine/corax.mdx | 44 ++--- .../events-and-snapshots.mdx | 10 +- .../integrating-with-akka-persistence.mdx | 18 +- .../akka.net-persistence/queries.mdx | 14 +- .../postgresql-protocol/overview.mdx | 10 +- .../postgresql-protocol/power-bi.mdx | 8 +- docs/integrations/terraform.mdx | 20 +- docs/licensing/activate-license.mdx | 4 +- docs/licensing/configuration.mdx | 24 +-- docs/licensing/faq.mdx | 14 +- docs/licensing/force-update.mdx | 2 +- docs/licensing/license-under-docker.mdx | 14 +- docs/licensing/overview.mdx | 22 +-- docs/licensing/renew-license.mdx | 8 +- docs/licensing/replace-license.mdx | 10 +- .../migration/client-api/client-migration.mdx | 2 +- ...vious-versions-client-breaking-changes.mdx | 36 ++-- docs/migration/server/data-migration.mdx | 8 +- docs/migration/server/docker.mdx | 10 +- .../server/legacy-versions-data-migration.mdx | 8 +- ...vious-versions-server-breaking-changes.mdx | 30 +-- .../server/server-breaking-changes.mdx | 2 +- docs/monitoring/task-errors/configuration.mdx | 10 +- docs/monitoring/task-errors/overview.mdx | 18 +- docs/monitoring/task-errors/studio-views.mdx | 26 +-- docs/monitoring/tombstones/configuration.mdx | 10 +- docs/monitoring/tombstones/overview.mdx | 12 +- .../monitoring/tombstones/tombstones-view.mdx | 14 +- .../content/_customize-query-csharp.mdx | 24 +-- .../content/_customize-query-java.mdx | 16 +- .../content/_customize-query-nodejs.mdx | 12 +- .../querying/content/_customize-query-php.mdx | 16 +- .../content/_customize-query-python.mdx | 22 +-- docs/querying/content/_overview-csharp.mdx | 34 ++-- docs/querying/content/_overview-nodejs.mdx | 30 +-- docs/querying/content/_overview-php.mdx | 34 ++-- docs/querying/content/_overview-python.mdx | 32 ++-- .../content/_stream-query-results-csharp.mdx | 24 +-- .../content/_stream-query-results-nodejs.mdx | 24 +-- .../_query-vs-document-query-csharp.mdx | 6 +- .../content/_query-vs-document-query-php.mdx | 2 +- .../_query-vs-document-query-python.mdx | 2 +- .../_what-is-document-query-csharp.mdx | 8 +- .../content/_what-is-document-query-php.mdx | 4 +- .../_what-is-document-query-python.mdx | 4 +- .../content/_conditional-filtering-csharp.mdx | 18 +- .../_filter-by-date-and-time-csharp.mdx | 40 ++-- .../content/_filter-query-results-csharp.mdx | 32 ++-- .../content/_filter-query-results-java.mdx | 32 ++-- .../content/_filter-query-results-nodejs.mdx | 32 ++-- .../content/_filter-query-results-php.mdx | 32 ++-- .../content/_filter-query-results-python.mdx | 32 ++-- .../_filter-with-lucene-syntax-csharp.mdx | 28 +-- .../_filter-with-lucene-syntax-java.mdx | 28 +-- .../_filter-with-lucene-syntax-nodejs.mdx | 28 +-- .../_filter-with-lucene-syntax-php.mdx | 28 +-- .../_filter-with-lucene-syntax-python.mdx | 28 +-- .../content/_use-logical-operators-csharp.mdx | 18 +- .../content/_use-logical-operators-java.mdx | 18 +- .../content/_use-logical-operators-nodejs.mdx | 18 +- .../content/_use-logical-operators-php.mdx | 18 +- .../content/_use-logical-operators-python.mdx | 18 +- docs/querying/rql/rql-code-assistance.mdx | 4 +- docs/querying/rql/what-is-rql.mdx | 62 +++--- .../content/_sort-query-results-csharp.mdx | 44 ++--- .../content/_sort-query-results-java.mdx | 44 ++--- .../content/_sort-query-results-nodejs.mdx | 42 ++--- .../content/_sort-query-results-php.mdx | 34 ++-- .../content/_sort-query-results-python.mdx | 44 ++--- .../_database-level-custom-sorters-csharp.mdx | 22 +-- .../_database-level-custom-sorters-nodejs.mdx | 22 +-- .../content/_overview-csharp.mdx | 6 +- .../content/_overview-nodejs.mdx | 6 +- .../_server-wide-custom-sorters-csharp.mdx | 14 +- .../_server-wide-custom-sorters-nodejs.mdx | 14 +- docs/server/administration/cli.mdx | 36 ++-- .../monitoring/mib-generation.mdx | 6 +- .../monitoring/open-telemetry.mdx | 30 +-- .../administration/monitoring/prometheus.mdx | 14 +- .../administration/monitoring/telegraf.mdx | 6 +- .../administration/snmp/setup-zabbix.mdx | 20 +- .../administration/snmp/snmp-overview.mdx | 42 ++--- docs/server/clustering/cluster-api.mdx | 14 +- ...luster-best-practice-and-configuration.mdx | 4 +- .../clustering/cluster-transactions.mdx | 14 +- .../distribution/cluster-observer.mdx | 4 +- .../distribution/distributed-database.mdx | 14 +- .../distribution/highly-available-tasks.mdx | 14 +- .../clustering/rachis/cluster-topology.mdx | 16 +- .../rachis/consensus-operations.mdx | 8 +- .../replication/advanced-replication.mdx | 2 +- .../clustering/replication/change-vector.mdx | 18 +- .../replication-and-embedded-instance.mdx | 8 +- .../replication/replication-conflicts.mdx | 4 +- .../replication/replication-overview.mdx | 16 +- .../configuration/cluster-configuration.mdx | 46 ++--- .../configuration/configuration-options.mdx | 14 +- .../configuration/database-configuration.mdx | 30 +-- .../configuration/etl-configuration.mdx | 26 +-- .../configuration/http-configuration.mdx | 52 +++--- .../configuration/indexing-configuration.mdx | 176 +++++++++--------- .../configuration/logs-configuration.mdx | 36 ++-- .../configuration/memory-configuration.mdx | 12 +- .../monitoring-configuration.mdx | 82 ++++---- .../configuration/patching-configuration.mdx | 6 +- .../performance-hints-configuration.mdx | 18 +- .../configuration/security-configuration.mdx | 108 +++++------ .../configuration/server-configuration.mdx | 12 +- .../subscription-configuration.mdx | 4 +- docs/server/content/_embedded-csharp.mdx | 40 ++-- .../extensions/content/_expiration-csharp.mdx | 12 +- .../extensions/content/_refresh-csharp.mdx | 10 +- ..._document-identifier-generation-csharp.mdx | 56 +++--- docs/server/kb/javascript-engine.mdx | 4 +- docs/server/kb/numbers-in-ravendb.mdx | 12 +- docs/server/ongoing-tasks/etl/basics.mdx | 22 +-- .../ongoing-tasks/etl/elasticsearch.mdx | 40 ++-- docs/server/ongoing-tasks/etl/olap.mdx | 12 +- .../etl/queue-etl/amazon-sqs.mdx | 34 ++-- .../etl/queue-etl/azure-queue.mdx | 22 +-- .../ongoing-tasks/etl/queue-etl/kafka.mdx | 42 ++--- .../ongoing-tasks/etl/queue-etl/overview.mdx | 18 +- .../ongoing-tasks/etl/queue-etl/rabbit-mq.mdx | 22 +-- docs/server/ongoing-tasks/etl/raven.mdx | 74 ++++---- docs/server/ongoing-tasks/etl/snowflake.mdx | 28 +-- docs/server/ongoing-tasks/etl/sql.mdx | 38 ++-- .../server/ongoing-tasks/etl/test-scripts.mdx | 4 +- .../ongoing-tasks/external-replication.mdx | 16 +- .../ongoing-tasks/hub-sink-replication.mdx | 16 +- .../azure-service-bus-queue-sink.mdx | 38 ++-- .../queue-sink/kafka-queue-sink.mdx | 30 +-- .../ongoing-tasks/queue-sink/overview.mdx | 6 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 30 +-- .../security/audit-log/audit-log-overview.mdx | 6 +- .../certificate-configuration.mdx | 24 +-- .../authentication/certificate-management.mdx | 62 +++--- .../lets-encrypt-certificates.mdx | 2 +- .../recover-from-expired-certificate.mdx | 12 +- ...olve-cluster-certificate-renewal-issue.mdx | 10 +- .../security-clearance-and-permissions.mdx | 12 +- .../server/security/common-errors-and-faq.mdx | 52 +++--- .../encryption/encryption-at-rest.mdx | 2 +- .../encryption/secret-key-management.mdx | 4 +- .../content/_documents-compression-csharp.mdx | 10 +- .../content/_documents-compression-nodejs.mdx | 10 +- ...customizing-raven-data-files-locations.mdx | 12 +- docs/server/storage/directory-structure.mdx | 4 +- docs/server/storage/storage-engine.mdx | 10 +- docs/server/tcp-compression.mdx | 8 +- docs/server/troubleshooting/collect-info.mdx | 14 +- docs/server/troubleshooting/debug-routes.mdx | 4 +- docs/server/troubleshooting/logging.mdx | 52 +++--- docs/server/troubleshooting/traffic-watch.mdx | 4 +- .../administration/anchoring-documents.mdx | 8 +- docs/sharding/administration/api-admin.mdx | 18 +- .../administration/sharding-by-prefix.mdx | 28 +-- docs/sharding/administration/studio-admin.mdx | 8 +- docs/sharding/backup-and-restore/backup.mdx | 24 +-- docs/sharding/backup-and-restore/restore.mdx | 26 +-- docs/sharding/configuration.mdx | 8 +- docs/sharding/document-extensions.mdx | 8 +- docs/sharding/etl.mdx | 18 +- docs/sharding/external-replication.mdx | 10 +- docs/sharding/import-and-export.mdx | 10 +- docs/sharding/indexing.mdx | 6 +- docs/sharding/migration.mdx | 6 +- docs/sharding/overview.mdx | 34 ++-- docs/sharding/querying.mdx | 42 ++--- docs/sharding/resharding.mdx | 20 +- docs/sharding/subscriptions.mdx | 4 +- docs/sharding/unsupported.mdx | 22 +-- docs/start/containers/general-guide.mdx | 8 +- docs/start/content/_test-driver-csharp.mdx | 16 +- docs/start/content/_test-driver-java.mdx | 14 +- docs/start/getting-started.mdx | 22 +-- docs/start/guides/aws-lambda/overview.mdx | 20 +- .../content/_existing-project-csharp.mdx | 12 +- .../content/_existing-project-nodejs.mdx | 12 +- .../content/_overview-csharp.mdx | 18 +- .../content/_overview-nodejs.mdx | 18 +- .../guides/azure-functions/deployment.mdx | 2 +- .../cloudflare-workers/existing-project.mdx | 12 +- .../guides/cloudflare-workers/overview.mdx | 16 +- .../deployment-considerations.mdx | 12 +- docs/start/installation/gnu-linux/deb.mdx | 28 +-- docs/start/installation/manual.mdx | 10 +- .../start/installation/running-as-service.mdx | 10 +- .../setup-wizard/additional-settings.mdx | 6 +- .../setup-wizard/choose-security-option.mdx | 18 +- .../setup-wizard/choose-setup-method.mdx | 14 +- .../setup-wizard/configure-node-addresses.mdx | 14 +- .../setup-wizard/finish-setup.mdx | 14 +- .../installation/setup-wizard/overview.mdx | 8 +- .../setup-wizard/provide-license-key.mdx | 6 +- .../setup-wizard/review-setup.mdx | 2 +- .../setup-wizard/use-setup-package.mdx | 4 +- docs/studio/ai-assistant.mdx | 38 ++-- .../cluster-dashboard-customize.mdx | 10 +- .../cluster-dashboard-overview.mdx | 6 +- .../cluster-dashboard-widgets.mdx | 20 +- docs/studio/cluster/cluster-view.mdx | 14 +- docs/studio/cluster/setting-a-cluster.mdx | 6 +- docs/studio/configuration.mdx | 8 +- .../create-new-database/from-legacy-files.mdx | 4 +- .../create-new-database/general-flow.mdx | 12 +- docs/studio/database/databases-list-view.mdx | 16 +- .../database/document-extensions/counters.mdx | 6 +- .../revisions/all-revisions.mdx | 10 +- .../revisions/revisions-bin.mdx | 8 +- .../revisions/revisions-overview.mdx | 6 +- .../document-extensions/time-series.mdx | 40 ++-- .../documents/create-new-document.mdx | 14 +- .../database/documents/document-view.mdx | 4 +- .../documents/documents-and-collections.mdx | 2 +- .../database/documents/identities-view.mdx | 10 +- docs/studio/database/documents/patch-view.mdx | 16 +- .../database/indexes/create-map-index.mdx | 26 +-- .../indexes/create-map-reduce-index.mdx | 18 +- .../indexes/create-multi-map-index.mdx | 4 +- .../studio/database/indexes/index-cleanup.mdx | 10 +- .../studio/database/indexes/index-history.mdx | 10 +- .../database/indexes/indexes-list-view.mdx | 12 +- .../database/indexes/indexes-overview.mdx | 28 +-- .../database/indexes/indexing-performance.mdx | 34 ++-- .../indexes/map-reduce-visualizer.mdx | 4 +- docs/studio/database/queries/query-view.mdx | 14 +- .../queries/spatial-queries-map-view.mdx | 14 +- .../client-configuration-per-database.mdx | 2 +- .../database/settings/conflict-resolution.mdx | 4 +- .../database/settings/custom-analyzers.mdx | 14 +- .../database/settings/database-record.mdx | 4 +- .../database/settings/database-settings.mdx | 16 +- .../database/settings/document-revisions.mdx | 30 +-- .../settings/documents-compression.mdx | 2 +- .../studio/database/settings/integrations.mdx | 2 +- .../settings/manage-database-group.mdx | 12 +- .../settings/studio-configuration.mdx | 12 +- .../settings/time-series-settings.mdx | 18 +- .../external-replication-stats.mdx | 4 +- .../ongoing-tasks-stats/olap-etl-stats.mdx | 4 +- .../stats/ongoing-tasks-stats/overview.mdx | 18 +- .../ongoing-tasks-stats/ravendb-etl-stats.mdx | 4 +- .../ongoing-tasks-stats/sql-etl-stats.mdx | 4 +- .../subscription-stats.mdx | 6 +- docs/studio/database/stats/storage-report.mdx | 2 +- .../database/tasks/create-sample-data.mdx | 4 +- .../studio/database/tasks/export-database.mdx | 6 +- .../tasks/import-data/import-data-file.mdx | 14 +- .../tasks/import-data/import-from-csv.mdx | 8 +- .../tasks/import-data/import-from-other.mdx | 10 +- .../tasks/import-data/import-from-ravendb.mdx | 2 +- .../tasks/import-data/import-from-sql.mdx | 40 ++-- .../tasks/ongoing-tasks/amazon-sqs-etl.mdx | 10 +- .../ongoing-tasks/azure-queue-storage-etl.mdx | 14 +- .../azure-service-bus-queue-sink.mdx | 8 +- .../ongoing-tasks/elasticsearch-etl-task.mdx | 24 +-- .../external-replication-task.mdx | 16 +- .../tasks/ongoing-tasks/general-info.mdx | 10 +- .../hub-sink-replication/overview.mdx | 12 +- .../replication-hub-task.mdx | 12 +- .../replication-sink-task.mdx | 14 +- .../tasks/ongoing-tasks/kafka-etl-task.mdx | 24 +-- .../tasks/ongoing-tasks/kafka-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/olap-etl-task.mdx | 20 +- .../tasks/ongoing-tasks/rabbitmq-etl-task.mdx | 8 +- .../ongoing-tasks/rabbitmq-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/ravendb-etl-task.mdx | 18 +- .../ongoing-tasks/snowflake-etl-task.mdx | 6 +- .../tasks/ongoing-tasks/subscription-task.mdx | 6 +- docs/studio/overview.mdx | 16 +- .../certificates/read-only-access-level.mdx | 2 +- .../server-management-certificates-view.mdx | 16 +- docs/studio/server/client-configuration.mdx | 2 +- docs/studio/server/debug/admin-js-console.mdx | 6 +- docs/studio/server/debug/admin-logs.mdx | 32 ++-- .../debug/advanced/cluster-observer.mdx | 6 +- docs/studio/server/manage-server.mdx | 6 +- docs/studio/server/server-settings.mdx | 2 +- .../recovering-from-voron-errors.mdx | 2 +- ...work-with-bulk-insert-operation-csharp.mdx | 42 ++--- ...to-subscribe-to-counter-changes-csharp.mdx | 18 +- ...w-to-subscribe-to-counter-changes-java.mdx | 18 +- ...o-subscribe-to-document-changes-csharp.mdx | 18 +- ...-to-subscribe-to-document-changes-java.mdx | 18 +- ...o-subscribe-to-document-changes-nodejs.mdx | 18 +- ...w-to-subscribe-to-index-changes-csharp.mdx | 10 +- ...how-to-subscribe-to-index-changes-java.mdx | 10 +- ...w-to-subscribe-to-index-changes-nodejs.mdx | 10 +- ...-subscribe-to-operation-changes-csharp.mdx | 14 +- ...to-subscribe-to-operation-changes-java.mdx | 8 +- ...-subscribe-to-operation-changes-nodejs.mdx | 8 +- ...ubscribe-to-time-series-changes-csharp.mdx | 16 +- .../content/_what-is-changes-api-csharp.mdx | 18 +- .../content/_what-is-changes-api-java.mdx | 12 +- .../content/_what-is-changes-api-nodejs.mdx | 16 +- ...es-with-replication-and-cluster-csharp.mdx | 10 +- ...ates-with-replication-and-cluster-java.mdx | 10 +- ...es-with-replication-and-cluster-nodejs.mdx | 10 +- ...multiple-commands-using-a-batch-csharp.mdx | 6 +- ...multiple-commands-using-a-batch-nodejs.mdx | 6 +- .../commands/content/_overview-csharp.mdx | 12 +- .../commands/content/_overview-java.mdx | 6 +- .../commands/content/_overview-nodejs.mdx | 12 +- .../documents/content/_delete-csharp.mdx | 4 +- .../documents/content/_delete-nodejs.mdx | 4 +- .../documents/content/_delete-php.mdx | 4 +- .../documents/content/_delete-python.mdx | 4 +- .../documents/content/_get-csharp.mdx | 14 +- .../commands/documents/content/_get-java.mdx | 10 +- .../documents/content/_get-nodejs.mdx | 14 +- .../commands/documents/content/_get-php.mdx | 8 +- .../documents/content/_get-python.mdx | 8 +- .../documents/content/_put-csharp.mdx | 4 +- .../documents/content/_put-nodejs.mdx | 4 +- .../commands/documents/content/_put-php.mdx | 4 +- .../documents/content/_put-python.mdx | 4 +- .../content/_conventions-csharp.mdx | 122 ++++++------ .../content/_conventions-nodejs.mdx | 64 +++---- .../content/_deserialization-csharp.mdx | Bin 3578 -> 3313 bytes .../content/_serialization-csharp.mdx | 10 +- .../content/_load-balance-behavior-csharp.mdx | 14 +- .../content/_load-balance-behavior-nodejs.mdx | 14 +- .../content/_load-balance-behavior-php.mdx | 14 +- .../content/_load-balance-behavior-python.mdx | 14 +- .../content/_read-balance-behavior-csharp.mdx | 14 +- .../content/_read-balance-behavior-nodejs.mdx | 14 +- .../content/_read-balance-behavior-php.mdx | 14 +- .../content/_read-balance-behavior-python.mdx | 14 +- .../configuration/load-balance/overview.mdx | 12 +- .../_creating-document-store-csharp.mdx | 8 +- ...uthentication-and-authorization-csharp.mdx | 2 +- .../_setting-up-default-database-csharp.mdx | 4 +- .../_maintenance-operations-csharp.mdx | 14 +- .../content/_maintenance-operations-java.mdx | 10 +- .../_maintenance-operations-nodejs.mdx | 16 +- .../_subscription-with-revisioning-csharp.mdx | 14 +- .../_subscription-with-revisioning-java.mdx | 6 +- .../_subscription-with-revisioning-nodejs.mdx | 12 +- .../content/_api-overview-csharp.mdx | 22 +-- .../content/_api-overview-java.mdx | 16 +- .../content/_api-overview-nodejs.mdx | 22 +-- .../content/_api-overview-python.mdx | 14 +- .../consumption/content/_examples-csharp.mdx | 18 +- .../consumption/content/_examples-java.mdx | 14 +- .../consumption/content/_examples-nodejs.mdx | 14 +- .../consumption/content/_examples-python.mdx | 16 +- ...ow-to-consume-data-subscription-csharp.mdx | 18 +- ..._how-to-consume-data-subscription-java.mdx | 8 +- ...ow-to-consume-data-subscription-nodejs.mdx | 18 +- ...ow-to-consume-data-subscription-python.mdx | 18 +- .../_concurrent-subscriptions-csharp.mdx | 8 +- .../_concurrent-subscriptions-nodejs.mdx | 8 +- .../_what-are-data-subscriptions-csharp.mdx | 14 +- .../_what-are-data-subscriptions-java.mdx | 14 +- .../_what-are-data-subscriptions-nodejs.mdx | 14 +- .../creation/content/_api-overview-csharp.mdx | 20 +- .../creation/content/_api-overview-nodejs.mdx | 28 +-- .../creation/content/_api-overview-python.mdx | 12 +- .../creation/content/_examples-csharp.mdx | 22 +-- .../creation/content/_examples-nodejs.mdx | 22 +-- .../creation/content/_examples-python.mdx | 18 +- ...how-to-create-data-subscription-csharp.mdx | 6 +- .../_how-to-create-data-subscription-java.mdx | 6 +- ...how-to-create-data-subscription-nodejs.mdx | 6 +- ...how-to-create-data-subscription-python.mdx | 6 +- .../content/_hilo-algorithm-csharp.mdx | 26 +-- ...rking-with-document-identifiers-csharp.mdx | 18 +- .../client-api/faq/backward-compatibility.mdx | 14 +- .../client-api/faq/transaction-support.mdx | 24 +-- .../client-api/faq/what-is-a-collection.mdx | 4 +- .../_handle-document-relationships-csharp.mdx | 16 +- .../_handle-document-relationships-nodejs.mdx | 16 +- .../_setup-aggressive-caching-csharp.mdx | 38 ++-- .../_setup-aggressive-caching-java.mdx | 38 ++-- .../how-to/integrate-with-excel.mdx | 2 +- .../how-to/subscribe-to-store-events.mdx | 24 +-- .../how-to/using-timeonly-and-dateonly.mdx | 14 +- .../content/_delete-attachment-nodejs.mdx | 4 +- .../content/_get-attachment-nodejs.mdx | 4 +- .../content/_put-attachment-nodejs.mdx | 4 +- .../content/_delete-by-query-csharp.mdx | 6 +- .../content/_delete-by-query-nodejs.mdx | 6 +- .../common/content/_delete-by-query-php.mdx | 6 +- .../content/_delete-by-query-python.mdx | 4 +- .../_compare-exchange-expiration-csharp.mdx | 4 +- .../_compare-exchange-metadata-csharp.mdx | 2 +- .../_delete-compare-exchange-value-csharp.mdx | 2 +- .../_delete-compare-exchange-value-java.mdx | 2 +- .../_delete-compare-exchange-value-nodejs.mdx | 4 +- .../_get-compare-exchange-value-csharp.mdx | 6 +- .../_get-compare-exchange-value-java.mdx | 6 +- .../_get-compare-exchange-value-nodejs.mdx | 8 +- .../_get-compare-exchange-values-csharp.mdx | 6 +- .../_get-compare-exchange-values-java.mdx | 6 +- .../_get-compare-exchange-values-nodejs.mdx | 8 +- .../_include-compare-exchange-csharp.mdx | 6 +- .../_include-compare-exchange-nodejs.mdx | 8 +- .../content/_overview-csharp.mdx | 18 +- .../content/_overview-java.mdx | 10 +- .../content/_overview-php.mdx | 18 +- .../content/_overview-python.mdx | 18 +- .../_put-compare-exchange-value-csharp.mdx | 8 +- .../_put-compare-exchange-value-java.mdx | 6 +- .../_put-compare-exchange-value-nodejs.mdx | 8 +- .../content/_what-are-operations-csharp.mdx | 24 +-- .../content/_what-are-operations-nodejs.mdx | 24 +-- .../content/_what-are-operations-php.mdx | 22 +-- .../content/_what-are-operations-python.mdx | 24 +-- ...-operations-to-a-different-node-csharp.mdx | 2 +- ...-operations-to-a-different-node-nodejs.mdx | 2 +- ...tch-operations-to-a-different-node-php.mdx | 2 +- .../maintenance/backup/backup-overview.mdx | 32 ++-- .../maintenance/backup/encrypted-backup.mdx | 32 ++-- .../operations/maintenance/backup/faq.mdx | 22 +-- .../operations/maintenance/backup/restore.mdx | 16 +- .../_database-settings-operation-csharp.mdx | 4 +- .../_database-settings-operation-nodejs.mdx | 4 +- .../_database-settings-operation-php.mdx | 4 +- .../_get-client-configuration-csharp.mdx | 4 +- .../_get-client-configuration-nodejs.mdx | 4 +- .../content/_get-client-configuration-php.mdx | 4 +- .../_get-client-configuration-python.mdx | 4 +- .../_put-client-configuration-csharp.mdx | 8 +- .../_put-client-configuration-nodejs.mdx | 8 +- .../content/_put-client-configuration-php.mdx | 8 +- .../_put-client-configuration-python.mdx | 8 +- .../content/_add-connection-string-csharp.mdx | 14 +- .../content/_get-connection-string-csharp.mdx | 6 +- .../_remove-connection-string-csharp.mdx | 4 +- .../maintenance/content/_get-stats-csharp.mdx | 12 +- .../maintenance/content/_get-stats-java.mdx | 12 +- .../maintenance/content/_get-stats-nodejs.mdx | 12 +- .../maintenance/content/_get-stats-php.mdx | 12 +- .../maintenance/content/_get-stats-python.mdx | 12 +- .../etl/content/_add-etl-csharp.mdx | 16 +- .../maintenance/etl/content/_add-etl-java.mdx | 8 +- .../etl/content/_add-etl-nodejs.mdx | 8 +- .../content/_get-identities-csharp.mdx | 4 +- .../content/_get-identities-nodejs.mdx | 4 +- .../content/_get-identities-php.mdx | 4 +- .../content/_get-identities-python.mdx | 4 +- .../_increment-next-identity-csharp.mdx | 4 +- .../_increment-next-identity-nodejs.mdx | 4 +- .../content/_increment-next-identity-php.mdx | 4 +- .../_increment-next-identity-python.mdx | 4 +- .../content/_seed-identity-csharp.mdx | 6 +- .../content/_seed-identity-nodejs.mdx | 6 +- .../identities/content/_seed-identity-php.mdx | 6 +- .../content/_seed-identity-python.mdx | 6 +- .../indexes/content/_delete-index-csharp.mdx | 4 +- .../content/_delete-index-errors-csharp.mdx | 6 +- .../content/_delete-index-errors-nodejs.mdx | 6 +- .../content/_delete-index-errors-php.mdx | 6 +- .../content/_delete-index-errors-python.mdx | 6 +- .../indexes/content/_delete-index-nodejs.mdx | 4 +- .../indexes/content/_delete-index-php.mdx | 4 +- .../indexes/content/_delete-index-python.mdx | 4 +- .../indexes/content/_disable-index-csharp.mdx | 20 +- .../indexes/content/_disable-index-nodejs.mdx | 20 +- .../indexes/content/_disable-index-php.mdx | 20 +- .../indexes/content/_disable-index-python.mdx | 20 +- .../indexes/content/_enable-index-csharp.mdx | 10 +- .../indexes/content/_enable-index-nodejs.mdx | 10 +- .../indexes/content/_enable-index-php.mdx | 10 +- .../indexes/content/_enable-index-python.mdx | 10 +- .../indexes/content/_get-index-csharp.mdx | 4 +- .../content/_get-index-errors-csharp.mdx | 6 +- .../content/_get-index-errors-nodejs.mdx | 6 +- .../indexes/content/_get-index-errors-php.mdx | 6 +- .../content/_get-index-errors-python.mdx | 6 +- .../content/_get-index-names-csharp.mdx | 4 +- .../content/_get-index-names-nodejs.mdx | 4 +- .../indexes/content/_get-index-names-php.mdx | 2 +- .../content/_get-index-names-python.mdx | 4 +- .../indexes/content/_get-index-nodejs.mdx | 4 +- .../indexes/content/_get-index-php.mdx | 4 +- .../indexes/content/_get-index-python.mdx | 4 +- .../indexes/content/_get-indexes-csharp.mdx | 4 +- .../indexes/content/_get-indexes-nodejs.mdx | 4 +- .../indexes/content/_get-indexes-php.mdx | 4 +- .../indexes/content/_get-indexes-python.mdx | 4 +- .../indexes/content/_get-terms-csharp.mdx | 4 +- .../indexes/content/_get-terms-nodejs.mdx | 4 +- .../indexes/content/_get-terms-php.mdx | 4 +- .../indexes/content/_get-terms-python.mdx | 4 +- .../content/_index-has-changed-csharp.mdx | 4 +- .../content/_index-has-changed-nodejs.mdx | 4 +- .../content/_index-has-changed-php.mdx | 4 +- .../content/_index-has-changed-python.mdx | 4 +- .../indexes/content/_put-indexes-csharp.mdx | 8 +- .../indexes/content/_put-indexes-nodejs.mdx | 6 +- .../indexes/content/_put-indexes-php.mdx | 8 +- .../indexes/content/_put-indexes-python.mdx | 8 +- .../indexes/content/_reset-index-php.mdx | 4 +- .../content/_set-index-lock-csharp.mdx | 10 +- .../content/_set-index-lock-nodejs.mdx | 10 +- .../indexes/content/_set-index-lock-php.mdx | 10 +- .../content/_set-index-lock-python.mdx | 10 +- .../content/_set-index-priority-csharp.mdx | 8 +- .../content/_set-index-priority-nodejs.mdx | 8 +- .../content/_set-index-priority-php.mdx | 8 +- .../content/_set-index-priority-python.mdx | 8 +- .../indexes/content/_start-index-csharp.mdx | 4 +- .../indexes/content/_start-index-nodejs.mdx | 4 +- .../indexes/content/_start-index-php.mdx | 4 +- .../indexes/content/_start-index-python.mdx | 4 +- .../content/_start-indexing-csharp.mdx | 4 +- .../content/_start-indexing-nodejs.mdx | 4 +- .../indexes/content/_start-indexing-php.mdx | 4 +- .../content/_start-indexing-python.mdx | 4 +- .../indexes/content/_stop-index-csharp.mdx | 6 +- .../indexes/content/_stop-index-nodejs.mdx | 6 +- .../indexes/content/_stop-index-php.mdx | 6 +- .../indexes/content/_stop-index-python.mdx | 6 +- .../indexes/content/_stop-indexing-csharp.mdx | 6 +- .../indexes/content/_stop-indexing-nodejs.mdx | 6 +- .../indexes/content/_stop-indexing-php.mdx | 6 +- .../indexes/content/_stop-indexing-python.mdx | 6 +- .../_ongoing-task-operations-csharp.mdx | 8 +- .../sorters/content/_put-sorter-csharp.mdx | 4 +- .../sorters/content/_put-sorter-nodejs.mdx | 4 +- .../patching/content/_set-based-csharp.mdx | 6 +- .../patching/content/_set-based-java.mdx | 6 +- .../patching/content/_set-based-nodejs.mdx | 32 ++-- .../content/_single-document-csharp.mdx | 58 +++--- .../content/_single-document-java.mdx | 6 +- .../content/_single-document-nodejs.mdx | 56 +++--- .../operations/patching/json-patch-syntax.mdx | 20 +- .../_put-client-certificate-csharp.mdx | 4 +- .../content/_put-client-certificate-java.mdx | 4 +- .../_put-client-certificate-nodejs.mdx | 4 +- ...serverwide-client-configuration-csharp.mdx | 2 +- ...serverwide-client-configuration-nodejs.mdx | 2 +- .../content/_add-database-node-csharp.mdx | 6 +- .../content/_add-database-node-nodejs.mdx | 6 +- .../content/_add-database-node-php.mdx | 6 +- .../content/_add-database-node-python.mdx | 6 +- .../content/_compact-database-csharp.mdx | 16 +- .../content/_compact-database-nodejs.mdx | 16 +- .../content/_compact-database-php.mdx | 16 +- .../content/_compact-database-python.mdx | 12 +- .../content/_create-database-csharp.mdx | 14 +- .../content/_create-database-java.mdx | 8 +- .../_toggle-databases-state-csharp.mdx | 8 +- .../_toggle-databases-state-nodejs.mdx | 8 +- .../content/_toggle-databases-state-php.mdx | 8 +- .../_toggle-databases-state-python.mdx | 8 +- .../_put-sorter-server-wide-csharp.mdx | 4 +- .../_put-sorter-server-wide-nodejs.mdx | 4 +- .../document-commands/batch-commands.mdx | 72 +++---- .../document-commands/delete-document.mdx | 6 +- .../document-commands/get-all-documents.mdx | 20 +- .../document-commands/get-documents-by-id.mdx | 24 +-- .../get-documents-by-prefix.mdx | 28 +-- .../document-commands/put-documents.mdx | 8 +- .../rest-api/queries/delete-by-query.mdx | 6 +- .../rest-api/queries/patch-by-query.mdx | 6 +- .../rest-api/queries/query-the-database.mdx | 16 +- .../client-api/rest-api/rest-api-intro.mdx | 8 +- .../_deserialization-security-csharp.mdx | 20 +- .../content/_atomic-guards-csharp.mdx | 12 +- .../content/_atomic-guards-nodejs.mdx | 12 +- .../content/_atomic-guards-php.mdx | 12 +- .../content/_atomic-guards-python.mdx | 12 +- .../content/_compare-exchange-csharp.mdx | 6 +- .../content/_compare-exchange-nodejs.mdx | 6 +- .../content/_compare-exchange-php.mdx | 6 +- .../content/_compare-exchange-python.mdx | 6 +- .../content/_overview-csharp.mdx | 4 +- .../content/_overview-nodejs.mdx | 4 +- .../content/_overview-php.mdx | 4 +- .../content/_overview-python.mdx | 4 +- .../_how-to-disable-tracking-csharp.mdx | 10 +- .../_how-to-disable-tracking-nodejs.mdx | 10 +- .../content/_how-to-disable-tracking-php.mdx | 8 +- .../_how-to-disable-tracking-python.mdx | 10 +- ...o-enable-optimistic-concurrency-csharp.mdx | 4 +- ...o-enable-optimistic-concurrency-nodejs.mdx | 4 +- ...w-to-enable-optimistic-concurrency-php.mdx | 4 +- ...o-enable-optimistic-concurrency-python.mdx | 4 +- .../content/_loading-entities-csharp.mdx | 14 +- .../content/_loading-entities-java.mdx | 14 +- .../content/_loading-entities-nodejs.mdx | 14 +- .../session/content/_loading-entities-php.mdx | 12 +- .../content/_loading-entities-python.mdx | 14 +- .../content/_opening-a-session-csharp.mdx | 8 +- .../content/_opening-a-session-nodejs.mdx | 8 +- .../content/_opening-a-session-php.mdx | 10 +- .../content/_opening-a-session-python.mdx | 8 +- .../content/_updating-entities-csharp.mdx | 4 +- .../content/_updating-entities-nodejs.mdx | 4 +- .../content/_updating-entities-php.mdx | 4 +- .../content/_updating-entities-python.mdx | 4 +- ...-a-session-and-how-does-it-work-csharp.mdx | 22 +-- ...is-a-session-and-how-does-it-work-java.mdx | 22 +-- ...-a-session-and-how-does-it-work-nodejs.mdx | 22 +-- ...-is-a-session-and-how-does-it-work-php.mdx | 22 +-- ...-a-session-and-how-does-it-work-python.mdx | 22 +-- .../_check-if-attachment-exists-csharp.mdx | 4 +- .../_check-if-attachment-exists-java.mdx | 4 +- .../_check-if-attachment-exists-nodejs.mdx | 4 +- .../_check-if-attachment-exists-php.mdx | 4 +- .../_check-if-attachment-exists-python.mdx | 4 +- .../_check-if-document-exists-csharp.mdx | 4 +- .../_check-if-document-exists-java.mdx | 4 +- .../_check-if-document-exists-nodejs.mdx | 4 +- .../content/_check-if-document-exists-php.mdx | 4 +- .../_check-if-document-exists-python.mdx | 4 +- .../_check-if-entity-has-changed-csharp.mdx | 6 +- .../_check-if-entity-has-changed-nodejs.mdx | 6 +- .../_check-if-entity-has-changed-php.mdx | 6 +- .../_check-if-entity-has-changed-python.mdx | 6 +- ...re-are-any-changes-on-a-session-csharp.mdx | 6 +- ...re-are-any-changes-on-a-session-nodejs.mdx | 6 +- ...there-are-any-changes-on-a-session-php.mdx | 6 +- ...re-are-any-changes-on-a-session-python.mdx | 6 +- .../content/_clear-a-session-csharp.mdx | 4 +- .../content/_clear-a-session-nodejs.mdx | 4 +- .../content/_defer-operations-csharp.mdx | 6 +- .../content/_defer-operations-nodejs.mdx | 6 +- .../how-to/content/_defer-operations-php.mdx | 6 +- .../content/_defer-operations-python.mdx | 6 +- .../_evict-entity-from-a-session-csharp.mdx | 10 +- .../_evict-entity-from-a-session-nodejs.mdx | 10 +- .../content/_get-entity-counters-csharp.mdx | 4 +- .../content/_get-entity-counters-nodejs.mdx | 4 +- .../content/_get-entity-counters-php.mdx | 4 +- .../content/_get-entity-counters-python.mdx | 4 +- .../content/_get-tracked-entities-csharp.mdx | 4 +- .../content/_get-tracked-entities-nodejs.mdx | 4 +- .../_perform-operations-lazily-csharp.mdx | 22 +-- .../_perform-operations-lazily-nodejs.mdx | 22 +-- .../_perform-operations-lazily-php.mdx | 22 +-- .../_perform-operations-lazily-python.mdx | 22 +-- .../content/_subscribe-to-events-csharp.mdx | 24 +-- .../content/_subscribe-to-events-java.mdx | 22 +-- .../content/_subscribe-to-events-nodejs.mdx | 22 +-- .../_how-to-count-query-results-csharp.mdx | 6 +- .../_how-to-count-query-results-nodejs.mdx | 4 +- .../_how-to-count-query-results-php.mdx | 4 +- .../_how-to-count-query-results-python.mdx | 4 +- .../_how-to-customize-query-csharp.mdx | 22 +-- .../content/_how-to-customize-query-java.mdx | 16 +- .../_how-to-customize-query-nodejs.mdx | 12 +- .../content/_how-to-customize-query-php.mdx | 16 +- .../_how-to-customize-query-python.mdx | 22 +-- .../_how-to-filter-by-field-csharp.mdx | 6 +- .../content/_how-to-filter-by-field-java.mdx | 4 +- .../_how-to-filter-by-field-nodejs.mdx | 6 +- .../content/_how-to-filter-by-field-php.mdx | 6 +- .../_how-to-filter-by-field-python.mdx | 6 +- ...to-filter-by-non-existing-field-csharp.mdx | 4 +- ...to-filter-by-non-existing-field-nodejs.mdx | 4 +- ...ow-to-filter-by-non-existing-field-php.mdx | 4 +- ...to-filter-by-non-existing-field-python.mdx | 4 +- .../_how-to-get-query-statistics-csharp.mdx | 4 +- .../_how-to-get-query-statistics-nodejs.mdx | 4 +- .../_how-to-get-query-statistics-php.mdx | 4 +- .../_how-to-get-query-statistics-python.mdx | 4 +- .../_how-to-make-a-spatial-query-csharp.mdx | 30 +-- .../_how-to-make-a-spatial-query-java.mdx | 6 +- .../_how-to-make-a-spatial-query-nodejs.mdx | 20 +- .../_how-to-make-a-spatial-query-python.mdx | 30 +-- .../_how-to-perform-group-by-query-python.mdx | 18 +- .../_how-to-perform-queries-lazily-csharp.mdx | 10 +- .../_how-to-perform-queries-lazily-nodejs.mdx | 10 +- .../_how-to-perform-queries-lazily-php.mdx | 10 +- .../_how-to-perform-queries-lazily-python.mdx | 10 +- .../_how-to-project-query-results-csharp.mdx | 16 +- .../_how-to-project-query-results-java.mdx | 4 +- .../_how-to-project-query-results-nodejs.mdx | 14 +- .../_how-to-project-query-results-php.mdx | 12 +- .../_how-to-project-query-results-python.mdx | 16 +- .../querying/content/_how-to-query-csharp.mdx | 32 ++-- .../querying/content/_how-to-query-nodejs.mdx | 30 +-- .../querying/content/_how-to-query-php.mdx | 34 ++-- .../querying/content/_how-to-query-python.mdx | 32 ++-- .../_how-to-stream-query-results-csharp.mdx | 24 +-- .../_how-to-stream-query-results-nodejs.mdx | 24 +-- .../_how-to-work-with-suggestions-csharp.mdx | 18 +- .../_how-to-work-with-suggestions-nodejs.mdx | 18 +- .../_how-to-work-with-suggestions-php.mdx | 14 +- .../_how-to-work-with-suggestions-python.mdx | 18 +- .../content/_sort-query-results-csharp.mdx | 24 +-- .../content/_sort-query-results-nodejs.mdx | 24 +-- .../content/_sort-query-results-php.mdx | 24 +-- .../content/_sort-query-results-python.mdx | 24 +-- .../content/_include-explanations-csharp.mdx | 6 +- .../content/_include-explanations-nodejs.mdx | 6 +- .../content/_include-explanations-php.mdx | 6 +- .../content/_include-explanations-python.mdx | 6 +- .../content/_query-timings-csharp.mdx | 8 +- .../debugging/content/_query-timings-java.mdx | 8 +- .../content/_query-timings-nodejs.mdx | 8 +- .../debugging/content/_query-timings-php.mdx | 8 +- .../content/_query-timings-python.mdx | 8 +- .../_query-vs-document-query-csharp.mdx | 6 +- .../content/_query-vs-document-query-php.mdx | 4 +- .../_query-vs-document-query-python.mdx | 6 +- .../_what-is-document-query-csharp.mdx | 8 +- .../content/_what-is-document-query-php.mdx | 6 +- .../_what-is-document-query-python.mdx | 6 +- .../content/_boost-search-results-csharp.mdx | 4 +- .../content/_boost-search-results-nodejs.mdx | 4 +- .../content/_boost-search-results-php.mdx | 4 +- .../content/_boost-search-results-python.mdx | 4 +- .../content/_ends-with-query-csharp.mdx | 4 +- .../content/_ends-with-query-nodejs.mdx | 6 +- .../content/_ends-with-query-php.mdx | 4 +- .../content/_ends-with-query-python.mdx | 4 +- .../content/_exact-match-query-csharp.mdx | 6 +- .../content/_exact-match-query-nodejs.mdx | 6 +- .../content/_exact-match-query-php.mdx | 6 +- .../content/_exact-match-query-python.mdx | 6 +- .../content/_full-text-search-csharp.mdx | 20 +- .../content/_full-text-search-nodejs.mdx | 12 +- .../content/_full-text-search-php.mdx | 20 +- .../content/_full-text-search-python.mdx | 20 +- .../content/_fuzzy-search-csharp.mdx | 4 +- .../content/_fuzzy-search-nodejs.mdx | 4 +- .../text-search/content/_fuzzy-search-php.mdx | 4 +- .../content/_fuzzy-search-python.mdx | 4 +- .../_highlight-query-results-csharp.mdx | 14 +- .../_highlight-query-results-nodejs.mdx | 14 +- .../content/_highlight-query-results-php.mdx | 14 +- .../_highlight-query-results-python.mdx | 14 +- .../content/_proximity-search-csharp.mdx | 8 +- .../content/_proximity-search-nodejs.mdx | 8 +- .../content/_proximity-search-php.mdx | 8 +- .../content/_proximity-search-python.mdx | 8 +- .../content/_starts-with-query-csharp.mdx | 4 +- .../content/_starts-with-query-nodejs.mdx | 6 +- .../content/_starts-with-query-php.mdx | 4 +- .../content/_starts-with-query-python.mdx | 4 +- .../session/querying/what-is-rql.mdx | 60 +++--- .../content/_what-is-smuggler-csharp.mdx | 8 +- .../content/_what-is-smuggler-java.mdx | 8 +- .../content/_what-is-smuggler-nodejs.mdx | 8 +- ...ed-documents-and-other-features-csharp.mdx | 18 +- .../content/_enable-data-archiving-csharp.mdx | 4 +- .../_schedule-document-archiving-csharp.mdx | 10 +- .../content/_unarchiving-documents-csharp.mdx | 8 +- .../version-6.2/data-archival/overview.mdx | 8 +- .../content/_bulk-insert-csharp.mdx | 6 +- .../content/_bulk-insert-nodejs.mdx | 6 +- .../content/_bulk-insert-python.mdx | 4 +- .../_copying-moving-renaming-nodejs.mdx | 8 +- .../attachments/content/_indexing-csharp.mdx | 12 +- .../attachments/content/_indexing-java.mdx | 6 +- .../attachments/content/_indexing-nodejs.mdx | 12 +- .../attachments/content/_indexing-php.mdx | 6 +- .../attachments/content/_indexing-python.mdx | 6 +- .../attachments/content/_loading-csharp.mdx | 4 +- .../_counters-and-other-features-csharp.mdx | 40 ++-- .../_counters-and-other-features-java.mdx | 38 ++-- .../_counters-and-other-features-nodejs.mdx | 40 ++-- .../_counters-and-other-features-php.mdx | 30 +-- .../_counters-and-other-features-python.mdx | 38 ++-- .../content/_create-or-modify-csharp.mdx | 6 +- .../content/_create-or-modify-java.mdx | 6 +- .../content/_create-or-modify-nodejs.mdx | 6 +- .../content/_create-or-modify-php.mdx | 6 +- .../content/_create-or-modify-python.mdx | 6 +- .../counters/content/_delete-csharp.mdx | 6 +- .../counters/content/_delete-java.mdx | 6 +- .../counters/content/_delete-nodejs.mdx | 6 +- .../counters/content/_delete-php.mdx | 6 +- .../counters/content/_delete-python.mdx | 6 +- .../content/_including-counters-csharp.mdx | 28 +-- .../content/_including-counters-nodejs.mdx | 28 +-- .../counters/content/_indexing-csharp.mdx | 8 +- .../counters/content/_indexing-java.mdx | 8 +- .../counters/content/_indexing-nodejs.mdx | 8 +- .../counters/content/_indexing-php.mdx | 6 +- .../counters/content/_indexing-python.mdx | 6 +- .../counters/content/_overview-csharp.mdx | 10 +- .../counters/content/_overview-java.mdx | 10 +- .../counters/content/_overview-nodejs.mdx | 10 +- .../counters/content/_overview-php.mdx | 10 +- .../counters/content/_overview-python.mdx | 10 +- .../_retrieve-counter-values-csharp.mdx | 18 +- .../content/_retrieve-counter-values-java.mdx | 18 +- .../_retrieve-counter-values-nodejs.mdx | 18 +- .../content/_retrieve-counter-values-php.mdx | 18 +- .../_retrieve-counter-values-python.mdx | 18 +- .../counters/counters-in-clusters.mdx | 20 +- .../overview-extensions.mdx | 4 +- .../client-api/content/_overview-csharp.mdx | 4 +- .../client-api/content/_overview-java.mdx | 4 +- .../client-api/content/_overview-nodejs.mdx | 4 +- .../client-api/content/_overview-php.mdx | 4 +- .../client-api/content/_overview-python.mdx | 4 +- .../content/_configure-revisions-csharp.mdx | 6 +- .../content/_configure-revisions-java.mdx | 18 +- .../content/_configure-revisions-nodejs.mdx | 6 +- .../content/_configure-revisions-php.mdx | 6 +- .../content/_configure-revisions-python.mdx | 6 +- ...onflict-revisions-configuration-csharp.mdx | 6 +- ...onflict-revisions-configuration-nodejs.mdx | 6 +- .../_conflict-revisions-configuration-php.mdx | 6 +- .../content/_delete-revisions-csharp.mdx | 10 +- .../content/_get-revisions-csharp.mdx | 6 +- .../content/_get-revisions-nodejs.mdx | 6 +- .../operations/content/_get-revisions-php.mdx | 6 +- .../content/_get-revisions-python.mdx | 6 +- .../session/content/_counting-csharp.mdx | 4 +- .../session/content/_counting-nodejs.mdx | 4 +- .../session/content/_counting-php.mdx | 4 +- .../session/content/_counting-python.mdx | 4 +- .../session/content/_including-csharp.mdx | 30 +-- .../session/content/_including-nodejs.mdx | 30 +-- .../session/content/_including-php.mdx | 30 +-- .../session/content/_loading-csharp.mdx | 8 +- .../session/content/_loading-nodejs.mdx | 8 +- .../session/content/_loading-php.mdx | 8 +- .../session/content/_loading-python.mdx | 8 +- .../revisions/content/_overview-csharp.mdx | 26 +-- .../revisions/content/_overview-nodejs.mdx | 26 +-- .../revisions/content/_overview-python.mdx | 26 +-- .../_revisions-and-other-features-csharp.mdx | 16 +- .../_revisions-and-other-features-nodejs.mdx | 16 +- .../_revisions-and-other-features-php.mdx | 14 +- .../_revisions-and-other-features-python.mdx | 16 +- ...documents-to-specific-revisions-csharp.mdx | 12 +- .../revert-documents-to-specific-time.mdx | 18 +- .../revisions/revisions-bin-cleaner.mdx | 12 +- .../revisions/troubleshooting.mdx | 2 +- .../content/_append-in-bulk-csharp.mdx | 16 +- .../content/_append-in-bulk-nodejs.mdx | 16 +- .../content/_javascript-support-csharp.mdx | 12 +- .../content/_javascript-support-nodejs.mdx | 12 +- .../_named-time-series-values-csharp.mdx | 12 +- .../_named-time-series-values-nodejs.mdx | 12 +- .../client-api/content/_overview-csharp.mdx | 8 +- .../client-api/content/_overview-nodejs.mdx | 8 +- .../content/_append-and-delete-csharp.mdx | 14 +- .../content/_append-and-delete-nodejs.mdx | 14 +- .../operations/content/_get-csharp.mdx | 12 +- .../operations/content/_get-nodejs.mdx | 12 +- .../operations/content/_patch-csharp.mdx | 16 +- .../operations/content/_patch-nodejs.mdx | 16 +- .../session/content/_append-csharp.mdx | 10 +- .../session/content/_append-nodejs.mdx | 10 +- .../session/content/_append-php.mdx | 8 +- .../session/content/_append-python.mdx | 10 +- .../session/content/_delete-csharp.mdx | 10 +- .../session/content/_delete-nodejs.mdx | 12 +- .../session/content/_delete-php.mdx | 4 +- .../session/content/_delete-python.mdx | 6 +- .../session/content/_patch-csharp.mdx | 10 +- .../session/content/_patch-nodejs.mdx | 10 +- .../client-api/session/content/_patch-php.mdx | 10 +- .../session/content/_patch-python.mdx | 10 +- .../session/content/_querying-csharp.mdx | 24 +-- .../session/content/_querying-nodejs.mdx | 18 +- .../get/content/_get-entries-csharp.mdx | 16 +- .../get/content/_get-entries-nodejs.mdx | 16 +- .../session/get/content/_get-entries-php.mdx | 16 +- .../get/content/_get-entries-python.mdx | 16 +- .../session/get/content/_get-names-csharp.mdx | 6 +- .../session/get/content/_get-names-nodejs.mdx | 6 +- .../session/get/content/_get-names-php.mdx | 6 +- .../session/get/content/_get-names-python.mdx | 6 +- .../content/_with-raw-queries-csharp.mdx | 4 +- .../content/_with-raw-queries-nodejs.mdx | 4 +- .../content/_with-session-load-csharp.mdx | 4 +- .../content/_with-session-load-nodejs.mdx | 4 +- .../content/_with-session-query-csharp.mdx | 4 +- .../content/_with-session-query-nodejs.mdx | 4 +- .../timeseries/content/_design-csharp.mdx | 24 +-- .../timeseries/content/_design-nodejs.mdx | 24 +-- .../timeseries/content/_indexing-csharp.mdx | 32 ++-- .../timeseries/content/_indexing-nodejs.mdx | 24 +-- .../timeseries/content/_indexing-php.mdx | 16 +- .../timeseries/content/_indexing-python.mdx | 16 +- .../content/_rollup-and-retention-csharp.mdx | 10 +- .../content/_rollup-and-retention-nodejs.mdx | 10 +- .../content/_rollup-and-retention-php.mdx | 10 +- .../content/_rollup-and-retention-python.mdx | 10 +- ..._time-series-and-other-features-csharp.mdx | 8 +- ..._time-series-and-other-features-nodejs.mdx | 8 +- .../client-api/javascript-support.mdx | 10 +- .../client-api/operations/get.mdx | 8 +- .../client-api/session/delete.mdx | 8 +- .../client-api/session/get.mdx | 6 +- .../client-api/session/increment.mdx | 8 +- .../client-api/session/overview.mdx | 6 +- .../incremental-time-series/overview.mdx | 6 +- .../timeseries/overview.mdx | 38 ++-- .../_aggregation-and-projections-csharp.mdx | 20 +- .../_aggregation-and-projections-nodejs.mdx | 16 +- .../_aggregation-and-projections-php.mdx | 16 +- .../content/_choosing-query-range-csharp.mdx | 12 +- .../content/_choosing-query-range-nodejs.mdx | 12 +- .../content/_choosing-query-range-php.mdx | 12 +- .../content/_choosing-query-range-python.mdx | 12 +- .../querying/content/_filtering-csharp.mdx | 6 +- .../querying/content/_filtering-nodejs.mdx | 6 +- .../querying/content/_filtering-php.mdx | 6 +- .../querying/content/_filtering-python.mdx | 6 +- .../querying/content/_gap-filling-csharp.mdx | 4 +- .../querying/content/_gap-filling-java.mdx | 4 +- .../querying/content/_gap-filling-nodejs.mdx | 4 +- .../content/_overview-and-syntax-csharp.mdx | 22 +-- .../content/_overview-and-syntax-nodejs.mdx | 22 +-- .../content/_overview-and-syntax-php.mdx | 22 +-- .../content/_overview-and-syntax-python.mdx | 22 +-- .../content/_stream-timeseries-csharp.mdx | 4 +- .../content/_stream-timeseries-java.mdx | 4 +- .../content/_using-indexes-csharp.mdx | 18 +- .../content/_using-indexes-nodejs.mdx | 16 +- .../querying/content/_using-indexes-php.mdx | 16 +- .../content/_using-indexes-python.mdx | 16 +- .../timeseries/querying/statistics.mdx | 10 +- .../indexes/additional-assemblies.mdx | 10 +- .../indexes/content/_boosting-csharp.mdx | 12 +- .../indexes/content/_boosting-java.mdx | 2 +- .../indexes/content/_boosting-nodejs.mdx | 12 +- .../indexes/content/_boosting-php.mdx | 12 +- .../_creating-and-deploying-csharp.mdx | 40 ++-- .../content/_creating-and-deploying-java.mdx | 32 ++-- .../_creating-and-deploying-nodejs.mdx | 40 ++-- .../content/_extending-indexes-csharp.mdx | 2 +- .../content/_extending-indexes-java.mdx | 2 +- .../content/_extending-indexes-nodejs.mdx | 2 +- ...ndexing-compare-exchange-values-csharp.mdx | 6 +- ..._indexing-compare-exchange-values-java.mdx | 6 +- ...ndexing-compare-exchange-values-nodejs.mdx | 6 +- .../_indexing-hierarchical-data-csharp.mdx | 8 +- .../_indexing-hierarchical-data-nodejs.mdx | 8 +- .../_indexing-hierarchical-data-php.mdx | 8 +- .../_indexing-hierarchical-data-python.mdx | 8 +- .../_indexing-linq-extensions-csharp.mdx | 10 +- .../_indexing-linq-extensions-java.mdx | 10 +- .../_indexing-linq-extensions-nodejs.mdx | 10 +- .../content/_indexing-metadata-csharp.mdx | 4 +- .../content/_indexing-metadata-java.mdx | 2 +- .../content/_indexing-metadata-nodejs.mdx | 4 +- .../content/_indexing-metadata-php.mdx | 4 +- .../content/_indexing-metadata-python.mdx | 4 +- .../content/_indexing-nested-data-csharp.mdx | 26 +-- .../content/_indexing-nested-data-nodejs.mdx | 26 +-- .../content/_indexing-nested-data-php.mdx | 26 +-- .../content/_indexing-nested-data-python.mdx | 26 +-- .../_indexing-polymorphic-data-csharp.mdx | 6 +- .../_indexing-polymorphic-data-java.mdx | 6 +- .../_indexing-polymorphic-data-nodejs.mdx | 10 +- .../_indexing-polymorphic-data-php.mdx | 6 +- .../_indexing-polymorphic-data-python.mdx | 6 +- .../_indexing-related-documents-csharp.mdx | 30 +-- .../_indexing-related-documents-nodejs.mdx | 26 +-- .../_indexing-related-documents-php.mdx | 30 +-- .../_indexing-related-documents-python.mdx | 30 +-- .../content/_indexing-spatial-data-csharp.mdx | 8 +- .../content/_indexing-spatial-data-nodejs.mdx | 8 +- .../content/_indexing-spatial-data-php.mdx | 8 +- .../content/_indexing-spatial-data-python.mdx | 8 +- .../content/_javascript-indexes-csharp.mdx | 16 +- .../indexes/content/_map-indexes-csharp.mdx | 12 +- .../indexes/content/_map-indexes-java.mdx | 8 +- .../indexes/content/_map-indexes-nodejs.mdx | 10 +- .../indexes/content/_map-indexes-php.mdx | 12 +- .../indexes/content/_map-indexes-python.mdx | 12 +- .../content/_map-reduce-indexes-csharp.mdx | 16 +- .../content/_map-reduce-indexes-java.mdx | 14 +- .../content/_map-reduce-indexes-nodejs.mdx | 10 +- .../content/_map-reduce-indexes-php.mdx | 14 +- .../content/_map-reduce-indexes-python.mdx | 16 +- .../content/_multi-map-indexes-csharp.mdx | 6 +- .../content/_multi-map-indexes-java.mdx | 6 +- .../content/_multi-map-indexes-nodejs.mdx | 6 +- .../content/_multi-map-indexes-php.mdx | 6 +- .../content/_multi-map-indexes-python.mdx | 6 +- .../_number-type-conversion-csharp.mdx | 4 +- .../content/_storing-data-in-index-csharp.mdx | 12 +- .../content/_storing-data-in-index-java.mdx | 2 +- .../content/_storing-data-in-index-nodejs.mdx | 2 +- .../content/_storing-data-in-index-php.mdx | 2 +- .../content/_storing-data-in-index-python.mdx | 2 +- .../content/_using-analyzers-csharp.mdx | 80 ++++---- .../indexes/content/_using-analyzers-java.mdx | 14 +- .../content/_using-analyzers-nodejs.mdx | 80 ++++---- .../content/_using-dynamic-fields-csharp.mdx | 30 +-- .../content/_using-dynamic-fields-java.mdx | 30 +-- .../content/_using-dynamic-fields-nodejs.mdx | 30 +-- .../content/_using-dynamic-fields-php.mdx | 30 +-- .../content/_using-dynamic-fields-python.mdx | 30 +-- .../content/_using-term-vectors-csharp.mdx | 6 +- .../content/_what-are-indexes-csharp.mdx | 16 +- .../content/_what-are-indexes-java.mdx | 16 +- .../content/_what-are-indexes-nodejs.mdx | 16 +- .../indexes/content/_what-are-indexes-php.mdx | 16 +- .../content/_what-are-indexes-python.mdx | 16 +- .../indexes/index-administration.mdx | 22 +-- .../version-6.2/indexes/index-throttling.mdx | 18 +- .../querying/content/_distinct-csharp.mdx | 8 +- .../querying/content/_distinct-java.mdx | 8 +- .../querying/content/_distinct-nodejs.mdx | 8 +- .../content/_exploration-queries-csharp.mdx | 22 +-- .../content/_exploration-queries-nodejs.mdx | 20 +- .../content/_exploration-queries-php.mdx | 26 +-- .../content/_exploration-queries-python.mdx | 26 +-- .../content/_faceted-search-csharp.mdx | 12 +- .../content/_faceted-search-nodejs.mdx | 12 +- .../querying/content/_faceted-search-php.mdx | 12 +- .../content/_faceted-search-python.mdx | 12 +- .../querying/content/_filtering-csharp.mdx | 16 +- .../querying/content/_filtering-nodejs.mdx | 22 +-- .../querying/content/_filtering-php.mdx | 20 +- .../querying/content/_filtering-python.mdx | 20 +- .../querying/content/_highlighting-csharp.mdx | 6 +- .../querying/content/_highlighting-nodejs.mdx | 6 +- .../querying/content/_highlighting-php.mdx | 6 +- .../querying/content/_highlighting-python.mdx | 6 +- .../content/_include-explanations-csharp.mdx | 6 +- .../content/_include-explanations-nodejs.mdx | 6 +- .../querying/content/_intersection-csharp.mdx | 2 +- .../querying/content/_intersection-java.mdx | 2 +- .../querying/content/_intersection-nodejs.mdx | 2 +- .../querying/content/_intersection-php.mdx | 2 +- .../querying/content/_intersection-python.mdx | 2 +- .../querying/content/_morelikethis-csharp.mdx | 10 +- .../querying/content/_morelikethis-java.mdx | 10 +- .../querying/content/_morelikethis-nodejs.mdx | 10 +- .../querying/content/_morelikethis-php.mdx | 10 +- .../querying/content/_morelikethis-python.mdx | 10 +- .../querying/content/_paging-csharp.mdx | 10 +- .../indexes/querying/content/_paging-java.mdx | 10 +- .../querying/content/_paging-nodejs.mdx | 10 +- .../indexes/querying/content/_paging-php.mdx | 10 +- .../querying/content/_paging-python.mdx | 10 +- .../querying/content/_projections-csharp.mdx | 18 +- .../querying/content/_projections-java.mdx | 4 +- .../querying/content/_projections-nodejs.mdx | 10 +- .../querying/content/_projections-php.mdx | 10 +- .../querying/content/_projections-python.mdx | 12 +- .../querying/content/_query-index-csharp.mdx | 10 +- .../querying/content/_query-index-nodejs.mdx | 6 +- .../querying/content/_query-index-php.mdx | 14 +- .../querying/content/_query-index-python.mdx | 8 +- .../querying/content/_searching-csharp.mdx | 24 +-- .../querying/content/_searching-nodejs.mdx | 24 +-- .../querying/content/_searching-php.mdx | 10 +- .../querying/content/_searching-python.mdx | 10 +- .../querying/content/_sorting-csharp.mdx | 6 +- .../querying/content/_sorting-nodejs.mdx | 6 +- .../indexes/querying/content/_sorting-php.mdx | 6 +- .../querying/content/_sorting-python.mdx | 6 +- .../querying/content/_spatial-csharp.mdx | 6 +- .../querying/content/_spatial-nodejs.mdx | 6 +- .../indexes/querying/content/_spatial-php.mdx | 6 +- .../querying/content/_spatial-python.mdx | 6 +- .../querying/content/_suggestions-csharp.mdx | 12 +- .../querying/content/_suggestions-nodejs.mdx | 12 +- .../querying/content/_suggestions-php.mdx | 12 +- .../querying/content/_suggestions-python.mdx | 12 +- .../indexes/rolling-index-deployment.mdx | 22 +-- .../indexes/search-engine/corax.mdx | 44 ++--- .../events-and-snapshots.mdx | 10 +- .../integrating-with-akka-persistence.mdx | 18 +- .../akka.net-persistence/queries.mdx | 14 +- .../postgresql-protocol/overview.mdx | 10 +- .../postgresql-protocol/power-bi.mdx | 8 +- .../version-6.2/integrations/terraform.mdx | 20 +- .../client-api/client-breaking-changes.mdx | 10 +- .../embedded/testdriver-breaking-changes.mdx | 2 +- .../migration/server/data-migration.mdx | 8 +- .../version-6.2/migration/server/docker.mdx | 10 +- .../server/server-breaking-changes.mdx | 6 +- .../monitoring/mib-generation.mdx | 6 +- .../monitoring/open-telemetry.mdx | 30 +-- .../administration/monitoring/prometheus.mdx | 14 +- .../administration/monitoring/telegraf.mdx | 6 +- .../administration/snmp/setup-zabbix.mdx | 20 +- .../administration/snmp/snmp-overview.mdx | 26 +-- .../server/clustering/cluster-api.mdx | 14 +- ...luster-best-practice-and-configuration.mdx | 4 +- .../clustering/cluster-transactions.mdx | 14 +- .../distribution/cluster-observer.mdx | 4 +- .../distribution/distributed-database.mdx | 14 +- .../distribution/highly-available-tasks.mdx | 14 +- .../clustering/rachis/cluster-topology.mdx | 16 +- .../rachis/consensus-operations.mdx | 8 +- .../replication/advanced-replication.mdx | 2 +- .../clustering/replication/change-vector.mdx | 18 +- .../replication-and-embedded-instance.mdx | 8 +- .../replication/replication-conflicts.mdx | 4 +- .../replication/replication-overview.mdx | 16 +- .../configuration/backup-configuration.mdx | 16 +- .../configuration/cluster-configuration.mdx | 46 ++--- .../configuration/configuration-options.mdx | 14 +- .../configuration/database-configuration.mdx | 30 +-- .../configuration/etl-configuration.mdx | 22 +-- .../configuration/http-configuration.mdx | 34 ++-- .../configuration/indexing-configuration.mdx | 156 ++++++++-------- .../configuration/license-configuration.mdx | 4 +- .../configuration/memory-configuration.mdx | 12 +- .../monitoring-configuration.mdx | 82 ++++---- .../configuration/patching-configuration.mdx | 6 +- .../performance-hints-configuration.mdx | 18 +- .../configuration/security-configuration.mdx | 108 +++++------ .../configuration/server-configuration.mdx | 12 +- .../subscription-configuration.mdx | 4 +- .../server/content/_embedded-csharp.mdx | 40 ++-- .../extensions/content/_expiration-csharp.mdx | 12 +- .../extensions/content/_expiration-nodejs.mdx | 8 +- .../extensions/content/_refresh-csharp.mdx | 10 +- .../extensions/content/_refresh-nodejs.mdx | 8 +- ..._document-identifier-generation-csharp.mdx | 56 +++--- .../server/kb/javascript-engine.mdx | 4 +- .../server/kb/numbers-in-ravendb.mdx | 12 +- .../server/ongoing-tasks/backup-overview.mdx | 24 +-- .../server/ongoing-tasks/etl/basics.mdx | 22 +-- .../ongoing-tasks/etl/elasticsearch.mdx | 40 ++-- .../server/ongoing-tasks/etl/olap.mdx | 12 +- .../etl/queue-etl/azure-queue.mdx | 22 +-- .../ongoing-tasks/etl/queue-etl/kafka.mdx | 40 ++-- .../ongoing-tasks/etl/queue-etl/overview.mdx | 18 +- .../ongoing-tasks/etl/queue-etl/rabbit-mq.mdx | 22 +-- .../server/ongoing-tasks/etl/raven.mdx | 74 ++++---- .../server/ongoing-tasks/etl/sql.mdx | 38 ++-- .../server/ongoing-tasks/etl/test-scripts.mdx | 4 +- .../ongoing-tasks/external-replication.mdx | 16 +- .../ongoing-tasks/hub-sink-replication.mdx | 16 +- .../queue-sink/kafka-queue-sink.mdx | 22 +-- .../ongoing-tasks/queue-sink/overview.mdx | 6 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 22 +-- .../security/audit-log/audit-log-overview.mdx | 6 +- .../certificate-configuration.mdx | 24 +-- .../authentication/certificate-management.mdx | 62 +++--- .../lets-encrypt-certificates.mdx | 2 +- .../recover-from-expired-certificate.mdx | 12 +- ...olve-cluster-certificate-renewal-issue.mdx | 10 +- .../security-clearance-and-permissions.mdx | 12 +- .../server/security/common-errors-and-faq.mdx | 52 +++--- .../encryption/encryption-at-rest.mdx | 2 +- .../encryption/secret-key-management.mdx | 4 +- .../content/_documents-compression-csharp.mdx | 10 +- .../content/_documents-compression-nodejs.mdx | 10 +- ...customizing-raven-data-files-locations.mdx | 12 +- .../server/storage/directory-structure.mdx | 4 +- .../server/storage/storage-engine.mdx | 10 +- .../version-6.2/server/tcp-compression.mdx | 8 +- .../server/troubleshooting/collect-info.mdx | 14 +- .../server/troubleshooting/debug-routes.mdx | 4 +- .../server/troubleshooting/traffic-watch.mdx | 4 +- .../administration/anchoring-documents.mdx | 8 +- .../sharding/administration/api-admin.mdx | 18 +- .../administration/sharding-by-prefix.mdx | 28 +-- .../sharding/administration/studio-admin.mdx | 8 +- .../sharding/backup-and-restore/backup.mdx | 26 +-- .../sharding/backup-and-restore/restore.mdx | 32 ++-- .../version-6.2/sharding/configuration.mdx | 8 +- .../sharding/document-extensions.mdx | 8 +- versioned_docs/version-6.2/sharding/etl.mdx | 18 +- .../sharding/external-replication.mdx | 10 +- .../sharding/import-and-export.mdx | 10 +- .../version-6.2/sharding/indexing.mdx | 6 +- .../version-6.2/sharding/migration.mdx | 6 +- .../version-6.2/sharding/overview.mdx | 34 ++-- .../version-6.2/sharding/querying.mdx | 42 ++--- .../version-6.2/sharding/resharding.mdx | 20 +- .../version-6.2/sharding/subscriptions.mdx | 4 +- .../version-6.2/sharding/unsupported.mdx | 20 +- .../start/containers/general-guide.mdx | 8 +- .../start/content/_test-driver-csharp.mdx | 16 +- .../start/content/_test-driver-java.mdx | 14 +- .../version-6.2/start/getting-started.mdx | 22 +-- .../start/guides/aws-lambda/overview.mdx | 20 +- .../content/_existing-project-csharp.mdx | 12 +- .../content/_existing-project-nodejs.mdx | 12 +- .../content/_overview-csharp.mdx | 18 +- .../content/_overview-nodejs.mdx | 18 +- .../guides/azure-functions/deployment.mdx | 2 +- .../cloudflare-workers/existing-project.mdx | 12 +- .../guides/cloudflare-workers/overview.mdx | 16 +- .../deployment-considerations.mdx | 12 +- .../start/installation/gnu-linux/deb.mdx | 28 +-- .../version-6.2/start/installation/manual.mdx | 10 +- .../start/installation/running-as-service.mdx | 10 +- .../setup-wizard/additional-settings.mdx | 6 +- .../setup-wizard/choose-security-option.mdx | 18 +- .../setup-wizard/choose-setup-method.mdx | 14 +- .../setup-wizard/configure-node-addresses.mdx | 14 +- .../setup-wizard/finish-setup.mdx | 14 +- .../installation/setup-wizard/overview.mdx | 8 +- .../setup-wizard/provide-license-key.mdx | 6 +- .../setup-wizard/review-setup.mdx | 2 +- .../setup-wizard/use-setup-package.mdx | 4 +- .../start/licensing/activate-license.mdx | 4 +- .../start/licensing/force-update.mdx | 2 +- .../start/licensing/license-under-docker.mdx | 14 +- .../start/licensing/licensing-overview.mdx | 16 +- .../start/licensing/renew-license.mdx | 4 +- .../start/licensing/replace-license.mdx | 8 +- .../cluster-dashboard-customize.mdx | 10 +- .../cluster-dashboard-overview.mdx | 6 +- .../cluster-dashboard-widgets.mdx | 20 +- .../studio/cluster/cluster-view.mdx | 14 +- .../studio/cluster/setting-a-cluster.mdx | 6 +- .../studio/database/code-assistance.mdx | 4 +- .../create-new-database/from-backup.mdx | 10 +- .../create-new-database/from-legacy-files.mdx | 4 +- .../create-new-database/general-flow.mdx | 12 +- .../studio/database/databases-list-view.mdx | 16 +- .../database/document-extensions/counters.mdx | 6 +- .../document-extensions/revisions.mdx | 12 +- .../document-extensions/time-series.mdx | 40 ++-- .../documents/compare-exchange-view.mdx | 4 +- .../documents/create-new-document.mdx | 14 +- .../database/documents/document-view.mdx | 4 +- .../documents/documents-and-collections.mdx | 2 +- .../database/documents/identities-view.mdx | 10 +- .../studio/database/documents/patch-view.mdx | 16 +- .../database/indexes/create-map-index.mdx | 26 +-- .../indexes/create-map-reduce-index.mdx | 18 +- .../indexes/create-multi-map-index.mdx | 4 +- .../studio/database/indexes/index-cleanup.mdx | 10 +- .../studio/database/indexes/index-history.mdx | 10 +- .../database/indexes/indexes-list-view.mdx | 12 +- .../database/indexes/indexes-overview.mdx | 28 +-- .../database/indexes/indexing-performance.mdx | 34 ++-- .../indexes/map-reduce-visualizer.mdx | 4 +- .../studio/database/queries/query-view.mdx | 14 +- .../queries/spatial-queries-map-view.mdx | 14 +- .../client-configuration-per-database.mdx | 2 +- .../database/settings/conflict-resolution.mdx | 4 +- .../database/settings/custom-analyzers.mdx | 14 +- .../database/settings/custom-sorters.mdx | 14 +- .../database/settings/database-record.mdx | 4 +- .../database/settings/database-settings.mdx | 16 +- .../database/settings/document-revisions.mdx | 30 +-- .../settings/documents-compression.mdx | 2 +- .../studio/database/settings/integrations.mdx | 2 +- .../settings/manage-database-group.mdx | 12 +- .../settings/studio-configuration.mdx | 12 +- .../settings/time-series-settings.mdx | 18 +- .../external-replication-stats.mdx | 4 +- .../ongoing-tasks-stats/olap-etl-stats.mdx | 4 +- .../stats/ongoing-tasks-stats/overview.mdx | 18 +- .../ongoing-tasks-stats/ravendb-etl-stats.mdx | 4 +- .../ongoing-tasks-stats/sql-etl-stats.mdx | 4 +- .../subscription-stats.mdx | 6 +- .../studio/database/stats/storage-report.mdx | 2 +- .../studio/database/tasks/backup-task.mdx | 50 ++--- .../database/tasks/create-sample-data.mdx | 4 +- .../studio/database/tasks/export-database.mdx | 6 +- .../tasks/import-data/import-data-file.mdx | 14 +- .../tasks/import-data/import-from-csv.mdx | 8 +- .../tasks/import-data/import-from-other.mdx | 10 +- .../tasks/import-data/import-from-ravendb.mdx | 2 +- .../tasks/import-data/import-from-sql.mdx | 40 ++-- .../ongoing-tasks/azure-queue-storage-etl.mdx | 14 +- .../ongoing-tasks/elasticsearch-etl-task.mdx | 24 +-- .../external-replication-task.mdx | 16 +- .../tasks/ongoing-tasks/general-info.mdx | 6 +- .../hub-sink-replication/overview.mdx | 12 +- .../replication-hub-task.mdx | 12 +- .../replication-sink-task.mdx | 14 +- .../tasks/ongoing-tasks/kafka-etl-task.mdx | 24 +-- .../tasks/ongoing-tasks/kafka-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/olap-etl-task.mdx | 20 +- .../tasks/ongoing-tasks/rabbitmq-etl-task.mdx | 8 +- .../ongoing-tasks/rabbitmq-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/ravendb-etl-task.mdx | 18 +- .../tasks/ongoing-tasks/subscription-task.mdx | 6 +- .../version-6.2/studio/overview.mdx | 16 +- .../certificates/read-only-access-level.mdx | 2 +- .../server-management-certificates-view.mdx | 16 +- .../studio/server/client-configuration.mdx | 2 +- .../studio/server/debug/admin-js-console.mdx | 6 +- .../debug/advanced/cluster-observer.mdx | 6 +- .../studio/server/manage-server.mdx | 6 +- .../studio/server/server-settings.mdx | 2 +- .../studio/server/server-wide-backup.mdx | 14 +- .../recovering-from-voron-errors.mdx | 2 +- .../ai-agents/ai-agents_configuration.mdx | 8 +- .../ai-agents/ai-agents_security-concerns.mdx | 10 +- .../_creating-ai-agents_api-csharp.mdx | 60 +++--- .../_creating-ai-agents_api-nodejs.mdx | 72 +++---- .../_creating-ai-agents_api-python.mdx | 60 +++--- .../creating-ai-agents_studio.mdx | 28 +-- .../ai-integration/ai-agents/overview.mdx | 30 +-- .../ai-integration/ai-tasks-list-view.mdx | 2 +- .../content/_azure-open-ai-csharp.mdx | 12 +- .../content/_azure-open-ai-nodejs.mdx | 12 +- .../content/_azure-open-ai-python.mdx | 12 +- .../content/_embedded-csharp.mdx | 6 +- .../content/_embedded-nodejs.mdx | 6 +- .../content/_embedded-python.mdx | 6 +- .../content/_google-ai-csharp.mdx | 6 +- .../content/_google-ai-nodejs.mdx | 6 +- .../content/_google-ai-python.mdx | 6 +- .../content/_hugging-face-csharp.mdx | 6 +- .../content/_hugging-face-nodejs.mdx | 6 +- .../content/_hugging-face-python.mdx | 6 +- .../content/_mistral-ai-csharp.mdx | 6 +- .../content/_mistral-ai-nodejs.mdx | 6 +- .../content/_mistral-ai-python.mdx | 6 +- .../content/_ollama-csharp.mdx | 12 +- .../content/_ollama-nodejs.mdx | 12 +- .../content/_ollama-python.mdx | 12 +- .../content/_open-ai-csharp.mdx | 12 +- .../content/_open-ai-nodejs.mdx | 12 +- .../content/_open-ai-python.mdx | 12 +- .../content/_vertex-ai-csharp.mdx | 6 +- .../content/_vertex-ai-nodejs.mdx | 6 +- .../content/_vertex-ai-python.mdx | 6 +- .../connection-strings/overview.mdx | 4 +- .../_create-gen-ai-task_api-csharp.mdx | 8 +- .../_create-gen-ai-task_api-nodejs.mdx | 10 +- .../_create-gen-ai-task_api-python.mdx | 8 +- .../create-gen-ai-task_studio.mdx | 30 +-- .../gen-ai-security-concerns.mdx | 2 +- .../_modify-gen-ai-task_api-csharp.mdx | 4 +- .../_modify-gen-ai-task_api-nodejs.mdx | 4 +- .../_modify-gen-ai-task_api-python.mdx | 4 +- .../gen-ai-integration/overview.mdx | 28 +-- .../_processing-attachments_api-csharp.mdx | 2 +- .../_processing-attachments_api-nodejs.mdx | 2 +- .../_processing-attachments_api-python.mdx | 2 +- .../processing-attachments_studio.mdx | 14 +- .../_embeddings-generation-task-csharp.mdx | 20 +- .../_embeddings-generation-task-nodejs.mdx | 20 +- .../content/_overview-csharp.mdx | 12 +- .../content/_overview-nodejs.mdx | 12 +- .../embedding-collections.mdx | 4 +- .../version-7.1/ai-integration/start.mdx | 2 +- .../_data-types-for-vector-search-csharp.mdx | 10 +- .../_data-types-for-vector-search-nodejs.mdx | 10 +- ...g-attachments-for-vector-search-csharp.mdx | 14 +- ...g-attachments-for-vector-search-nodejs.mdx | 12 +- ...g-attachments-for-vector-search-python.mdx | 12 +- ...ctor-search-using-dynamic-query-csharp.mdx | 66 +++---- ...ctor-search-using-dynamic-query-nodejs.mdx | 66 +++---- ...ctor-search-using-dynamic-query-python.mdx | 66 +++---- ...ector-search-using-static-index-csharp.mdx | 56 +++--- ...ector-search-using-static-index-nodejs.mdx | 48 ++--- ...ector-search-using-static-index-python.mdx | 48 ++--- .../ai-integration/vector-search/overview.mdx | 10 +- .../what-affects-vector-search-results.mdx | 18 +- ...work-with-bulk-insert-operation-csharp.mdx | 42 ++--- ...to-subscribe-to-counter-changes-csharp.mdx | 18 +- ...w-to-subscribe-to-counter-changes-java.mdx | 18 +- ...o-subscribe-to-document-changes-csharp.mdx | 18 +- ...-to-subscribe-to-document-changes-java.mdx | 18 +- ...o-subscribe-to-document-changes-nodejs.mdx | 18 +- ...w-to-subscribe-to-index-changes-csharp.mdx | 10 +- ...how-to-subscribe-to-index-changes-java.mdx | 10 +- ...w-to-subscribe-to-index-changes-nodejs.mdx | 10 +- ...-subscribe-to-operation-changes-csharp.mdx | 14 +- ...to-subscribe-to-operation-changes-java.mdx | 8 +- ...-subscribe-to-operation-changes-nodejs.mdx | 8 +- ...ubscribe-to-time-series-changes-csharp.mdx | 16 +- .../content/_what-is-changes-api-csharp.mdx | 18 +- .../content/_what-is-changes-api-java.mdx | 12 +- .../content/_what-is-changes-api-nodejs.mdx | 16 +- ...es-with-replication-and-cluster-csharp.mdx | 10 +- ...ates-with-replication-and-cluster-java.mdx | 10 +- ...es-with-replication-and-cluster-nodejs.mdx | 10 +- ...multiple-commands-using-a-batch-csharp.mdx | 6 +- ...multiple-commands-using-a-batch-nodejs.mdx | 6 +- .../commands/content/_overview-csharp.mdx | 12 +- .../commands/content/_overview-java.mdx | 6 +- .../commands/content/_overview-nodejs.mdx | 12 +- .../documents/content/_delete-csharp.mdx | 4 +- .../documents/content/_delete-nodejs.mdx | 4 +- .../documents/content/_delete-php.mdx | 4 +- .../documents/content/_delete-python.mdx | 4 +- .../documents/content/_get-csharp.mdx | 14 +- .../commands/documents/content/_get-java.mdx | 10 +- .../documents/content/_get-nodejs.mdx | 14 +- .../commands/documents/content/_get-php.mdx | 8 +- .../documents/content/_get-python.mdx | 8 +- .../documents/content/_put-csharp.mdx | 4 +- .../documents/content/_put-nodejs.mdx | 4 +- .../commands/documents/content/_put-php.mdx | 4 +- .../documents/content/_put-python.mdx | 4 +- .../content/_conventions-csharp.mdx | 126 ++++++------- .../content/_conventions-nodejs.mdx | 64 +++---- .../content/_deserialization-csharp.mdx | Bin 3578 -> 3313 bytes .../content/_serialization-csharp.mdx | 10 +- .../content/_load-balance-behavior-csharp.mdx | 14 +- .../content/_load-balance-behavior-nodejs.mdx | 14 +- .../content/_load-balance-behavior-php.mdx | 14 +- .../content/_load-balance-behavior-python.mdx | 14 +- .../content/_read-balance-behavior-csharp.mdx | 14 +- .../content/_read-balance-behavior-nodejs.mdx | 14 +- .../content/_read-balance-behavior-php.mdx | 14 +- .../content/_read-balance-behavior-python.mdx | 14 +- .../configuration/load-balance/overview.mdx | 12 +- .../_creating-document-store-csharp.mdx | 8 +- ...uthentication-and-authorization-csharp.mdx | 2 +- .../_setting-up-default-database-csharp.mdx | 4 +- .../_maintenance-operations-csharp.mdx | 14 +- .../content/_maintenance-operations-java.mdx | 10 +- .../_maintenance-operations-nodejs.mdx | 16 +- .../_subscription-with-revisioning-csharp.mdx | 14 +- .../_subscription-with-revisioning-java.mdx | 6 +- .../_subscription-with-revisioning-nodejs.mdx | 12 +- .../content/_api-overview-csharp.mdx | 22 +-- .../content/_api-overview-java.mdx | 16 +- .../content/_api-overview-nodejs.mdx | 22 +-- .../content/_api-overview-python.mdx | 14 +- .../consumption/content/_examples-csharp.mdx | 18 +- .../consumption/content/_examples-java.mdx | 14 +- .../consumption/content/_examples-nodejs.mdx | 14 +- .../consumption/content/_examples-python.mdx | 16 +- ...ow-to-consume-data-subscription-csharp.mdx | 18 +- ..._how-to-consume-data-subscription-java.mdx | 8 +- ...ow-to-consume-data-subscription-nodejs.mdx | 18 +- ...ow-to-consume-data-subscription-python.mdx | 18 +- .../_concurrent-subscriptions-csharp.mdx | 8 +- .../_concurrent-subscriptions-nodejs.mdx | 8 +- .../_what-are-data-subscriptions-csharp.mdx | 14 +- .../_what-are-data-subscriptions-java.mdx | 14 +- .../_what-are-data-subscriptions-nodejs.mdx | 14 +- .../creation/content/_api-overview-csharp.mdx | 22 +-- .../creation/content/_api-overview-nodejs.mdx | 28 +-- .../creation/content/_api-overview-python.mdx | 12 +- .../creation/content/_examples-csharp.mdx | 22 +-- .../creation/content/_examples-nodejs.mdx | 22 +-- .../creation/content/_examples-python.mdx | 18 +- ...how-to-create-data-subscription-csharp.mdx | 6 +- .../_how-to-create-data-subscription-java.mdx | 6 +- ...how-to-create-data-subscription-nodejs.mdx | 6 +- ...how-to-create-data-subscription-python.mdx | 6 +- .../content/_hilo-algorithm-csharp.mdx | 26 +-- ...rking-with-document-identifiers-csharp.mdx | 18 +- .../client-api/faq/backward-compatibility.mdx | 16 +- .../client-api/faq/transaction-support.mdx | 24 +-- .../client-api/faq/what-is-a-collection.mdx | 4 +- .../_handle-document-relationships-csharp.mdx | 16 +- .../_handle-document-relationships-nodejs.mdx | 16 +- .../_setup-aggressive-caching-csharp.mdx | 38 ++-- .../_setup-aggressive-caching-java.mdx | 38 ++-- .../how-to/integrate-with-excel.mdx | 2 +- .../how-to/subscribe-to-store-events.mdx | 24 +-- .../how-to/using-timeonly-and-dateonly.mdx | 14 +- .../content/_delete-attachment-nodejs.mdx | 4 +- .../content/_get-attachment-nodejs.mdx | 4 +- .../content/_put-attachment-nodejs.mdx | 4 +- .../content/_delete-by-query-csharp.mdx | 6 +- .../content/_delete-by-query-nodejs.mdx | 6 +- .../common/content/_delete-by-query-php.mdx | 6 +- .../content/_delete-by-query-python.mdx | 4 +- .../content/_what-are-operations-csharp.mdx | 24 +-- .../content/_what-are-operations-nodejs.mdx | 24 +-- .../content/_what-are-operations-php.mdx | 22 +-- .../content/_what-are-operations-python.mdx | 24 +-- ...-operations-to-a-different-node-csharp.mdx | 2 +- ...-operations-to-a-different-node-nodejs.mdx | 2 +- ...tch-operations-to-a-different-node-php.mdx | 2 +- .../maintenance/backup/backup-overview.mdx | 32 ++-- .../maintenance/backup/encrypted-backup.mdx | 32 ++-- .../operations/maintenance/backup/faq.mdx | 22 +-- .../operations/maintenance/backup/restore.mdx | 16 +- .../_database-settings-operation-csharp.mdx | 4 +- .../_database-settings-operation-nodejs.mdx | 4 +- .../_database-settings-operation-php.mdx | 4 +- .../_get-client-configuration-csharp.mdx | 4 +- .../_get-client-configuration-nodejs.mdx | 4 +- .../content/_get-client-configuration-php.mdx | 4 +- .../_get-client-configuration-python.mdx | 4 +- .../_put-client-configuration-csharp.mdx | 8 +- .../_put-client-configuration-nodejs.mdx | 8 +- .../content/_put-client-configuration-php.mdx | 8 +- .../_put-client-configuration-python.mdx | 8 +- .../content/_add-connection-string-csharp.mdx | 18 +- .../content/_get-connection-string-csharp.mdx | 6 +- .../_remove-connection-string-csharp.mdx | 4 +- .../maintenance/content/_get-stats-csharp.mdx | 12 +- .../maintenance/content/_get-stats-java.mdx | 12 +- .../maintenance/content/_get-stats-nodejs.mdx | 12 +- .../maintenance/content/_get-stats-php.mdx | 12 +- .../maintenance/content/_get-stats-python.mdx | 12 +- .../etl/content/_add-etl-csharp.mdx | 20 +- .../maintenance/etl/content/_add-etl-java.mdx | 8 +- .../etl/content/_add-etl-nodejs.mdx | 8 +- .../content/_get-identities-csharp.mdx | 4 +- .../content/_get-identities-nodejs.mdx | 4 +- .../content/_get-identities-php.mdx | 4 +- .../content/_get-identities-python.mdx | 4 +- .../_increment-next-identity-csharp.mdx | 4 +- .../_increment-next-identity-nodejs.mdx | 4 +- .../content/_increment-next-identity-php.mdx | 4 +- .../_increment-next-identity-python.mdx | 4 +- .../content/_seed-identity-csharp.mdx | 6 +- .../content/_seed-identity-nodejs.mdx | 6 +- .../identities/content/_seed-identity-php.mdx | 6 +- .../content/_seed-identity-python.mdx | 6 +- .../indexes/content/_delete-index-csharp.mdx | 4 +- .../content/_delete-index-errors-csharp.mdx | 6 +- .../content/_delete-index-errors-nodejs.mdx | 6 +- .../content/_delete-index-errors-php.mdx | 6 +- .../content/_delete-index-errors-python.mdx | 6 +- .../indexes/content/_delete-index-nodejs.mdx | 4 +- .../indexes/content/_delete-index-php.mdx | 4 +- .../indexes/content/_delete-index-python.mdx | 4 +- .../indexes/content/_disable-index-csharp.mdx | 20 +- .../indexes/content/_disable-index-nodejs.mdx | 20 +- .../indexes/content/_disable-index-php.mdx | 20 +- .../indexes/content/_disable-index-python.mdx | 20 +- .../indexes/content/_enable-index-csharp.mdx | 10 +- .../indexes/content/_enable-index-nodejs.mdx | 10 +- .../indexes/content/_enable-index-php.mdx | 10 +- .../indexes/content/_enable-index-python.mdx | 10 +- .../indexes/content/_get-index-csharp.mdx | 4 +- .../content/_get-index-errors-csharp.mdx | 6 +- .../content/_get-index-errors-nodejs.mdx | 6 +- .../indexes/content/_get-index-errors-php.mdx | 6 +- .../content/_get-index-errors-python.mdx | 6 +- .../content/_get-index-names-csharp.mdx | 4 +- .../content/_get-index-names-nodejs.mdx | 4 +- .../indexes/content/_get-index-names-php.mdx | 2 +- .../content/_get-index-names-python.mdx | 4 +- .../indexes/content/_get-index-nodejs.mdx | 4 +- .../indexes/content/_get-index-php.mdx | 4 +- .../indexes/content/_get-index-python.mdx | 4 +- .../indexes/content/_get-indexes-csharp.mdx | 4 +- .../indexes/content/_get-indexes-nodejs.mdx | 4 +- .../indexes/content/_get-indexes-php.mdx | 4 +- .../indexes/content/_get-indexes-python.mdx | 4 +- .../indexes/content/_get-terms-csharp.mdx | 4 +- .../indexes/content/_get-terms-nodejs.mdx | 4 +- .../indexes/content/_get-terms-php.mdx | 4 +- .../indexes/content/_get-terms-python.mdx | 4 +- .../content/_index-has-changed-csharp.mdx | 4 +- .../content/_index-has-changed-nodejs.mdx | 4 +- .../content/_index-has-changed-php.mdx | 4 +- .../content/_index-has-changed-python.mdx | 4 +- .../indexes/content/_put-indexes-csharp.mdx | 8 +- .../indexes/content/_put-indexes-nodejs.mdx | 6 +- .../indexes/content/_put-indexes-php.mdx | 8 +- .../indexes/content/_put-indexes-python.mdx | 8 +- .../indexes/content/_reset-index-php.mdx | 4 +- .../content/_set-index-lock-csharp.mdx | 10 +- .../content/_set-index-lock-nodejs.mdx | 10 +- .../indexes/content/_set-index-lock-php.mdx | 10 +- .../content/_set-index-lock-python.mdx | 10 +- .../content/_set-index-priority-csharp.mdx | 8 +- .../content/_set-index-priority-nodejs.mdx | 8 +- .../content/_set-index-priority-php.mdx | 8 +- .../content/_set-index-priority-python.mdx | 8 +- .../indexes/content/_start-index-csharp.mdx | 4 +- .../indexes/content/_start-index-nodejs.mdx | 4 +- .../indexes/content/_start-index-php.mdx | 4 +- .../indexes/content/_start-index-python.mdx | 4 +- .../content/_start-indexing-csharp.mdx | 4 +- .../content/_start-indexing-nodejs.mdx | 4 +- .../indexes/content/_start-indexing-php.mdx | 4 +- .../content/_start-indexing-python.mdx | 4 +- .../indexes/content/_stop-index-csharp.mdx | 6 +- .../indexes/content/_stop-index-nodejs.mdx | 6 +- .../indexes/content/_stop-index-php.mdx | 6 +- .../indexes/content/_stop-index-python.mdx | 6 +- .../indexes/content/_stop-indexing-csharp.mdx | 6 +- .../indexes/content/_stop-indexing-nodejs.mdx | 6 +- .../indexes/content/_stop-indexing-php.mdx | 6 +- .../indexes/content/_stop-indexing-python.mdx | 6 +- .../_ongoing-task-operations-csharp.mdx | 8 +- .../sorters/content/_put-sorter-csharp.mdx | 4 +- .../sorters/content/_put-sorter-nodejs.mdx | 4 +- .../patching/content/_set-based-csharp.mdx | 6 +- .../patching/content/_set-based-java.mdx | 6 +- .../patching/content/_set-based-nodejs.mdx | 32 ++-- .../content/_single-document-csharp.mdx | 58 +++--- .../content/_single-document-java.mdx | 6 +- .../content/_single-document-nodejs.mdx | 56 +++--- .../operations/patching/json-patch-syntax.mdx | 20 +- .../_put-client-certificate-csharp.mdx | 4 +- .../content/_put-client-certificate-java.mdx | 4 +- .../_put-client-certificate-nodejs.mdx | 4 +- ...serverwide-client-configuration-csharp.mdx | 2 +- ...serverwide-client-configuration-nodejs.mdx | 2 +- .../content/_add-database-node-csharp.mdx | 6 +- .../content/_add-database-node-nodejs.mdx | 6 +- .../content/_add-database-node-php.mdx | 6 +- .../content/_add-database-node-python.mdx | 6 +- .../content/_compact-database-csharp.mdx | 16 +- .../content/_compact-database-nodejs.mdx | 16 +- .../content/_compact-database-php.mdx | 16 +- .../content/_compact-database-python.mdx | 12 +- .../content/_create-database-csharp.mdx | 14 +- .../content/_create-database-java.mdx | 8 +- .../_toggle-databases-state-csharp.mdx | 8 +- .../_toggle-databases-state-nodejs.mdx | 8 +- .../content/_toggle-databases-state-php.mdx | 8 +- .../_toggle-databases-state-python.mdx | 8 +- .../_get-logs-configuration-csharp.mdx | 4 +- .../_set-logs-configuration-csharp.mdx | 8 +- .../_put-sorter-server-wide-csharp.mdx | 4 +- .../_put-sorter-server-wide-nodejs.mdx | 4 +- .../document-commands/batch-commands.mdx | 72 +++---- .../document-commands/delete-document.mdx | 6 +- .../document-commands/get-all-documents.mdx | 20 +- .../document-commands/get-documents-by-id.mdx | 24 +-- .../get-documents-by-prefix.mdx | 28 +-- .../document-commands/put-documents.mdx | 8 +- .../rest-api/queries/delete-by-query.mdx | 6 +- .../rest-api/queries/patch-by-query.mdx | 6 +- .../rest-api/queries/query-the-database.mdx | 16 +- .../client-api/rest-api/rest-api-intro.mdx | 8 +- .../_deserialization-security-csharp.mdx | 20 +- .../content/_overview-csharp.mdx | 4 +- .../content/_overview-nodejs.mdx | 4 +- .../content/_overview-php.mdx | 4 +- .../content/_overview-python.mdx | 4 +- .../_how-to-disable-tracking-csharp.mdx | 10 +- .../_how-to-disable-tracking-nodejs.mdx | 10 +- .../content/_how-to-disable-tracking-php.mdx | 8 +- .../_how-to-disable-tracking-python.mdx | 10 +- ...o-enable-optimistic-concurrency-csharp.mdx | 4 +- ...o-enable-optimistic-concurrency-nodejs.mdx | 4 +- ...w-to-enable-optimistic-concurrency-php.mdx | 4 +- ...o-enable-optimistic-concurrency-python.mdx | 4 +- .../content/_loading-entities-csharp.mdx | 14 +- .../content/_loading-entities-java.mdx | 14 +- .../content/_loading-entities-nodejs.mdx | 14 +- .../session/content/_loading-entities-php.mdx | 12 +- .../content/_loading-entities-python.mdx | 14 +- .../content/_opening-a-session-csharp.mdx | 8 +- .../content/_opening-a-session-nodejs.mdx | 8 +- .../content/_opening-a-session-php.mdx | 10 +- .../content/_opening-a-session-python.mdx | 8 +- .../content/_updating-entities-csharp.mdx | 4 +- .../content/_updating-entities-nodejs.mdx | 4 +- .../content/_updating-entities-php.mdx | 4 +- .../content/_updating-entities-python.mdx | 4 +- ...-a-session-and-how-does-it-work-csharp.mdx | 22 +-- ...is-a-session-and-how-does-it-work-java.mdx | 22 +-- ...-a-session-and-how-does-it-work-nodejs.mdx | 22 +-- ...-is-a-session-and-how-does-it-work-php.mdx | 22 +-- ...-a-session-and-how-does-it-work-python.mdx | 22 +-- .../_check-if-attachment-exists-csharp.mdx | 4 +- .../_check-if-attachment-exists-java.mdx | 4 +- .../_check-if-attachment-exists-nodejs.mdx | 4 +- .../_check-if-attachment-exists-php.mdx | 4 +- .../_check-if-attachment-exists-python.mdx | 4 +- .../_check-if-document-exists-csharp.mdx | 4 +- .../_check-if-document-exists-java.mdx | 4 +- .../_check-if-document-exists-nodejs.mdx | 4 +- .../content/_check-if-document-exists-php.mdx | 4 +- .../_check-if-document-exists-python.mdx | 4 +- .../_check-if-entity-has-changed-csharp.mdx | 6 +- .../_check-if-entity-has-changed-nodejs.mdx | 6 +- .../_check-if-entity-has-changed-php.mdx | 6 +- .../_check-if-entity-has-changed-python.mdx | 6 +- ...re-are-any-changes-on-a-session-csharp.mdx | 6 +- ...re-are-any-changes-on-a-session-nodejs.mdx | 6 +- ...there-are-any-changes-on-a-session-php.mdx | 6 +- ...re-are-any-changes-on-a-session-python.mdx | 6 +- .../content/_clear-a-session-csharp.mdx | 4 +- .../content/_clear-a-session-nodejs.mdx | 4 +- .../content/_defer-operations-csharp.mdx | 6 +- .../content/_defer-operations-nodejs.mdx | 6 +- .../how-to/content/_defer-operations-php.mdx | 6 +- .../content/_defer-operations-python.mdx | 6 +- .../_evict-entity-from-a-session-csharp.mdx | 10 +- .../_evict-entity-from-a-session-nodejs.mdx | 10 +- .../content/_get-entity-counters-csharp.mdx | 4 +- .../content/_get-entity-counters-nodejs.mdx | 4 +- .../content/_get-entity-counters-php.mdx | 4 +- .../content/_get-entity-counters-python.mdx | 4 +- .../content/_get-tracked-entities-csharp.mdx | 4 +- .../content/_get-tracked-entities-nodejs.mdx | 4 +- .../_perform-operations-lazily-csharp.mdx | 22 +-- .../_perform-operations-lazily-nodejs.mdx | 22 +-- .../_perform-operations-lazily-php.mdx | 22 +-- .../_perform-operations-lazily-python.mdx | 22 +-- .../content/_subscribe-to-events-csharp.mdx | 24 +-- .../content/_subscribe-to-events-java.mdx | 22 +-- .../content/_subscribe-to-events-nodejs.mdx | 22 +-- .../_how-to-count-query-results-csharp.mdx | 6 +- .../_how-to-count-query-results-nodejs.mdx | 4 +- .../_how-to-count-query-results-php.mdx | 4 +- .../_how-to-count-query-results-python.mdx | 4 +- .../_how-to-customize-query-csharp.mdx | 22 +-- .../content/_how-to-customize-query-java.mdx | 16 +- .../_how-to-customize-query-nodejs.mdx | 12 +- .../content/_how-to-customize-query-php.mdx | 16 +- .../_how-to-customize-query-python.mdx | 22 +-- .../_how-to-filter-by-field-csharp.mdx | 6 +- .../content/_how-to-filter-by-field-java.mdx | 4 +- .../_how-to-filter-by-field-nodejs.mdx | 6 +- .../content/_how-to-filter-by-field-php.mdx | 6 +- .../_how-to-filter-by-field-python.mdx | 6 +- ...to-filter-by-non-existing-field-csharp.mdx | 4 +- ...to-filter-by-non-existing-field-nodejs.mdx | 4 +- ...ow-to-filter-by-non-existing-field-php.mdx | 4 +- ...to-filter-by-non-existing-field-python.mdx | 4 +- .../_how-to-get-query-statistics-csharp.mdx | 4 +- .../_how-to-get-query-statistics-nodejs.mdx | 4 +- .../_how-to-get-query-statistics-php.mdx | 4 +- .../_how-to-get-query-statistics-python.mdx | 4 +- .../_how-to-make-a-spatial-query-csharp.mdx | 30 +-- .../_how-to-make-a-spatial-query-java.mdx | 6 +- .../_how-to-make-a-spatial-query-nodejs.mdx | 20 +- .../_how-to-make-a-spatial-query-python.mdx | 30 +-- .../_how-to-perform-group-by-query-python.mdx | 18 +- .../_how-to-perform-queries-lazily-csharp.mdx | 10 +- .../_how-to-perform-queries-lazily-nodejs.mdx | 10 +- .../_how-to-perform-queries-lazily-php.mdx | 10 +- .../_how-to-perform-queries-lazily-python.mdx | 10 +- .../_how-to-project-query-results-csharp.mdx | 16 +- .../_how-to-project-query-results-java.mdx | 4 +- .../_how-to-project-query-results-nodejs.mdx | 14 +- .../_how-to-project-query-results-php.mdx | 12 +- .../_how-to-project-query-results-python.mdx | 16 +- .../querying/content/_how-to-query-csharp.mdx | 32 ++-- .../querying/content/_how-to-query-nodejs.mdx | 30 +-- .../querying/content/_how-to-query-php.mdx | 34 ++-- .../querying/content/_how-to-query-python.mdx | 32 ++-- .../_how-to-stream-query-results-csharp.mdx | 24 +-- .../_how-to-stream-query-results-nodejs.mdx | 24 +-- .../_how-to-work-with-suggestions-csharp.mdx | 18 +- .../_how-to-work-with-suggestions-nodejs.mdx | 18 +- .../_how-to-work-with-suggestions-php.mdx | 14 +- .../_how-to-work-with-suggestions-python.mdx | 18 +- .../content/_sort-query-results-csharp.mdx | 24 +-- .../content/_sort-query-results-nodejs.mdx | 24 +-- .../content/_sort-query-results-php.mdx | 24 +-- .../content/_sort-query-results-python.mdx | 24 +-- .../content/_include-explanations-csharp.mdx | 6 +- .../content/_include-explanations-nodejs.mdx | 6 +- .../content/_include-explanations-php.mdx | 6 +- .../content/_include-explanations-python.mdx | 6 +- .../content/_query-timings-csharp.mdx | 8 +- .../debugging/content/_query-timings-java.mdx | 8 +- .../content/_query-timings-nodejs.mdx | 8 +- .../debugging/content/_query-timings-php.mdx | 8 +- .../content/_query-timings-python.mdx | 8 +- .../_query-vs-document-query-csharp.mdx | 6 +- .../content/_query-vs-document-query-php.mdx | 4 +- .../_query-vs-document-query-python.mdx | 6 +- .../_what-is-document-query-csharp.mdx | 8 +- .../content/_what-is-document-query-php.mdx | 6 +- .../_what-is-document-query-python.mdx | 6 +- .../content/_boost-search-results-csharp.mdx | 4 +- .../content/_boost-search-results-nodejs.mdx | 4 +- .../content/_boost-search-results-php.mdx | 4 +- .../content/_boost-search-results-python.mdx | 4 +- .../content/_ends-with-query-csharp.mdx | 4 +- .../content/_ends-with-query-nodejs.mdx | 6 +- .../content/_ends-with-query-php.mdx | 4 +- .../content/_ends-with-query-python.mdx | 4 +- .../content/_exact-match-query-csharp.mdx | 6 +- .../content/_exact-match-query-nodejs.mdx | 6 +- .../content/_exact-match-query-php.mdx | 6 +- .../content/_exact-match-query-python.mdx | 6 +- .../content/_full-text-search-csharp.mdx | 20 +- .../content/_full-text-search-nodejs.mdx | 12 +- .../content/_full-text-search-php.mdx | 20 +- .../content/_full-text-search-python.mdx | 20 +- .../content/_fuzzy-search-csharp.mdx | 4 +- .../content/_fuzzy-search-nodejs.mdx | 4 +- .../text-search/content/_fuzzy-search-php.mdx | 4 +- .../content/_fuzzy-search-python.mdx | 4 +- .../_highlight-query-results-csharp.mdx | 14 +- .../_highlight-query-results-nodejs.mdx | 14 +- .../content/_highlight-query-results-php.mdx | 14 +- .../_highlight-query-results-python.mdx | 14 +- .../content/_proximity-search-csharp.mdx | 8 +- .../content/_proximity-search-nodejs.mdx | 8 +- .../content/_proximity-search-php.mdx | 8 +- .../content/_proximity-search-python.mdx | 8 +- .../content/_starts-with-query-csharp.mdx | 4 +- .../content/_starts-with-query-nodejs.mdx | 6 +- .../content/_starts-with-query-php.mdx | 4 +- .../content/_starts-with-query-python.mdx | 4 +- .../session/querying/what-is-rql.mdx | 60 +++--- .../content/_what-is-smuggler-csharp.mdx | 8 +- .../content/_what-is-smuggler-java.mdx | 8 +- .../content/_what-is-smuggler-nodejs.mdx | 8 +- .../compare-exchange/configuration.mdx | 8 +- .../content/_atomic-guards-csharp.mdx | 12 +- .../content/_atomic-guards-nodejs.mdx | 12 +- .../content/_atomic-guards-php.mdx | 12 +- .../content/_atomic-guards-python.mdx | 12 +- .../_cmpxchg-in-dynamic-queries-csharp.mdx | 12 +- .../_cmpxchg-in-dynamic-queries-nodejs.mdx | 12 +- .../_cmpxchg-item-expiration-csharp.mdx | 6 +- .../_cmpxchg-item-expiration-nodejs.mdx | 6 +- .../content/_create-cmpxchg-items-csharp.mdx | 22 +-- .../content/_create-cmpxchg-items-java.mdx | 6 +- .../content/_create-cmpxchg-items-nodejs.mdx | 18 +- .../content/_create-cmpxchg-items-php.mdx | 6 +- .../content/_create-cmpxchg-items-python.mdx | 6 +- .../content/_delete-cmpxchg-items-csharp.mdx | 14 +- .../content/_delete-cmpxchg-items-java.mdx | 6 +- .../content/_delete-cmpxchg-items-nodejs.mdx | 14 +- .../content/_delete-cmpxchg-items-php.mdx | 10 +- .../content/_delete-cmpxchg-items-python.mdx | 10 +- .../content/_get-cmpxchg-item-csharp.mdx | 16 +- .../content/_get-cmpxchg-item-java.mdx | 8 +- .../content/_get-cmpxchg-item-nodejs.mdx | 16 +- .../content/_get-cmpxchg-item-php.mdx | 4 +- .../content/_get-cmpxchg-item-python.mdx | 4 +- .../content/_get-cmpxchg-items-csharp.mdx | 10 +- .../content/_get-cmpxchg-items-java.mdx | 6 +- .../content/_get-cmpxchg-items-nodejs.mdx | 10 +- .../content/_get-cmpxchg-items-php.mdx | 2 +- .../content/_get-cmpxchg-items-python.mdx | 2 +- ..._include-compare-exchange-items-csharp.mdx | 8 +- ..._include-compare-exchange-items-nodejs.mdx | 8 +- ...ndexing-compare-exchange-values-csharp.mdx | 10 +- ..._indexing-compare-exchange-values-java.mdx | 6 +- ...ndexing-compare-exchange-values-nodejs.mdx | 10 +- .../content/_overview-csharp.mdx | 18 +- .../content/_overview-java.mdx | 18 +- .../content/_overview-php.mdx | 18 +- .../content/_overview-python.mdx | 18 +- .../content/_update-cmpxchg-item-csharp.mdx | 8 +- .../content/_update-cmpxchg-item-java.mdx | 6 +- .../content/_update-cmpxchg-item-nodejs.mdx | 8 +- ...ed-documents-and-other-features-csharp.mdx | 20 +- .../content/_enable-data-archiving-csharp.mdx | 4 +- .../_schedule-document-archiving-csharp.mdx | 10 +- .../content/_unarchiving-documents-csharp.mdx | 8 +- .../version-7.1/data-archival/overview.mdx | 8 +- .../content/_bulk-insert-csharp.mdx | 6 +- .../content/_bulk-insert-nodejs.mdx | 6 +- .../content/_bulk-insert-python.mdx | 4 +- .../_copying-moving-renaming-nodejs.mdx | 8 +- .../attachments/content/_indexing-csharp.mdx | 12 +- .../attachments/content/_indexing-java.mdx | 6 +- .../attachments/content/_indexing-nodejs.mdx | 12 +- .../attachments/content/_indexing-php.mdx | 6 +- .../attachments/content/_indexing-python.mdx | 6 +- .../attachments/content/_loading-csharp.mdx | 4 +- .../_counters-and-other-features-csharp.mdx | 40 ++-- .../_counters-and-other-features-java.mdx | 38 ++-- .../_counters-and-other-features-nodejs.mdx | 40 ++-- .../_counters-and-other-features-php.mdx | 30 +-- .../_counters-and-other-features-python.mdx | 38 ++-- .../content/_create-or-modify-csharp.mdx | 6 +- .../content/_create-or-modify-java.mdx | 6 +- .../content/_create-or-modify-nodejs.mdx | 6 +- .../content/_create-or-modify-php.mdx | 6 +- .../content/_create-or-modify-python.mdx | 6 +- .../counters/content/_delete-csharp.mdx | 6 +- .../counters/content/_delete-java.mdx | 6 +- .../counters/content/_delete-nodejs.mdx | 6 +- .../counters/content/_delete-php.mdx | 6 +- .../counters/content/_delete-python.mdx | 6 +- .../content/_including-counters-csharp.mdx | 28 +-- .../content/_including-counters-nodejs.mdx | 28 +-- .../counters/content/_indexing-csharp.mdx | 8 +- .../counters/content/_indexing-java.mdx | 8 +- .../counters/content/_indexing-nodejs.mdx | 8 +- .../counters/content/_indexing-php.mdx | 6 +- .../counters/content/_indexing-python.mdx | 6 +- .../counters/content/_overview-csharp.mdx | 10 +- .../counters/content/_overview-java.mdx | 10 +- .../counters/content/_overview-nodejs.mdx | 10 +- .../counters/content/_overview-php.mdx | 10 +- .../counters/content/_overview-python.mdx | 10 +- .../_retrieve-counter-values-csharp.mdx | 18 +- .../content/_retrieve-counter-values-java.mdx | 18 +- .../_retrieve-counter-values-nodejs.mdx | 18 +- .../content/_retrieve-counter-values-php.mdx | 18 +- .../_retrieve-counter-values-python.mdx | 18 +- .../counters/counters-in-clusters.mdx | 20 +- .../overview-extensions.mdx | 4 +- .../client-api/content/_overview-csharp.mdx | 4 +- .../client-api/content/_overview-java.mdx | 4 +- .../client-api/content/_overview-nodejs.mdx | 4 +- .../client-api/content/_overview-php.mdx | 4 +- .../client-api/content/_overview-python.mdx | 4 +- .../content/_configure-revisions-csharp.mdx | 6 +- .../content/_configure-revisions-java.mdx | 18 +- .../content/_configure-revisions-nodejs.mdx | 6 +- .../content/_configure-revisions-php.mdx | 6 +- .../content/_configure-revisions-python.mdx | 6 +- ...onflict-revisions-configuration-csharp.mdx | 6 +- ...onflict-revisions-configuration-nodejs.mdx | 6 +- .../_conflict-revisions-configuration-php.mdx | 6 +- .../content/_delete-revisions-csharp.mdx | 10 +- .../content/_get-revisions-csharp.mdx | 6 +- .../content/_get-revisions-nodejs.mdx | 6 +- .../operations/content/_get-revisions-php.mdx | 6 +- .../content/_get-revisions-python.mdx | 6 +- .../session/content/_counting-csharp.mdx | 4 +- .../session/content/_counting-nodejs.mdx | 4 +- .../session/content/_counting-php.mdx | 4 +- .../session/content/_counting-python.mdx | 4 +- .../session/content/_including-csharp.mdx | 30 +-- .../session/content/_including-nodejs.mdx | 30 +-- .../session/content/_including-php.mdx | 30 +-- .../session/content/_loading-csharp.mdx | 8 +- .../session/content/_loading-nodejs.mdx | 8 +- .../session/content/_loading-php.mdx | 8 +- .../session/content/_loading-python.mdx | 8 +- .../revisions/content/_overview-csharp.mdx | 26 +-- .../revisions/content/_overview-nodejs.mdx | 26 +-- .../revisions/content/_overview-python.mdx | 26 +-- .../_revisions-and-other-features-csharp.mdx | 16 +- .../_revisions-and-other-features-nodejs.mdx | 16 +- .../_revisions-and-other-features-php.mdx | 14 +- .../_revisions-and-other-features-python.mdx | 16 +- ...documents-to-specific-revisions-csharp.mdx | 12 +- .../revert-documents-to-specific-time.mdx | 18 +- .../revisions/revisions-bin-cleaner.mdx | 12 +- .../revisions/troubleshooting.mdx | 2 +- .../content/_append-in-bulk-csharp.mdx | 16 +- .../content/_append-in-bulk-nodejs.mdx | 16 +- .../content/_javascript-support-csharp.mdx | 12 +- .../content/_javascript-support-nodejs.mdx | 12 +- .../_named-time-series-values-csharp.mdx | 12 +- .../_named-time-series-values-nodejs.mdx | 12 +- .../client-api/content/_overview-csharp.mdx | 8 +- .../client-api/content/_overview-nodejs.mdx | 8 +- .../content/_append-and-delete-csharp.mdx | 14 +- .../content/_append-and-delete-nodejs.mdx | 14 +- .../operations/content/_get-csharp.mdx | 12 +- .../operations/content/_get-nodejs.mdx | 12 +- .../operations/content/_patch-csharp.mdx | 16 +- .../operations/content/_patch-nodejs.mdx | 16 +- .../session/content/_append-csharp.mdx | 10 +- .../session/content/_append-nodejs.mdx | 10 +- .../session/content/_append-php.mdx | 8 +- .../session/content/_append-python.mdx | 10 +- .../session/content/_delete-csharp.mdx | 10 +- .../session/content/_delete-nodejs.mdx | 12 +- .../session/content/_delete-php.mdx | 4 +- .../session/content/_delete-python.mdx | 6 +- .../session/content/_patch-csharp.mdx | 10 +- .../session/content/_patch-nodejs.mdx | 10 +- .../client-api/session/content/_patch-php.mdx | 10 +- .../session/content/_patch-python.mdx | 10 +- .../session/content/_querying-csharp.mdx | 24 +-- .../session/content/_querying-nodejs.mdx | 18 +- .../get/content/_get-entries-csharp.mdx | 16 +- .../get/content/_get-entries-nodejs.mdx | 16 +- .../session/get/content/_get-entries-php.mdx | 16 +- .../get/content/_get-entries-python.mdx | 16 +- .../session/get/content/_get-names-csharp.mdx | 6 +- .../session/get/content/_get-names-nodejs.mdx | 6 +- .../session/get/content/_get-names-php.mdx | 6 +- .../session/get/content/_get-names-python.mdx | 6 +- .../content/_with-raw-queries-csharp.mdx | 4 +- .../content/_with-raw-queries-nodejs.mdx | 4 +- .../content/_with-session-load-csharp.mdx | 4 +- .../content/_with-session-load-nodejs.mdx | 4 +- .../content/_with-session-query-csharp.mdx | 4 +- .../content/_with-session-query-nodejs.mdx | 4 +- .../timeseries/content/_design-csharp.mdx | 24 +-- .../timeseries/content/_design-nodejs.mdx | 24 +-- .../timeseries/content/_indexing-csharp.mdx | 32 ++-- .../timeseries/content/_indexing-nodejs.mdx | 24 +-- .../timeseries/content/_indexing-php.mdx | 16 +- .../timeseries/content/_indexing-python.mdx | 16 +- .../content/_rollup-and-retention-csharp.mdx | 10 +- .../content/_rollup-and-retention-nodejs.mdx | 10 +- .../content/_rollup-and-retention-php.mdx | 10 +- .../content/_rollup-and-retention-python.mdx | 10 +- ..._time-series-and-other-features-csharp.mdx | 8 +- ..._time-series-and-other-features-nodejs.mdx | 8 +- .../client-api/javascript-support.mdx | 10 +- .../client-api/operations/get.mdx | 8 +- .../client-api/session/delete.mdx | 8 +- .../client-api/session/get.mdx | 6 +- .../client-api/session/increment.mdx | 8 +- .../client-api/session/overview.mdx | 6 +- .../incremental-time-series/overview.mdx | 6 +- .../timeseries/overview.mdx | 38 ++-- .../_aggregation-and-projections-csharp.mdx | 20 +- .../_aggregation-and-projections-nodejs.mdx | 16 +- .../_aggregation-and-projections-php.mdx | 16 +- .../content/_choosing-query-range-csharp.mdx | 12 +- .../content/_choosing-query-range-nodejs.mdx | 12 +- .../content/_choosing-query-range-php.mdx | 12 +- .../content/_choosing-query-range-python.mdx | 12 +- .../querying/content/_filtering-csharp.mdx | 6 +- .../querying/content/_filtering-nodejs.mdx | 6 +- .../querying/content/_filtering-php.mdx | 6 +- .../querying/content/_filtering-python.mdx | 6 +- .../querying/content/_gap-filling-csharp.mdx | 4 +- .../querying/content/_gap-filling-java.mdx | 4 +- .../querying/content/_gap-filling-nodejs.mdx | 4 +- .../content/_overview-and-syntax-csharp.mdx | 22 +-- .../content/_overview-and-syntax-nodejs.mdx | 22 +-- .../content/_overview-and-syntax-php.mdx | 22 +-- .../content/_overview-and-syntax-python.mdx | 22 +-- .../content/_stream-timeseries-csharp.mdx | 4 +- .../content/_stream-timeseries-java.mdx | 4 +- .../content/_using-indexes-csharp.mdx | 18 +- .../content/_using-indexes-nodejs.mdx | 16 +- .../querying/content/_using-indexes-php.mdx | 16 +- .../content/_using-indexes-python.mdx | 16 +- .../timeseries/querying/statistics.mdx | 10 +- .../indexes/additional-assemblies.mdx | 10 +- .../indexes/content/_boosting-csharp.mdx | 12 +- .../indexes/content/_boosting-java.mdx | 2 +- .../indexes/content/_boosting-nodejs.mdx | 12 +- .../indexes/content/_boosting-php.mdx | 12 +- .../_creating-and-deploying-csharp.mdx | 40 ++-- .../content/_creating-and-deploying-java.mdx | 32 ++-- .../_creating-and-deploying-nodejs.mdx | 40 ++-- .../content/_extending-indexes-csharp.mdx | 2 +- .../content/_extending-indexes-java.mdx | 2 +- .../content/_extending-indexes-nodejs.mdx | 2 +- .../_indexing-hierarchical-data-csharp.mdx | 8 +- .../_indexing-hierarchical-data-nodejs.mdx | 8 +- .../_indexing-hierarchical-data-php.mdx | 8 +- .../_indexing-hierarchical-data-python.mdx | 8 +- .../_indexing-linq-extensions-csharp.mdx | 10 +- .../_indexing-linq-extensions-java.mdx | 10 +- .../_indexing-linq-extensions-nodejs.mdx | 10 +- .../content/_indexing-metadata-csharp.mdx | 4 +- .../content/_indexing-metadata-java.mdx | 2 +- .../content/_indexing-metadata-nodejs.mdx | 4 +- .../content/_indexing-metadata-php.mdx | 4 +- .../content/_indexing-metadata-python.mdx | 4 +- .../content/_indexing-nested-data-csharp.mdx | 26 +-- .../content/_indexing-nested-data-nodejs.mdx | 26 +-- .../content/_indexing-nested-data-php.mdx | 26 +-- .../content/_indexing-nested-data-python.mdx | 26 +-- .../_indexing-polymorphic-data-csharp.mdx | 6 +- .../_indexing-polymorphic-data-java.mdx | 6 +- .../_indexing-polymorphic-data-nodejs.mdx | 10 +- .../_indexing-polymorphic-data-php.mdx | 6 +- .../_indexing-polymorphic-data-python.mdx | 6 +- .../_indexing-related-documents-csharp.mdx | 30 +-- .../_indexing-related-documents-nodejs.mdx | 26 +-- .../_indexing-related-documents-php.mdx | 30 +-- .../_indexing-related-documents-python.mdx | 30 +-- .../content/_indexing-spatial-data-csharp.mdx | 8 +- .../content/_indexing-spatial-data-nodejs.mdx | 8 +- .../content/_indexing-spatial-data-php.mdx | 8 +- .../content/_indexing-spatial-data-python.mdx | 8 +- .../content/_javascript-indexes-csharp.mdx | 16 +- .../indexes/content/_map-indexes-csharp.mdx | 12 +- .../indexes/content/_map-indexes-java.mdx | 8 +- .../indexes/content/_map-indexes-nodejs.mdx | 10 +- .../indexes/content/_map-indexes-php.mdx | 12 +- .../indexes/content/_map-indexes-python.mdx | 12 +- .../content/_map-reduce-indexes-csharp.mdx | 16 +- .../content/_map-reduce-indexes-java.mdx | 14 +- .../content/_map-reduce-indexes-nodejs.mdx | 10 +- .../content/_map-reduce-indexes-php.mdx | 14 +- .../content/_map-reduce-indexes-python.mdx | 16 +- .../content/_multi-map-indexes-csharp.mdx | 6 +- .../content/_multi-map-indexes-java.mdx | 6 +- .../content/_multi-map-indexes-nodejs.mdx | 6 +- .../content/_multi-map-indexes-php.mdx | 6 +- .../content/_multi-map-indexes-python.mdx | 6 +- .../_number-type-conversion-csharp.mdx | 4 +- .../content/_storing-data-in-index-csharp.mdx | 12 +- .../content/_storing-data-in-index-java.mdx | 2 +- .../content/_storing-data-in-index-nodejs.mdx | 2 +- .../content/_storing-data-in-index-php.mdx | 2 +- .../content/_storing-data-in-index-python.mdx | 2 +- .../content/_using-analyzers-csharp.mdx | 80 ++++---- .../indexes/content/_using-analyzers-java.mdx | 14 +- .../content/_using-analyzers-nodejs.mdx | 80 ++++---- .../content/_using-dynamic-fields-csharp.mdx | 30 +-- .../content/_using-dynamic-fields-java.mdx | 30 +-- .../content/_using-dynamic-fields-nodejs.mdx | 30 +-- .../content/_using-dynamic-fields-php.mdx | 30 +-- .../content/_using-dynamic-fields-python.mdx | 30 +-- .../content/_using-term-vectors-csharp.mdx | 6 +- .../content/_what-are-indexes-csharp.mdx | 16 +- .../content/_what-are-indexes-java.mdx | 16 +- .../content/_what-are-indexes-nodejs.mdx | 16 +- .../indexes/content/_what-are-indexes-php.mdx | 16 +- .../content/_what-are-indexes-python.mdx | 16 +- .../indexes/index-administration.mdx | 22 +-- .../version-7.1/indexes/index-throttling.mdx | 18 +- .../querying/content/_distinct-csharp.mdx | 8 +- .../querying/content/_distinct-java.mdx | 8 +- .../querying/content/_distinct-nodejs.mdx | 8 +- .../content/_exploration-queries-csharp.mdx | 22 +-- .../content/_exploration-queries-nodejs.mdx | 20 +- .../content/_exploration-queries-php.mdx | 26 +-- .../content/_exploration-queries-python.mdx | 26 +-- .../content/_faceted-search-csharp.mdx | 12 +- .../content/_faceted-search-nodejs.mdx | 12 +- .../querying/content/_faceted-search-php.mdx | 12 +- .../content/_faceted-search-python.mdx | 12 +- .../querying/content/_filtering-csharp.mdx | 16 +- .../querying/content/_filtering-nodejs.mdx | 22 +-- .../querying/content/_filtering-php.mdx | 20 +- .../querying/content/_filtering-python.mdx | 20 +- .../querying/content/_highlighting-csharp.mdx | 6 +- .../querying/content/_highlighting-nodejs.mdx | 6 +- .../querying/content/_highlighting-php.mdx | 6 +- .../querying/content/_highlighting-python.mdx | 6 +- .../content/_include-explanations-csharp.mdx | 6 +- .../content/_include-explanations-nodejs.mdx | 6 +- .../querying/content/_intersection-csharp.mdx | 2 +- .../querying/content/_intersection-java.mdx | 2 +- .../querying/content/_intersection-nodejs.mdx | 2 +- .../querying/content/_intersection-php.mdx | 2 +- .../querying/content/_intersection-python.mdx | 2 +- .../querying/content/_morelikethis-csharp.mdx | 10 +- .../querying/content/_morelikethis-java.mdx | 10 +- .../querying/content/_morelikethis-nodejs.mdx | 10 +- .../querying/content/_morelikethis-php.mdx | 10 +- .../querying/content/_morelikethis-python.mdx | 10 +- .../querying/content/_paging-csharp.mdx | 10 +- .../indexes/querying/content/_paging-java.mdx | 10 +- .../querying/content/_paging-nodejs.mdx | 10 +- .../indexes/querying/content/_paging-php.mdx | 10 +- .../querying/content/_paging-python.mdx | 10 +- .../querying/content/_projections-csharp.mdx | 18 +- .../querying/content/_projections-java.mdx | 4 +- .../querying/content/_projections-nodejs.mdx | 10 +- .../querying/content/_projections-php.mdx | 10 +- .../querying/content/_projections-python.mdx | 12 +- .../querying/content/_query-index-csharp.mdx | 10 +- .../querying/content/_query-index-nodejs.mdx | 6 +- .../querying/content/_query-index-php.mdx | 14 +- .../querying/content/_query-index-python.mdx | 8 +- .../querying/content/_searching-csharp.mdx | 24 +-- .../querying/content/_searching-nodejs.mdx | 24 +-- .../querying/content/_searching-php.mdx | 10 +- .../querying/content/_searching-python.mdx | 10 +- .../querying/content/_sorting-csharp.mdx | 6 +- .../querying/content/_sorting-nodejs.mdx | 6 +- .../indexes/querying/content/_sorting-php.mdx | 6 +- .../querying/content/_sorting-python.mdx | 6 +- .../querying/content/_spatial-csharp.mdx | 6 +- .../querying/content/_spatial-nodejs.mdx | 6 +- .../indexes/querying/content/_spatial-php.mdx | 6 +- .../querying/content/_spatial-python.mdx | 6 +- .../querying/content/_suggestions-csharp.mdx | 12 +- .../querying/content/_suggestions-nodejs.mdx | 12 +- .../querying/content/_suggestions-php.mdx | 12 +- .../querying/content/_suggestions-python.mdx | 12 +- .../indexes/rolling-index-deployment.mdx | 22 +-- .../indexes/search-engine/corax.mdx | 44 ++--- .../events-and-snapshots.mdx | 10 +- .../integrating-with-akka-persistence.mdx | 18 +- .../akka.net-persistence/queries.mdx | 14 +- .../postgresql-protocol/overview.mdx | 10 +- .../postgresql-protocol/power-bi.mdx | 8 +- .../version-7.1/integrations/terraform.mdx | 20 +- .../client-api/client-breaking-changes.mdx | 12 +- .../migration/client-api/client-migration.mdx | 2 +- .../embedded/testdriver-breaking-changes.mdx | 2 +- .../migration/server/data-migration.mdx | 10 +- .../version-7.1/migration/server/docker.mdx | 10 +- .../server/server-breaking-changes.mdx | 6 +- .../version-7.1/server/administration/cli.mdx | 36 ++-- .../monitoring/mib-generation.mdx | 6 +- .../monitoring/open-telemetry.mdx | 30 +-- .../administration/monitoring/prometheus.mdx | 14 +- .../administration/monitoring/telegraf.mdx | 6 +- .../administration/snmp/setup-zabbix.mdx | 20 +- .../administration/snmp/snmp-overview.mdx | 38 ++-- .../server/clustering/cluster-api.mdx | 14 +- ...luster-best-practice-and-configuration.mdx | 4 +- .../clustering/cluster-transactions.mdx | 14 +- .../distribution/cluster-observer.mdx | 4 +- .../distribution/distributed-database.mdx | 14 +- .../distribution/highly-available-tasks.mdx | 14 +- .../clustering/rachis/cluster-topology.mdx | 16 +- .../rachis/consensus-operations.mdx | 8 +- .../replication/advanced-replication.mdx | 2 +- .../clustering/replication/change-vector.mdx | 18 +- .../replication-and-embedded-instance.mdx | 8 +- .../replication/replication-conflicts.mdx | 4 +- .../replication/replication-overview.mdx | 16 +- .../ai-integration-configuration.mdx | 18 +- .../configuration/backup-configuration.mdx | 16 +- .../configuration/cluster-configuration.mdx | 46 ++--- .../configuration/configuration-options.mdx | 14 +- .../configuration/database-configuration.mdx | 30 +-- .../configuration/etl-configuration.mdx | 22 +-- .../configuration/http-configuration.mdx | 34 ++-- .../configuration/indexing-configuration.mdx | 172 ++++++++--------- .../configuration/license-configuration.mdx | 4 +- .../configuration/logs-configuration.mdx | 36 ++-- .../configuration/memory-configuration.mdx | 12 +- .../monitoring-configuration.mdx | 82 ++++---- .../configuration/patching-configuration.mdx | 6 +- .../performance-hints-configuration.mdx | 18 +- .../configuration/security-configuration.mdx | 108 +++++------ .../configuration/server-configuration.mdx | 12 +- .../subscription-configuration.mdx | 4 +- .../server/content/_embedded-csharp.mdx | 40 ++-- .../extensions/content/_expiration-csharp.mdx | 12 +- .../extensions/content/_refresh-csharp.mdx | 10 +- ..._document-identifier-generation-csharp.mdx | 56 +++--- .../server/kb/javascript-engine.mdx | 4 +- .../server/kb/numbers-in-ravendb.mdx | 12 +- .../server/ongoing-tasks/backup-overview.mdx | 24 +-- .../server/ongoing-tasks/etl/basics.mdx | 22 +-- .../ongoing-tasks/etl/elasticsearch.mdx | 40 ++-- .../server/ongoing-tasks/etl/olap.mdx | 12 +- .../etl/queue-etl/amazon-sqs.mdx | 34 ++-- .../etl/queue-etl/azure-queue.mdx | 22 +-- .../ongoing-tasks/etl/queue-etl/kafka.mdx | 40 ++-- .../ongoing-tasks/etl/queue-etl/overview.mdx | 18 +- .../ongoing-tasks/etl/queue-etl/rabbit-mq.mdx | 22 +-- .../server/ongoing-tasks/etl/raven.mdx | 74 ++++---- .../server/ongoing-tasks/etl/snowflake.mdx | 28 +-- .../server/ongoing-tasks/etl/sql.mdx | 38 ++-- .../server/ongoing-tasks/etl/test-scripts.mdx | 4 +- .../ongoing-tasks/external-replication.mdx | 16 +- .../ongoing-tasks/hub-sink-replication.mdx | 16 +- .../queue-sink/kafka-queue-sink.mdx | 22 +-- .../ongoing-tasks/queue-sink/overview.mdx | 6 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 22 +-- .../security/audit-log/audit-log-overview.mdx | 6 +- .../certificate-configuration.mdx | 24 +-- .../authentication/certificate-management.mdx | 62 +++--- .../lets-encrypt-certificates.mdx | 2 +- .../recover-from-expired-certificate.mdx | 12 +- ...olve-cluster-certificate-renewal-issue.mdx | 10 +- .../security-clearance-and-permissions.mdx | 12 +- .../server/security/common-errors-and-faq.mdx | 52 +++--- .../encryption/encryption-at-rest.mdx | 2 +- .../encryption/secret-key-management.mdx | 4 +- .../content/_documents-compression-csharp.mdx | 10 +- .../content/_documents-compression-nodejs.mdx | 10 +- ...customizing-raven-data-files-locations.mdx | 12 +- .../server/storage/directory-structure.mdx | 4 +- .../server/storage/storage-engine.mdx | 10 +- .../version-7.1/server/tcp-compression.mdx | 8 +- .../server/troubleshooting/collect-info.mdx | 14 +- .../server/troubleshooting/debug-routes.mdx | 4 +- .../server/troubleshooting/logging.mdx | 52 +++--- .../server/troubleshooting/traffic-watch.mdx | 4 +- .../administration/anchoring-documents.mdx | 8 +- .../sharding/administration/api-admin.mdx | 18 +- .../administration/sharding-by-prefix.mdx | 28 +-- .../sharding/administration/studio-admin.mdx | 8 +- .../sharding/backup-and-restore/backup.mdx | 26 +-- .../sharding/backup-and-restore/restore.mdx | 32 ++-- .../version-7.1/sharding/configuration.mdx | 8 +- .../sharding/document-extensions.mdx | 8 +- versioned_docs/version-7.1/sharding/etl.mdx | 18 +- .../sharding/external-replication.mdx | 10 +- .../sharding/import-and-export.mdx | 10 +- .../version-7.1/sharding/indexing.mdx | 6 +- .../version-7.1/sharding/migration.mdx | 6 +- .../version-7.1/sharding/overview.mdx | 34 ++-- .../version-7.1/sharding/querying.mdx | 42 ++--- .../version-7.1/sharding/resharding.mdx | 20 +- .../version-7.1/sharding/subscriptions.mdx | 4 +- .../version-7.1/sharding/unsupported.mdx | 20 +- .../start/containers/general-guide.mdx | 8 +- .../start/content/_test-driver-csharp.mdx | 22 +-- .../start/content/_test-driver-java.mdx | 14 +- .../version-7.1/start/getting-started.mdx | 22 +-- .../start/guides/aws-lambda/overview.mdx | 20 +- .../content/_existing-project-csharp.mdx | 12 +- .../content/_existing-project-nodejs.mdx | 12 +- .../content/_overview-csharp.mdx | 18 +- .../content/_overview-nodejs.mdx | 18 +- .../guides/azure-functions/deployment.mdx | 2 +- .../cloudflare-workers/existing-project.mdx | 12 +- .../guides/cloudflare-workers/overview.mdx | 16 +- .../deployment-considerations.mdx | 12 +- .../start/installation/gnu-linux/deb.mdx | 28 +-- .../version-7.1/start/installation/manual.mdx | 10 +- .../start/installation/running-as-service.mdx | 10 +- .../setup-wizard/additional-settings.mdx | 6 +- .../setup-wizard/choose-security-option.mdx | 18 +- .../setup-wizard/choose-setup-method.mdx | 14 +- .../setup-wizard/configure-node-addresses.mdx | 14 +- .../setup-wizard/finish-setup.mdx | 14 +- .../installation/setup-wizard/overview.mdx | 8 +- .../setup-wizard/provide-license-key.mdx | 6 +- .../setup-wizard/review-setup.mdx | 2 +- .../setup-wizard/use-setup-package.mdx | 4 +- .../start/licensing/activate-license.mdx | 4 +- .../start/licensing/force-update.mdx | 2 +- .../start/licensing/license-under-docker.mdx | 14 +- .../start/licensing/licensing-faq.mdx | 14 +- .../start/licensing/licensing-overview.mdx | 16 +- .../start/licensing/renew-license.mdx | 4 +- .../start/licensing/replace-license.mdx | 8 +- .../cluster-dashboard-customize.mdx | 10 +- .../cluster-dashboard-overview.mdx | 6 +- .../cluster-dashboard-widgets.mdx | 20 +- .../studio/cluster/cluster-view.mdx | 14 +- .../studio/cluster/setting-a-cluster.mdx | 6 +- .../studio/database/code-assistance.mdx | 4 +- .../create-new-database/from-backup.mdx | 10 +- .../create-new-database/from-legacy-files.mdx | 4 +- .../create-new-database/general-flow.mdx | 12 +- .../studio/database/databases-list-view.mdx | 16 +- .../database/document-extensions/counters.mdx | 6 +- .../revisions/all-revisions.mdx | 10 +- .../revisions/revisions-bin.mdx | 8 +- .../revisions/revisions-overview.mdx | 6 +- .../document-extensions/time-series.mdx | 40 ++-- .../documents/create-new-document.mdx | 14 +- .../database/documents/document-view.mdx | 4 +- .../documents/documents-and-collections.mdx | 2 +- .../database/documents/identities-view.mdx | 10 +- .../studio/database/documents/patch-view.mdx | 16 +- .../database/indexes/create-map-index.mdx | 26 +-- .../indexes/create-map-reduce-index.mdx | 18 +- .../indexes/create-multi-map-index.mdx | 4 +- .../studio/database/indexes/index-cleanup.mdx | 10 +- .../studio/database/indexes/index-history.mdx | 10 +- .../database/indexes/indexes-list-view.mdx | 12 +- .../database/indexes/indexes-overview.mdx | 28 +-- .../database/indexes/indexing-performance.mdx | 34 ++-- .../indexes/map-reduce-visualizer.mdx | 4 +- .../studio/database/queries/query-view.mdx | 14 +- .../queries/spatial-queries-map-view.mdx | 14 +- .../client-configuration-per-database.mdx | 2 +- .../database/settings/conflict-resolution.mdx | 4 +- .../database/settings/custom-analyzers.mdx | 14 +- .../database/settings/custom-sorters.mdx | 14 +- .../database/settings/database-record.mdx | 4 +- .../database/settings/database-settings.mdx | 16 +- .../database/settings/document-revisions.mdx | 30 +-- .../settings/documents-compression.mdx | 2 +- .../studio/database/settings/integrations.mdx | 2 +- .../settings/manage-database-group.mdx | 12 +- .../settings/studio-configuration.mdx | 12 +- .../settings/time-series-settings.mdx | 18 +- .../external-replication-stats.mdx | 4 +- .../ongoing-tasks-stats/olap-etl-stats.mdx | 4 +- .../stats/ongoing-tasks-stats/overview.mdx | 18 +- .../ongoing-tasks-stats/ravendb-etl-stats.mdx | 4 +- .../ongoing-tasks-stats/sql-etl-stats.mdx | 4 +- .../subscription-stats.mdx | 6 +- .../studio/database/stats/storage-report.mdx | 2 +- .../studio/database/tasks/backup-task.mdx | 50 ++--- .../database/tasks/create-sample-data.mdx | 4 +- .../studio/database/tasks/export-database.mdx | 6 +- .../tasks/import-data/import-data-file.mdx | 14 +- .../tasks/import-data/import-from-csv.mdx | 8 +- .../tasks/import-data/import-from-other.mdx | 10 +- .../tasks/import-data/import-from-ravendb.mdx | 2 +- .../tasks/import-data/import-from-sql.mdx | 40 ++-- .../tasks/ongoing-tasks/amazon-sqs-etl.mdx | 10 +- .../ongoing-tasks/azure-queue-storage-etl.mdx | 14 +- .../ongoing-tasks/elasticsearch-etl-task.mdx | 24 +-- .../external-replication-task.mdx | 16 +- .../tasks/ongoing-tasks/general-info.mdx | 6 +- .../hub-sink-replication/overview.mdx | 12 +- .../replication-hub-task.mdx | 12 +- .../replication-sink-task.mdx | 14 +- .../tasks/ongoing-tasks/kafka-etl-task.mdx | 24 +-- .../tasks/ongoing-tasks/kafka-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/olap-etl-task.mdx | 20 +- .../tasks/ongoing-tasks/rabbitmq-etl-task.mdx | 8 +- .../ongoing-tasks/rabbitmq-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/ravendb-etl-task.mdx | 18 +- .../ongoing-tasks/snowflake-etl-task.mdx | 6 +- .../tasks/ongoing-tasks/subscription-task.mdx | 6 +- .../version-7.1/studio/overview.mdx | 16 +- .../certificates/read-only-access-level.mdx | 2 +- .../server-management-certificates-view.mdx | 16 +- .../studio/server/client-configuration.mdx | 2 +- .../studio/server/debug/admin-js-console.mdx | 6 +- .../studio/server/debug/admin-logs.mdx | 32 ++-- .../debug/advanced/cluster-observer.mdx | 6 +- .../studio/server/manage-server.mdx | 6 +- .../studio/server/server-settings.mdx | 2 +- .../studio/server/server-wide-backup.mdx | 14 +- .../recovering-from-voron-errors.mdx | 2 +- 3226 files changed, 20892 insertions(+), 20892 deletions(-) diff --git a/cloud/cloud-account.mdx b/cloud/cloud-account.mdx index cf105dc2c6..ad98e76531 100644 --- a/cloud/cloud-account.mdx +++ b/cloud/cloud-account.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; *RavenDB Cloud* allows you to manage your payment information, access, and other user roles. * In this page: - * [Account roles](../cloud/cloud-account.mdx#account-roles) - * [Multi-account configuration](../cloud/cloud-account.mdx#multi-account-configuration) + * [Account roles](#account-roles) + * [Multi-account configuration](#multi-account-configuration) ## Account roles diff --git a/cloud/cloud-aws-marketplace.mdx b/cloud/cloud-aws-marketplace.mdx index bc8a5c3c1b..7c3fd387f4 100644 --- a/cloud/cloud-aws-marketplace.mdx +++ b/cloud/cloud-aws-marketplace.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Access to *RavenDB Cloud* services is available through the *AWS Marketplace*. * In this page: - * [Overview](../cloud/cloud-aws-marketplace.mdx#overview) - * [Supported countries](../cloud/cloud-aws-marketplace.mdx#supported-countries) - * [Registration process](../cloud/cloud-aws-marketplace.mdx#registration-process) - * [Subscription cancellation process](../cloud/cloud-aws-marketplace.mdx#subscription-cancellation-process) + * [Overview](#overview) + * [Supported countries](#supported-countries) + * [Registration process](#registration-process) + * [Subscription cancellation process](#subscription-cancellation-process) ## Overview diff --git a/cloud/cloud-backup-and-restore.mdx b/cloud/cloud-backup-and-restore.mdx index 759588a3c1..a741f1f789 100644 --- a/cloud/cloud-backup-and-restore.mdx +++ b/cloud/cloud-backup-and-restore.mdx @@ -24,13 +24,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; You **can** define custom backup tasks for them. * In this page: - * [The Mandatory-Backup Routine](../cloud/cloud-backup-and-restore.mdx#the-mandatory-backup-routine) - * [Tier Requirements and Failure Disclaimer](../cloud/cloud-backup-and-restore.mdx#tier-requirements-and-failure-disclaimer) - * [Backup storage](../cloud/cloud-backup-and-restore.mdx#backup-storage) - * [Charging For Backup storage](../cloud/cloud-backup-and-restore.mdx#charging-for-backup-storage) - * [Backup Encryption](../cloud/cloud-backup-and-restore.mdx#backup-encryption) - * [Creating a Custom Backup](../cloud/cloud-backup-and-restore.mdx#creating-a-custom-backup) - * [Restore Mandatory-Backup Files](../cloud/cloud-backup-and-restore.mdx#restore-mandatory-backup-files) + * [The Mandatory-Backup Routine](#the-mandatory-backup-routine) + * [Tier Requirements and Failure Disclaimer](#tier-requirements-and-failure-disclaimer) + * [Backup storage](#backup-storage) + * [Charging For Backup storage](#charging-for-backup-storage) + * [Backup Encryption](#backup-encryption) + * [Creating a Custom Backup](#creating-a-custom-backup) + * [Restore Mandatory-Backup Files](#restore-mandatory-backup-files) ## The Mandatory-Backup Routine @@ -101,9 +101,9 @@ and their resource allocations. ## Backup storage #### Mandatory-Backup Storage -Backups created by the [mandatory backup routine](../cloud/cloud-backup-and-restore.mdx#the-mandatory-backup-routine) are stored in a RavenDB +Backups created by the [mandatory backup routine](#the-mandatory-backup-routine) are stored in a RavenDB cloud you have no direct access to. -You can [view and restore](../cloud/cloud-backup-and-restore.mdx#restore-mandatory-backup-files) them using your portal's Backups tab and the +You can [view and restore](#restore-mandatory-backup-files) them using your portal's Backups tab and the management Studio. @@ -121,7 +121,7 @@ Upon backup geographically closest AWS S3 bucket is used for backup storage e.g. - if your RavenDB Cloud cluster has been created in the US, it backs up to AWS S3 buckets in the US. #### Custom-Backup Storage -[Custom-backup](../cloud/cloud-backup-and-restore.mdx#creating-a-custom-backup) files can be kept using an Amazon service +[Custom-backup](#creating-a-custom-backup) files can be kept using an Amazon service (S3 or S3 Glacier) or a Microsoft service (Azure). We recommend that you use a backup method **local to your host cloud**. If your product is hosted by Amazon AWS for example, you can store your backup files on an Amazon S3 bucket. diff --git a/cloud/cloud-instances.mdx b/cloud/cloud-instances.mdx index ec25691df2..16e334a6af 100644 --- a/cloud/cloud-instances.mdx +++ b/cloud/cloud-instances.mdx @@ -20,22 +20,22 @@ import LanguageContent from "@site/src/components/LanguageContent"; a Free node, a Development node, a Production cluster, or a Serverless product. - Free and Development nodes, as well as Production "basic" grade clusters, are operated by [burstable instances](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters). -- The Production cluster grades [Standard](../cloud/cloud-instances.mdx#standard-grade-production-cluster) -and [Performance](../cloud/cloud-instances.mdx#performance-grade-production-cluster) are +- The Production cluster grades [Standard](#standard-grade-production-cluster) +and [Performance](#performance-grade-production-cluster) are [Reserved clusters](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters). In this page: -* [A Free Cloud Node](../cloud/cloud-instances.mdx#a-free-cloud-node) -* [A Development Cloud Server](../cloud/cloud-instances.mdx#a-development-cloud-server) -* [A Production Cloud Cluster](../cloud/cloud-instances.mdx#a-production-cloud-cluster) - - [Basic-grade Production Cluster](../cloud/cloud-instances.mdx#1-basic-grade-production-cluster) - - [Standard-grade Production Cluster](../cloud/cloud-instances.mdx#2-standard-grade-production-cluster) - - [Performance-grade Production Cluster](../cloud/cloud-instances.mdx#3-performance-grade-production-cluster) -* [A Serverless Cloud Product](../cloud/cloud-instances.mdx#a-serverless-cloud-product) - - [Autoscaling](../cloud/cloud-instances.mdx#autoscaling) - - [Billing](../cloud/cloud-instances.mdx#billing) - - [Switching to Regular Deployment](../cloud/cloud-instances.mdx#switching-to-regular-deployment) +* [A Free Cloud Node](#a-free-cloud-node) +* [A Development Cloud Server](#a-development-cloud-server) +* [A Production Cloud Cluster](#a-production-cloud-cluster) + - [Basic-grade Production Cluster](#1-basic-grade-production-cluster) + - [Standard-grade Production Cluster](#2-standard-grade-production-cluster) + - [Performance-grade Production Cluster](#3-performance-grade-production-cluster) +* [A Serverless Cloud Product](#a-serverless-cloud-product) + - [Autoscaling](#autoscaling) + - [Billing](#billing) + - [Switching to Regular Deployment](#switching-to-regular-deployment) ## A Free Cloud Node @@ -48,7 +48,7 @@ to create a **free**-tier instance. !["Tiers and Instances: Free"](./assets/tiers-and-instances-001-free.png) -* A free instance is identical to a development [Dev10](../cloud/cloud-instances.mdx#a-development-cloud-server) instance. +* A free instance is identical to a development [Dev10](#a-development-cloud-server) instance. It comes with a monthly credit of **$14**, used to cover the cost of the instance and incidentals like backup storage and traffic. @@ -124,9 +124,9 @@ Please be aware that cloud cluster nodes are provided with dynamic IP addresses The production tier offers three instance levels: -1. [Basic](../cloud/cloud-instances.mdx#1-basic-grade-production-cluster) -2. [Standard](../cloud/cloud-instances.mdx#2-standard-grade-production-cluster) -3. [Performance](../cloud/cloud-instances.mdx#3-performance-grade-production-cluster) +1. [Basic](#1-basic-grade-production-cluster) +2. [Standard](#2-standard-grade-production-cluster) +3. [Performance](#3-performance-grade-production-cluster) The tier you select must have sufficient compute, memory, and disk resources to run backups on top diff --git a/cloud/cloud-microsoft-azure-marketplace.mdx b/cloud/cloud-microsoft-azure-marketplace.mdx index 7394e16369..8042587bf7 100644 --- a/cloud/cloud-microsoft-azure-marketplace.mdx +++ b/cloud/cloud-microsoft-azure-marketplace.mdx @@ -18,11 +18,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; Access to *RavenDB Cloud* services is available through the *Microsoft Azure Marketplace*. * In this page: - * [Overview](../cloud/cloud-microsoft-azure-marketplace.mdx#overview) - * [Supported countries](../cloud/cloud-microsoft-azure-marketplace.mdx#supported-countries) - * [Registration process](../cloud/cloud-microsoft-azure-marketplace.mdx#registration-process) - * [Subscription cancellation process](../cloud/cloud-microsoft-azure-marketplace.mdx#subscription-cancellation-process) - * [Conversion from a regular Cloud Account to an Azure Marketplace Account](../cloud/cloud-microsoft-azure-marketplace.mdx#conversion-from-a-regular-cloud-account-to-an-azure-marketplace-account) + * [Overview](#overview) + * [Supported countries](#supported-countries) + * [Registration process](#registration-process) + * [Subscription cancellation process](#subscription-cancellation-process) + * [Conversion from a regular Cloud Account to an Azure Marketplace Account](#conversion-from-a-regular-cloud-account-to-an-azure-marketplace-account) ## Overview diff --git a/cloud/cloud-overview.mdx b/cloud/cloud-overview.mdx index e7455d96eb..f1e055f1d0 100644 --- a/cloud/cloud-overview.mdx +++ b/cloud/cloud-overview.mdx @@ -26,24 +26,24 @@ like adding or removing nodes, and run recurring tasks like backing up your data * **Resources** Some of your products may share their resources with other applications and users, while other products may occupy machines - reserved for their usage only. Read about [reserved clusters](../cloud/cloud-overview.mdx#reserved-clusters), - [burstable instances](../cloud/cloud-overview.mdx#burstable-instances), and [credits](../cloud/cloud-overview.mdx#budget-credits-and-throttling) + reserved for their usage only. Read about [reserved clusters](#reserved-clusters), + [burstable instances](#burstable-instances), and [credits](#budget-credits-and-throttling) to understand more about your choices. * In this page: - * [Your Account](../cloud/cloud-overview.mdx#your-account) - - [Register](../cloud/cloud-overview.mdx#register-your-account) - - [Login](../cloud/cloud-overview.mdx#login-to-your-account) - - [Login with a magic link](../cloud/cloud-overview.mdx#login-with-a-magic-link) - - [Login with GitHub or Google](../cloud/cloud-overview.mdx#login-with-github-or-google) - * [RavenDB on the Cloud](../cloud/cloud-overview.mdx#ravendb-on-the-cloud) - * [Instances, Provisioning and RavenDB Products](../cloud/cloud-overview.mdx#instances-provisioning-and-ravendb-products) - * [RavenDB Tiers: Free, Development and Production](../cloud/cloud-overview.mdx#ravendb-tiers) - * [Burstable vs. Reserved clusters](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters) - * [Budget, Credits and Throttling](../cloud/cloud-overview.mdx#budget-credits-and-throttling) - * [RavenDB Studio - Graphic User Interface](../cloud/cloud-overview.mdx#ravendb-studio---graphic-user-interface) - * [Accessing RavenDB Cloud Studio](../cloud/cloud-overview.mdx#accessing-ravendb-cloud-studio) - * [What you can do with RavenDB Studio](../cloud/cloud-overview.mdx#what-you-can-do-with-ravendb-studio) + * [Your Account](#your-account) + - [Register](#register-your-account) + - [Login](#login-to-your-account) + - [Login with a magic link](#login-with-a-magic-link) + - [Login with GitHub or Google](#login-with-github-or-google) + * [RavenDB on the Cloud](#ravendb-on-the-cloud) + * [Instances, Provisioning and RavenDB Products](#instances-provisioning-and-ravendb-products) + * [RavenDB Tiers: Free, Development and Production](#ravendb-tiers) + * [Burstable vs. Reserved clusters](#burstable-vs-reserved-clusters) + * [Budget, Credits and Throttling](#budget-credits-and-throttling) + * [RavenDB Studio - Graphic User Interface](#ravendb-studio---graphic-user-interface) + * [Accessing RavenDB Cloud Studio](#accessing-ravendb-cloud-studio) + * [What you can do with RavenDB Studio](#what-you-can-do-with-ravendb-studio) ## What do you get? @@ -72,10 +72,10 @@ and allow the wizard to walk you through the 5 simple stages of the registration You can also start registration by clicking **Login via GitHub** or **Login via Google** on the -[login page](../cloud/cloud-overview.mdx#login-to-your-account). If no Cloud account exists yet for +[login page](#login-to-your-account). If no Cloud account exists yet for the email reported by the provider, a registration link is sent to that address and the registration form opens with the email already filled in. -See [Login with GitHub or Google](../cloud/cloud-overview.mdx#login-with-github-or-google). +See [Login with GitHub or Google](#login-with-github-or-google). 1. **Email** @@ -121,7 +121,7 @@ Click the **Skip Billing Information** button if you prefer to evaluate the clou - The sign-up process will send a registration link to your email. - Click the link to enter your account. No password required. -- The link will expire after a while, use the [login page](../cloud/cloud-overview.mdx#login-to-your-account) to re-visit your account. +- The link will expire after a while, use the [login page](#login-to-your-account) to re-visit your account. @@ -200,8 +200,8 @@ Each server or cluster-node occupies a single cloud instance. Different instances are equipped to your specifications to accommodate your different products and may be considerably different from each other in features, capabilities, and cost. The instances of -a basic production cluster, for example, are [burstable](../cloud/cloud-overview.mdx#burstable-instances), -while those of a higher-grade production cluster are [reserved](../cloud/cloud-overview.mdx#reserved-clusters). +a basic production cluster, for example, are [burstable](#burstable-instances), +while those of a higher-grade production cluster are [reserved](#reserved-clusters). ## RavenDB Tiers diff --git a/cloud/cloud-pricing-payment-billing.mdx b/cloud/cloud-pricing-payment-billing.mdx index f15181854f..8be2d2b58a 100644 --- a/cloud/cloud-pricing-payment-billing.mdx +++ b/cloud/cloud-pricing-payment-billing.mdx @@ -20,16 +20,16 @@ You can run a product and pay for it using a credit card or a wire transfer (we details in any case). You can pay per minute without any commitment, or use one of the yearly-payment models for a substantial discount. * In this page: - * [Pricing](../cloud/cloud-pricing-payment-billing.mdx#pricing) - - [On-Demand Payment](../cloud/cloud-pricing-payment-billing.mdx#on-demand-payment) - - [Yearly with NO Upfront payment](../cloud/cloud-pricing-payment-billing.mdx#yearly-with-no-upfront-payment) - - [Yearly WITH an Upfront payment](../cloud/cloud-pricing-payment-billing.mdx#yearly-with-an-upfront-payment) - - [Viewing your current configuration price](../cloud/cloud-pricing-payment-billing.mdx#viewing-current-configuration-price) - - [Additional Expenses](../cloud/cloud-pricing-payment-billing.mdx#additional-expenses) - * [Payment](../cloud/cloud-pricing-payment-billing.mdx#payment) - * [Billing](../cloud/cloud-pricing-payment-billing.mdx#billing) - - [Charging Failures](../cloud/cloud-pricing-payment-billing.mdx#charging-failures) - - [Pay Now](../cloud/cloud-pricing-payment-billing.mdx#pay-now) + * [Pricing](#pricing) + - [On-Demand Payment](#on-demand-payment) + - [Yearly with NO Upfront payment](#yearly-with-no-upfront-payment) + - [Yearly WITH an Upfront payment](#yearly-with-an-upfront-payment) + - [Viewing your current configuration price](#viewing-current-configuration-price) + - [Additional Expenses](#additional-expenses) + * [Payment](#payment) + * [Billing](#billing) + - [Charging Failures](#charging-failures) + - [Pay Now](#pay-now) @@ -92,7 +92,7 @@ While [provisioning or editing](../cloud/portal/cloud-portal-products-tab.mdx) y costs are shown in the **Your Order** slot. The overall price is an outcome of your hardware configuration and pricing model, -with possible [additional expenses](../cloud/cloud-pricing-payment-billing.mdx#additional-expenses). +with possible [additional expenses](#additional-expenses). See for example the price differences between the production basic-grade configurations PB10 and PB20: diff --git a/cloud/cloud-scaling.mdx b/cloud/cloud-scaling.mdx index c8f723d61f..7e55fd4c89 100644 --- a/cloud/cloud-scaling.mdx +++ b/cloud/cloud-scaling.mdx @@ -26,9 +26,9 @@ two RavenDB instances using: - [Replication](https://ravendb.net/docs/article-page/6.0/csharp/studio/database/tasks/ongoing-tasks/external-replication-task) * In this page: - * [Scaling Up/Down - General](../cloud/cloud-scaling.mdx#scaling-updown---general) - - [Change instance type](../cloud/cloud-scaling.mdx#scaling---change-instance-type) - - [Change storage](../cloud/cloud-scaling.mdx#scaling---change-storage) + * [Scaling Up/Down - General](#scaling-updown---general) + - [Change instance type](#scaling---change-instance-type) + - [Change storage](#scaling---change-storage) * [Additional product nodes - General](#additional-product-nodes---general) - [Adding a node to a database group](#additional-product-nodes---adding-a-node-to-a-database-group) @@ -50,8 +50,8 @@ The [Free](../cloud/cloud-instances.mdx#a-free-cloud-node) product doesn't show ![Scaling buttons](./assets/portal-product-edit-storage-and-instance-type-area.png) -**1.** Click [Change Instance Type](../cloud/cloud-scaling.mdx#scaling---change-instance-type) to reconfigure your product. -**2.** Click [Change Storage](../cloud/cloud-scaling.mdx#scaling---change-storage) to modify your product's storage parameters. +**1.** Click [Change Instance Type](#scaling---change-instance-type) to reconfigure your product. +**2.** Click [Change Storage](#scaling---change-storage) to modify your product's storage parameters. Scaling a [Development](../cloud/cloud-instances.mdx#a-development-cloud-server) product **brings it down** diff --git a/cloud/cloud-security.mdx b/cloud/cloud-security.mdx index 64b9ff0dd3..2765583c4a 100644 --- a/cloud/cloud-security.mdx +++ b/cloud/cloud-security.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Using the initial client certificate](cloud-security#using-the-initial-client-certificate) * [Managing allowed IPs](cloud-security#managing-allowed-ips) * [Using additional certificates](cloud-security#using-additional-certificates) - * [MFA](../cloud/cloud-security.mdx#mfa) + * [MFA](#mfa) - [Enable MFA](../cloud/cloud-security#enable-mfa) - [Disable MFA](../cloud/cloud-security#disable-mfa) diff --git a/cloud/cloud-settings.mdx b/cloud/cloud-settings.mdx index 2d7400f2fa..ab304aa2f4 100644 --- a/cloud/cloud-settings.mdx +++ b/cloud/cloud-settings.mdx @@ -24,8 +24,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; the cloud configurations will be discussed in this article. * In this page: - * [Setting Cloud Configurations via Studio](../cloud/cloud-settings.mdx#setting-cloud-configurations-via-studio) - * [Indexing Settings](../cloud/cloud-settings.mdx#indexing-settings) + * [Setting Cloud Configurations via Studio](#setting-cloud-configurations-via-studio) + * [Indexing Settings](#indexing-settings) ## Setting Cloud Configurations via Studio diff --git a/cloud/cloud-support.mdx b/cloud/cloud-support.mdx index d43f88fb7b..33ac73c342 100644 --- a/cloud/cloud-support.mdx +++ b/cloud/cloud-support.mdx @@ -20,8 +20,8 @@ that suits your current needs and future plans, assist with any technical issue and get your product-specific feedback and suggestions. * In this page: - * [Available support options](../cloud/cloud-support.mdx#available-support-options) - * [Severity and response time types](../cloud/cloud-support.mdx#severity-and-response-time-types) + * [Available support options](#available-support-options) + * [Severity and response time types](#severity-and-response-time-types) ## Available support options diff --git a/cloud/portal/cloud-portal-account-tab.mdx b/cloud/portal/cloud-portal-account-tab.mdx index c41d1fdbaf..094fb9bdfa 100644 --- a/cloud/portal/cloud-portal-account-tab.mdx +++ b/cloud/portal/cloud-portal-account-tab.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; This tab allows you to manage your account and payment information, user access, and user roles. * In this page: - * [The Account Tab](../../cloud/portal/cloud-portal-account-tab.mdx#the-account-tab) - * [Billing information management](../../cloud/portal/cloud-portal-account-tab.mdx#billing-information-management) - * [User management](../../cloud/portal/cloud-portal-account-tab.mdx#user-management) + * [The Account Tab](#the-account-tab) + * [Billing information management](#billing-information-management) + * [User management](#user-management) ## The Account Tab diff --git a/cloud/portal/cloud-portal-api-tab.mdx b/cloud/portal/cloud-portal-api-tab.mdx index 45e8c0db4e..c8dd4a244a 100644 --- a/cloud/portal/cloud-portal-api-tab.mdx +++ b/cloud/portal/cloud-portal-api-tab.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; The RavenDB Cloud API allows you to automate actions on your RavenDB Cloud products. By making simple HTTP calls, you can adjust your storage size or change the instance type. Scale up or down without visiting the RavenDB Cloud portal. * In this page: - * [The API Tab](../../cloud/portal/cloud-portal-api-tab.mdx#the-api-tab) - * [Create API Key](../../cloud/portal/cloud-portal-api-tab.mdx#create-api-key) - * [Edit API Key](../../cloud/portal/cloud-portal-api-tab.mdx#edit-api-key) - * [Deactivate API Key](../../cloud/portal/cloud-portal-api-tab.mdx#deactivate-api-key) + * [The API Tab](#the-api-tab) + * [Create API Key](#create-api-key) + * [Edit API Key](#edit-api-key) + * [Deactivate API Key](#deactivate-api-key) ## The API Tab diff --git a/cloud/portal/cloud-portal-backups-tab.mdx b/cloud/portal/cloud-portal-backups-tab.mdx index cf18d74e11..cb19166cce 100644 --- a/cloud/portal/cloud-portal-backups-tab.mdx +++ b/cloud/portal/cloud-portal-backups-tab.mdx @@ -22,7 +22,7 @@ from the portal's Backups tab and [restore them](../../cloud/cloud-backup-and-re management Studio. * In this page: - * [Backups List](../../cloud/portal/cloud-portal-backups-tab.mdx#backup-files) + * [Backups List](#backup-files) ## Backup List diff --git a/cloud/portal/cloud-portal-billing-tab.mdx b/cloud/portal/cloud-portal-billing-tab.mdx index db4a56d2c1..efcdae60c4 100644 --- a/cloud/portal/cloud-portal-billing-tab.mdx +++ b/cloud/portal/cloud-portal-billing-tab.mdx @@ -19,11 +19,11 @@ Use your account's Billing & Costs tab to view your present costs, past invoices * In this page: * [The Billing & Costs Tab](#the-billing-&-costs-tab) - * [Pay Now](../../cloud/portal/cloud-portal-billing-tab.mdx#pay-now) - * [Current billing period](../../cloud/portal/cloud-portal-billing-tab.mdx#current-billing-period) - * [Account benefits](../../cloud/portal/cloud-portal-billing-tab.mdx#account-benefits) - * [Billing history](../../cloud/portal/cloud-portal-billing-tab.mdx#billing-history) - * [Spending](../../cloud/portal/cloud-portal-billing-tab.mdx#spending) + * [Pay Now](#pay-now) + * [Current billing period](#current-billing-period) + * [Account benefits](#account-benefits) + * [Billing history](#billing-history) + * [Spending](#spending) ## The Billing & Costs Tab diff --git a/cloud/portal/cloud-portal-home-tab.mdx b/cloud/portal/cloud-portal-home-tab.mdx index 2fba8e6721..f3ce73c56c 100644 --- a/cloud/portal/cloud-portal-home-tab.mdx +++ b/cloud/portal/cloud-portal-home-tab.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Use this tab to manage your account and assigned roles. You can also use it to view useful resources, such as documentation, the community, and articles. * In this page: - * [The Home Tab](../../cloud/portal/cloud-portal-home-tab.mdx#the-home-tab) + * [The Home Tab](#the-home-tab) ## The Home Tab diff --git a/cloud/portal/cloud-portal-products-tab.mdx b/cloud/portal/cloud-portal-products-tab.mdx index cc96c6b81a..0119fce182 100644 --- a/cloud/portal/cloud-portal-products-tab.mdx +++ b/cloud/portal/cloud-portal-products-tab.mdx @@ -23,15 +23,15 @@ You can provision products of three types: [Free](../../cloud/cloud-overview.md and [Production](../../cloud/cloud-overview.mdx#the-production-tier). * In this page: - * [Provisioning a New Product](../../cloud/portal/cloud-portal-products-tab.mdx#provisioning-a-new-product) - * [View the Product Metrics](../../cloud/portal/cloud-portal-products-tab.mdx#view-the-product-metrics) - * [View the Cluster Health](../../cloud/portal/cloud-portal-products-tab.mdx#view-the-cluster-health) - * [Managing an Existing Product](../../cloud/portal/cloud-portal-products-tab.mdx#managing-an-existing-product) - - [Change Instance Type and Storage](../../cloud/portal/cloud-portal-products-tab.mdx#change-instance-type-and-storage) - - [Security: Your Certificate, Audit Logs and Allowed IPs](../../cloud/portal/cloud-portal-products-tab.mdx#security-your-certificate-audit-logs-and-allowed-ips) + * [Provisioning a New Product](#provisioning-a-new-product) + * [View the Product Metrics](#view-the-product-metrics) + * [View the Cluster Health](#view-the-cluster-health) + * [Managing an Existing Product](#managing-an-existing-product) + - [Change Instance Type and Storage](#change-instance-type-and-storage) + - [Security: Your Certificate, Audit Logs and Allowed IPs](#security-your-certificate-audit-logs-and-allowed-ips) - [Manage features](#manage-features) - - [Nodes: Additional product nodes](../../cloud/portal/cloud-portal-products-tab.mdx#nodes-additional-product-nodes) - - [Maintenance and Danger Zones: Terminate and Restart your Instance](../../cloud/portal/cloud-portal-products-tab.mdx#maintenance-and-danger-zones) + - [Nodes: Additional product nodes](#nodes-additional-product-nodes) + - [Maintenance and Danger Zones: Terminate and Restart your Instance](#maintenance-and-danger-zones) ## Provisioning a New Product @@ -41,11 +41,11 @@ To provision a new product, open your Portal's Products tab and click **Add Prod The New Product wizard will open and walk you through the following simple stages: -A. [Plan](../../cloud/portal/cloud-portal-products-tab.mdx#a-new-product-plan) -B. [Account](../../cloud/portal/cloud-portal-products-tab.mdx#b-new-product-account) -C. [Billing](../../cloud/portal/cloud-portal-products-tab.mdx#c-new-product-billing) -D. [Customize](../../cloud/portal/cloud-portal-products-tab.mdx#d-new-product-customize) -E. [Summary](../../cloud/portal/cloud-portal-products-tab.mdx#e-new-product-summary) +A. [Plan](#a-new-product-plan) +B. [Account](#b-new-product-account) +C. [Billing](#c-new-product-billing) +D. [Customize](#d-new-product-customize) +E. [Summary](#e-new-product-summary) #### A. New Product: Plan Use the Plan page to choose your product's cloud **Provider**, **Region**, **Tier**, **Instance**, **Storage** and **Payment model**. diff --git a/cloud/portal/cloud-portal-support-tab.mdx b/cloud/portal/cloud-portal-support-tab.mdx index d22af507c0..84844f37b0 100644 --- a/cloud/portal/cloud-portal-support-tab.mdx +++ b/cloud/portal/cloud-portal-support-tab.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Use the Support tab to contact our *RavenDB Cloud* support team. * In this page: - * [The Support Tab](../../cloud/portal/cloud-portal-support-tab.mdx#the-support-tab) - * [Submit a General Support request](../../cloud/portal/cloud-portal-support-tab.mdx#submit-a-general-support-request) - * [Submit a Product-Related Support request](../../cloud/portal/cloud-portal-support-tab.mdx#submit-a-product-related-support-request) - * [Request to enable the Cloud Support option](../../cloud/portal/cloud-portal-support-tab.mdx#request-to-enable-the-cloud-support-option) + * [The Support Tab](#the-support-tab) + * [Submit a General Support request](#submit-a-general-support-request) + * [Submit a Product-Related Support request](#submit-a-product-related-support-request) + * [Request to enable the Cloud Support option](#request-to-enable-the-cloud-support-option) ## The Support Tab diff --git a/cloud/portal/cloud-portal.mdx b/cloud/portal/cloud-portal.mdx index 590cee05cc..2df4954fd4 100644 --- a/cloud/portal/cloud-portal.mdx +++ b/cloud/portal/cloud-portal.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; takes you to your account's Portal, which gives you access to all the different aspects of your cloud account. * In this page: - * [Cloud Portal overview](../../cloud/portal/cloud-portal.mdx#cloud-portal-overview) + * [Cloud Portal overview](#cloud-portal-overview) ## Cloud Portal overview diff --git a/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx b/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx index c770185244..797e625fe5 100644 --- a/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx +++ b/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx @@ -22,31 +22,31 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Learn how to create and run a conversation in [Managing conversations](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations). * In this article: - * [Get the conversation messages](../../../ai-integration/ai-agents/reading-conversation-history.mdx#get-the-conversation-messages) - * [Page through the conversation](../../../ai-integration/ai-agents/reading-conversation-history.mdx#page-through-the-conversation) - * [Catch up on new messages](../../../ai-integration/ai-agents/reading-conversation-history.mdx#catch-up-on-new-messages) - * [Control the level of detail](../../../ai-integration/ai-agents/reading-conversation-history.mdx#control-the-level-of-detail) - * [Inspect tool calls and sub-conversations](../../../ai-integration/ai-agents/reading-conversation-history.mdx#inspect-tool-calls-and-sub-conversations) - * [Syntax](../../../ai-integration/ai-agents/reading-conversation-history.mdx#syntax) + * [Get the conversation messages](#get-the-conversation-messages) + * [Page through the conversation](#page-through-the-conversation) + * [Catch up on new messages](#catch-up-on-new-messages) + * [Control the level of detail](#control-the-level-of-detail) + * [Inspect tool calls and sub-conversations](#inspect-tool-calls-and-sub-conversations) + * [Syntax](#syntax) -To read a conversation's messages, call [GetConversationMessages](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history) (or `GetConversationMessagesAsync`) +To read a conversation's messages, call [GetConversationMessages](#conversation-history) (or `GetConversationMessagesAsync`) and pass the conversation document ID. -`GetConversationMessages` returns an [AiConversationMessagesResult](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) object that includes a `Messages` +`GetConversationMessages` returns an [AiConversationMessagesResult](#conversation-history-classes) object that includes a `Messages` list, holding the conversation's messages in chronological order, oldest first. If no conversation with the given ID exists, the method returns `null`. Passing only a conversation ID returns the whole conversation in one call: `PageSize`, the maximum number of messages in a page, defaults to `int.MaxValue`, so no page limit applies. To read the conversation in fixed-size pages, set `PageSize` and read it a page at a time, as explained in -[Page through the conversation](../../../ai-integration/ai-agents/reading-conversation-history.mdx#page-through-the-conversation). +[Page through the conversation](#page-through-the-conversation). At the default `Simple` detail level, the result holds the messages between the user and the LLM. -See [Control the level of detail](../../../ai-integration/ai-agents/reading-conversation-history.mdx#control-the-level-of-detail) +See [Control the level of detail](#control-the-level-of-detail) for the other detail levels and the message types each level includes. @@ -75,9 +75,9 @@ Besides the messages, the result includes, among others: `true` when the conversation holds more messages beyond the returned page.
-See [GetConversationMessages](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history) -and [AiConversationMessagesResult](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) -in the [Syntax](../../../ai-integration/ai-agents/reading-conversation-history.mdx#syntax) section. +See [GetConversationMessages](#conversation-history) +and [AiConversationMessagesResult](#conversation-history-classes) +in the [Syntax](#syntax) section. @@ -86,7 +86,7 @@ in the [Syntax](../../../ai-integration/ai-agents/reading-conversation-history.m A single call to `GetConversationMessages` returns one page of messages, up to `PageSize`. By default, the page holds the conversation's most recent messages. -To select another page, pass a [GetConversationMessagesOptions](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) object instead of a bare +To select another page, pass a [GetConversationMessagesOptions](#conversation-history-classes) object instead of a bare conversation ID: * Set `Before` to a timestamp to read the page of messages immediately before it. @@ -150,8 +150,8 @@ var newMessages = await store.AI.GetConversationMessagesAsync(
-See [GetConversationMessagesOptions](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) -in the [Syntax](../../../ai-integration/ai-agents/reading-conversation-history.mdx#syntax) section. +See [GetConversationMessagesOptions](#conversation-history-classes) +in the [Syntax](#syntax) section. @@ -186,15 +186,15 @@ var detailed = await store.AI.GetConversationMessagesAsync( ```
-See [AiConversationDetailLevel](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-enums) -in the [Syntax](../../../ai-integration/ai-agents/reading-conversation-history.mdx#syntax) section. +See [AiConversationDetailLevel](#conversation-history-enums) +in the [Syntax](#syntax) section. At the `Detailed` or `Full` detail level, the `ToolCalls` list of a message from the LLM holds -the tool calls the LLM made. Each entry is an [AiToolCallResult](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) object, giving the tool's `Name`, the +the tool calls the LLM made. Each entry is an [AiToolCallResult](#conversation-history-classes) object, giving the tool's `Name`, the `Arguments` the LLM passed, and the `Result` the tool returned. An agent can hand work to another agent (a [sub-agent](../../../ai-integration/ai-agents/multi-agents.mdx)). @@ -244,9 +244,9 @@ foreach (AiConversationMessage message in trace.Messages) ```
-See [AiConversationMessage](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) -and [AiToolCallResult](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-classes) -in the [Syntax](../../../ai-integration/ai-agents/reading-conversation-history.mdx#syntax) section. +See [AiConversationMessage](#conversation-history-classes) +and [AiToolCallResult](#conversation-history-classes) +in the [Syntax](#syntax) section. See [Multi-agents](../../../ai-integration/ai-agents/multi-agents.mdx) for the full sub-agent picture. @@ -394,7 +394,7 @@ class AiConversationMessage | Property | Type | Description | |----------|------|-------------| -| **Role** | `AiMessageRole` | What the message is: a system prompt, a user message, a message from the LLM, a summary, or an internal message.
See [AiMessageRole](../../../ai-integration/ai-agents/reading-conversation-history.mdx#conversation-history-enums). | +| **Role** | `AiMessageRole` | What the message is: a system prompt, a user message, a message from the LLM, a summary, or an internal message.
See [AiMessageRole](#conversation-history-enums). | | **Content** | `string` | The text content. When the stored message has several text parts, they are joined with line breaks. `null` for a message from the LLM that only initiated tool calls. | | **Attachments** | `List` | Names of the attachments associated with this message, if any. | | **Timestamp** | `DateTime` | The time the message was recorded (UTC). Unique within the conversation and rising in message order, so a `Timestamp` value can be used to page through the conversation. | diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx index cce6472ac7..3f8ad128ba 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx @@ -16,33 +16,33 @@ import ContentFrame from "@site/src/components/ContentFrame"; * This page provides a step-by-step guide to creating an AI agent and interacting with it using the client API. * In this article: - * [Creating a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) - * [Defining an agent configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration) - * [Set the agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-the-agent-id) - * [Define a response object](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#define-a-response-object) - * [Add agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#add-agent-parameters) - * [Set maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-maximum-number-of-iterations) - * [Set chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-chat-trimming-configuration) - * [Adding agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools) - * [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) - * [Initial-context queries](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#initial-context-queries) - * [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools) - * [Creating the Agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent) - * [Retrieving existing agent configurations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations) - * [Deleting an agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#deleting-an-agent) - * [Managing conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations) - * [Setting a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) - * [Processing action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests) - * [Action-tool Handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - * [Action-tool Receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers) - * [Catching action-tool calls with no callback](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#catching-action-tool-calls-with-no-callback) - * [Injecting artificial tool context](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#injecting-artificial-tool-context) - * [Conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response) - * [Setting user prompt and running the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) - * [Adding attachments](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-attachments) - * [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) - * [Full Example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example) - * [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) + * [Creating a connection string](#creating-a-connection-string) + * [Defining an agent configuration](#defining-an-agent-configuration) + * [Set the agent ID](#set-the-agent-id) + * [Define a response object](#define-a-response-object) + * [Add agent parameters](#add-agent-parameters) + * [Set maximum number of iterations](#set-maximum-number-of-iterations) + * [Set chat trimming configuration](#set-chat-trimming-configuration) + * [Adding agent tools](#adding-agent-tools) + * [Query tools](#query-tools) + * [Initial-context queries](#initial-context-queries) + * [Action tools](#action-tools) + * [Creating the Agent](#creating-the-agent) + * [Retrieving existing agent configurations](#retrieving-existing-agent-configurations) + * [Deleting an agent](#deleting-an-agent) + * [Managing conversations](#managing-conversations) + * [Setting a conversation](#setting-a-conversation) + * [Processing action-tool requests](#processing-action-tool-requests) + * [Action-tool Handlers](#action-tool-handlers) + * [Action-tool Receivers](#action-tool-receivers) + * [Catching action-tool calls with no callback](#catching-action-tool-calls-with-no-callback) + * [Injecting artificial tool context](#injecting-artificial-tool-context) + * [Conversation response](#conversation-response) + * [Setting user prompt and running the conversation](#setting-user-prompt-and-running-the-conversation) + * [Adding attachments](#adding-attachments) + * [Stream LLM responses](#stream-llm-responses) + * [Full Example](#full-example) + * [Syntax](#syntax) @@ -283,7 +283,7 @@ Start by creating a new `AiAgentConfiguration` instance. While creating the instance, pass its constructor: - The agent's Name -- The [connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) you created +- The [connection string](#creating-a-connection-string) you created - A System prompt The agent will send the system prompt you define here to the LLM to define its basic characteristics, including its role, purpose, behavior, and the tools it can use. @@ -385,7 +385,7 @@ agent.OutputSchema = "{" + ### Add agent parameters -Agent parameters are parameters that can be used by [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) when the agent queries the database on behalf of the LLM. +Agent parameters are parameters that can be used by [query tools](#query-tools) when the agent queries the database on behalf of the LLM. Values for agent parameters are provided by the client, or by a user through the client, when a chat is started. When the agent is requested to use a query tool that uses agent parameters, it replaces these parameters with the values provided by the user before running the query. @@ -421,9 +421,9 @@ This is useful for sensitive values like user IDs or tenant identifiers that sho "userId", "The current user's ID", sendToModel: false)); ``` -* **Note** that the visibility of parameter values to the LLM can also be determined at the conversation level, [as explained here](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-parameter-values-visibility-to-the-llm-conversation-level). +* **Note** that the visibility of parameter values to the LLM can also be determined at the conversation level, [as explained here](#setting-parameter-values-visibility-to-the-llm-conversation-level). -See [AiAgentParameter](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-configuration-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAgentParameter](#agent-configuration-classes) in the [Syntax](#syntax) section. --- @@ -485,8 +485,8 @@ inherited values are of the right shape. }); ``` -See [AiAgentParameterValueType](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#enums) -in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAgentParameterValueType](#enums) +in the [Syntax](#syntax) section. @@ -504,7 +504,7 @@ agent tools in response to a single user prompt. Use `MaxModelIterationsPerCall` Note that you can improve the TTFB (Time To First Byte) by getting the LLM's response in chunks using streaming. -Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses). +Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). @@ -540,7 +540,7 @@ with your settings. agent.ChatTrimming = new AiAgentChatTrimmingConfiguration(summarization); ```
-See [AiAgentChatTrimmingConfiguration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-configuration-classes), [AiAgentSummarizationByTokens](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-configuration-classes), and [AiAgentHistoryConfiguration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-configuration-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAgentChatTrimmingConfiguration](#agent-configuration-classes), [AiAgentSummarizationByTokens](#agent-configuration-classes), and [AiAgentHistoryConfiguration](#agent-configuration-classes) in the [Syntax](#syntax) section. @@ -676,7 +676,7 @@ Note: the two flags can be set regardless of each other. and the LLM will also be able to trigger its execution later in the conversation.
-See [AiAgentToolQuery](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-tool-classes) and [AiAgentToolQueryOptions](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-tool-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAgentToolQuery](#agent-tool-classes) and [AiAgentToolQueryOptions](#agent-tool-classes) in the [Syntax](#syntax) section. @@ -715,7 +715,7 @@ agent.Actions = ]; ```
-See [AiAgentToolAction](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-tool-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAgentToolAction](#agent-tool-classes) in the [Syntax](#syntax) section. @@ -758,7 +758,7 @@ they can be referenced. An agent cannot spawn a new agent at runtime.
-See [AiAgentToolSubAgent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-tool-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAgentToolSubAgent](#agent-tool-classes) in the [Syntax](#syntax) section. See [Multi-agents](../../../../ai-integration/ai-agents/multi-agents.mdx) for the end-to-end picture. @@ -794,7 +794,7 @@ The agent configuration is ready, and we can now register the agent with the ser } ```
-See [CreateAgent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-management) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [CreateAgent](#agent-management) in the [Syntax](#syntax) section. @@ -817,7 +817,7 @@ You can also retrieve the configurations of **all existing agents** using `GetAg var agents = existingAgentsList.AiAgents; ```
-See [GetAgent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-management) and [GetAgents](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-management) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [GetAgent](#agent-management) and [GetAgents](#agent-management) in the [Syntax](#syntax) section. @@ -831,7 +831,7 @@ To delete an existing agent configuration, use `DeleteAgent` with the agent's ID await store.AI.DeleteAgentAsync("reward-productive-employee"); ```
-See [DeleteAgent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-management) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [DeleteAgent](#agent-management) in the [Syntax](#syntax) section. @@ -880,7 +880,7 @@ See [DeleteAgent](../../../../ai-integration/ai-agents/creating-ai-agents/creati #### Setting parameter values visibility to the LLM (Conversation level) -* As [explained above](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-parameter-values-visibility-to-the-llm-configuration-level), the visibility of a parameter's value to the LLM can be set in the agent configuration using the `SendToModel` property of `AiAgentParameter`. +* As [explained above](#setting-parameter-values-visibility-to-the-llm-configuration-level), the visibility of a parameter's value to the LLM can be set in the agent configuration using the `SendToModel` property of `AiAgentParameter`. You can also control the value's visibility to the LLM **at the conversation level** by passing `sendToModel: false` to `AddParameter`. The final visibility is determined by **both** configuration-level and conversation-level settings: if **either** is `false`, the parameter is hidden from the model. @@ -896,7 +896,7 @@ See [DeleteAgent](../../../../ai-integration/ai-agents/creating-ai-agents/creati --- -See [Conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-execution), [SetUserPrompt](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-execution), and [AiConversationCreationOptions](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [Conversation](#conversation-execution), [SetUserPrompt](#conversation-execution), and [AiConversationCreationOptions](#conversation-and-response-classes) in the [Syntax](#syntax) section.
To read the messages of a stored conversation back from the server, see @@ -910,8 +910,8 @@ To read the messages of a stored conversation back from the server, see During the conversation, the LLM can request the agent to trigger action tools. The agent will pass a requested action tool's name and parameters to the client, and it is then up to the client to process the request. -- The client can process an action-tool request using a [handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) or a [receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers). -- If an action-tool request arrives and there is no registered handler or receiver to process it, the client can catch it using [OnUnhandledAction](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#catching-action-tool-calls-with-no-callback) and decide how to address it. +- The client can process an action-tool request using a [handler](#action-tool-handlers) or a [receiver](#action-tool-receivers). +- If an action-tool request arrives and there is no registered handler or receiver to process it, the client can catch it using [OnUnhandledAction](#catching-action-tool-calls-with-no-callback) and decide how to address it. --- @@ -986,7 +986,7 @@ for the full picture.
-See [Handle](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-processing) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [Handle](#action-tool-processing) in the [Syntax](#syntax) section. --- @@ -1060,7 +1060,7 @@ Receivers are typically used asynchronously for multi-step or delayed operations
-See [Receive](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-processing), [AddActionResponse](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-processing), and [AiAgentActionRequest](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [Receive](#action-tool-processing), [AddActionResponse](#action-tool-processing), and [AiAgentActionRequest](#conversation-and-response-classes) in the [Syntax](#syntax) section. --- @@ -1085,7 +1085,7 @@ chat.OnUnhandledAction += async (args) => }; ```
-See [OnUnhandledAction](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-processing) and [UnhandledActionEventArgs](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [OnUnhandledAction](#action-tool-processing) and [UnhandledActionEventArgs](#conversation-and-response-classes) in the [Syntax](#syntax) section. @@ -1127,7 +1127,7 @@ This is useful, for example, when you want to pre-load the conversation with con } ```
-See [AddArtificialActionWithResponse](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-processing) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AddArtificialActionWithResponse](#action-tool-processing) in the [Syntax](#syntax) section. @@ -1143,7 +1143,7 @@ The `AiAnswer` object contains: - `Usage` - token usage counters for this turn. - `Elapsed` - total time taken to produce the answer. -See [AiAnswer](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes) and [AiConversationResult](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#enums) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AiAnswer](#conversation-and-response-classes) and [AiConversationResult](#enums) in the [Syntax](#syntax) section. @@ -1155,7 +1155,7 @@ Set the user prompt using the `SetUserPrompt` method, and run the conversation u `RunAsync` method. You can also use `StreamAsync` to **stream** the LLM's response as it is generated. -Learn how to do this in the [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) section. +Learn how to do this in the [Stream LLM responses](#stream-llm-responses) section. ```csharp @@ -1172,9 +1172,9 @@ if (response.Status == AiConversationResult.Done) } ```
-See [RunAsync](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-execution) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [RunAsync](#conversation-execution) in the [Syntax](#syntax) section. -See the full example [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example). +See the full example [below](#full-example). @@ -1244,14 +1244,14 @@ var response = await chat.RunAsync(CancellationToken.None); ```
-See [AddAttachment](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-execution) and [CopyAttachmentFrom](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-execution) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [AddAttachment](#conversation-execution) and [CopyAttachmentFrom](#conversation-execution) in the [Syntax](#syntax) section. -You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `StreamAsync` method, instead of using [RunAsync](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. +You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `StreamAsync` method, instead of using [RunAsync](#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. Streaming the response allows the client to start processing it before it is complete, which can improve the application's responsiveness. @@ -1281,7 +1281,7 @@ Streaming the response allows the client to start processing it before it is com } ```
-See [StreamAsync](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-execution) in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section. +See [StreamAsync](#conversation-execution) in the [Syntax](#syntax) section. @@ -2037,7 +2037,7 @@ public AiAgentConfiguration(string name, string connectionStringName, string sys | **OutputSchema** | `string` | A formal JSON schema describing the expected LLM response structure. If both `SampleObject` and `OutputSchema` are defined, only the schema is used. | | **Queries** | `List` | Query tools that the LLM can use (through the agent) to retrieve data from the database. | | **Actions** | `List` | Action tools that the LLM can use to trigger the client to action. | -| **SubAgents** | `List` | Other agents that this agent can invoke as sub-agents. See [Sub-agents as tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#sub-agents-as-tools). | +| **SubAgents** | `List` | Other agents that this agent can invoke as sub-agents. See [Sub-agents as tools](#sub-agents-as-tools). | | **Parameters** | `List` | Agent parameters whose values are provided by the client when a conversation is started. | | **ChatTrimming** | `AiAgentChatTrimmingConfiguration` | Configuration for summarizing the conversation to reduce token usage. | | **MaxModelIterationsPerCall** | `int?` | Maximum number of times the LLM can request tool usage in response to a single user prompt. | diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx index 558f6d700c..ca0f096c55 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx @@ -17,24 +17,24 @@ import Panel from "@site/src/components/Panel"; To create an AI agent from Studio, see [Creating AI agents - Studio](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx). * In this article: - * [Create a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) - * [Define the agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration) - * [Add agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools) - * [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) - * [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools) - * [Create the agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent) - * [Manage conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations) - * [Create a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) - * [Process action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests) - * [Action-tool handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - * [Action-tool receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers) - * [Set user prompt and RUN the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) - * [Handle the conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response) - * [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) - * [Full example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example) - * [Retrieve existing agents](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations) - * [Delete agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#delete-agent) - * [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) + * [Create a connection string](#creating-a-connection-string) + * [Define the agent](#defining-an-agent-configuration) + * [Add agent tools](#adding-agent-tools) + * [Query tools](#query-tools) + * [Action tools](#action-tools) + * [Create the agent](#creating-the-agent) + * [Manage conversations](#managing-conversations) + * [Create a conversation](#setting-a-conversation) + * [Process action-tool requests](#processing-action-tool-requests) + * [Action-tool handlers](#action-tool-handlers) + * [Action-tool receivers](#action-tool-receivers) + * [Set user prompt and RUN the conversation](#setting-user-prompt-and-running-the-conversation) + * [Handle the conversation response](#conversation-response) + * [Stream LLM responses](#stream-llm-responses) + * [Full example](#full-example) + * [Retrieve existing agents](#retrieving-existing-agent-configurations) + * [Delete agent](#delete-agent) + * [Syntax](#syntax) @@ -158,14 +158,14 @@ See the dedicated syntax sections in the following articles for full configurati * Then populate the object with your system prompt, agent settings, and tools. The following sections explain how to configure each component of the agent: - * [System prompt](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#system-prompt) - * [Agent name](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-name) - * [Agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-id) - * [Connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#connection-string) - * [Expected response format](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#expected-response-format) - * [Agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-parameters) - * [Maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#maximum-number-of-iterations) - * [Chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#chat-trimming-configuration) + * [System prompt](#system-prompt) + * [Agent name](#agent-name) + * [Agent ID](#agent-id) + * [Connection string](#connection-string) + * [Expected response format](#expected-response-format) + * [Agent parameters](#agent-parameters) + * [Maximum number of iterations](#maximum-number-of-iterations) + * [Chat trimming configuration](#chat-trimming-configuration) --- @@ -220,7 +220,7 @@ agentConfiguration.identifier = "reward-productive-employee"; ### Connection string -Provide the name of the connection string you created above in [Create a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string). +Provide the name of the connection string you created above in [Create a connection string](#creating-a-connection-string). ```js agentConfiguration.connectionStringName = connectionString.name; @@ -301,9 +301,9 @@ agent.OutputSchema = outputSchema: JSON.stringify({ Agent parameters let you define named placeholders for values used in queries inside query tools. At configuration time, you define the parameter name (e.g. `country`), -which you can then use in the RQL of your [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) as a placeholder (e.g. `$country`). +which you can then use in the RQL of your [query tools](#query-tools) as a placeholder (e.g. `$country`). The values for these parameters are Not set by the LLM - -you must provide the actual value at [conversation startup](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation). +you must provide the actual value at [conversation startup](#setting-a-conversation). When the agent is requested to execute a query that references an agent parameter, it replaces each placeholder with the corresponding value you provided at chat startup, before running the query. @@ -334,7 +334,7 @@ agentConfiguration.maxModelIterationsPerCall = 3; * Note that you can reduce Time To First Byte (TTFB) by streaming the LLM response as it is being generated. This allows the LLM to return selected fields in chunks before the full response is complete. * Find more about streaming in [Streaming LLM responses - overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) - and in [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) below. + and in [Stream LLM responses](#stream-llm-responses) below. @@ -389,13 +389,13 @@ agentConfiguration.chatTrimming = { * **RQL** - an [RQL query](../../../../querying/rql/what-is-rql.mdx) that defines what data to retrieve. * To run a query tool at agent startup and provide initial context to the LLM **before** the conversation begins, - see: [Initial-context queries](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#initial-context-queries) below. + see: [Initial-context queries](#initial-context-queries) below. * **Passing values to a query tool** The RQL in the query tool may include parameter placeholders prefixed with `$` (e.g. `$country`). Both the user and the LLM can pass values to these parameters. * **Passing values from the user**: - Users can pass values to queries through [Agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-parameters). + Users can pass values to queries through [Agent parameters](#agent-parameters). If agent parameters are defined in the agent configuration - * The client must provide values for them when initiating a conversation with the agent. * Before executing the query, the agent will replace the placeholders with the provided values. @@ -602,7 +602,7 @@ agentConfiguration.chatTrimming = { * Conversation creation options - including values for any agent parameters, if defined. * The object returned by `conversation` is used to run the chat. - See [Set user prompt and run the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation). + See [Set user prompt and run the conversation](#setting-user-prompt-and-running-the-conversation). * **Example** @@ -645,8 +645,8 @@ agentConfiguration.chatTrimming = { When this happens, the agent forwards the tool’s name and parameters to the client - and it’s up to the client to handle the request. -* The client can process an action-tool request using either a [Handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - or a [Receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers). +* The client can process an action-tool request using either a [Handler](#action-tool-handlers) + or a [Receiver](#action-tool-receivers). --- @@ -808,7 +808,7 @@ if (response.status === "Done") { Instead of `run`, you can use `stream` to **stream** the LLM's response as it is generated. -See [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses). +See [Stream LLM responses](#stream-llm-responses). diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx index 35f52f4c2f..1110ec9a62 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx @@ -16,30 +16,30 @@ import Panel from "@site/src/components/Panel"; * This page provides a step-by-step guide to creating an AI agent and interacting with it using the client API. * In this article: - * [Creating a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) - * [Defining an agent configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration) - * [Set the agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-the-agent-id) - * [Define a response object](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#define-a-response-object) - * [Add agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#add-agent-parameters) - * [Set maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-maximum-number-of-iterations) - * [Set chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-chat-trimming-configuration) - * [Adding agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools) - * [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) + * [Creating a connection string](#creating-a-connection-string) + * [Defining an agent configuration](#defining-an-agent-configuration) + * [Set the agent ID](#set-the-agent-id) + * [Define a response object](#define-a-response-object) + * [Add agent parameters](#add-agent-parameters) + * [Set maximum number of iterations](#set-maximum-number-of-iterations) + * [Set chat trimming configuration](#set-chat-trimming-configuration) + * [Adding agent tools](#adding-agent-tools) + * [Query tools](#query-tools) - * [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools) - * [Creating the Agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent) - * [Retrieving existing agent configurations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations) - * [Managing conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations) - * [Setting a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) - * [Processing action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests) - * [Action-tool Handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - * [Action-tool Receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers) - * [Conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response) - * [Setting user prompt and running the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) - * [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) - * [Full Example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example) + * [Action tools](#action-tools) + * [Creating the Agent](#creating-the-agent) + * [Retrieving existing agent configurations](#retrieving-existing-agent-configurations) + * [Managing conversations](#managing-conversations) + * [Setting a conversation](#setting-a-conversation) + * [Processing action-tool requests](#processing-action-tool-requests) + * [Action-tool Handlers](#action-tool-handlers) + * [Action-tool Receivers](#action-tool-receivers) + * [Conversation response](#conversation-response) + * [Setting user prompt and running the conversation](#setting-user-prompt-and-running-the-conversation) + * [Stream LLM responses](#stream-llm-responses) + * [Full Example](#full-example) @@ -160,7 +160,7 @@ Start by creating a new `AiAgentConfiguration` instance. While creating the instance, pass its constructor: - The agent's Name -- The [connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) you created +- The [connection string](#creating-a-connection-string) you created - A System prompt The agent will send the system prompt you define here to the LLM to define its basic characteristics, including its role, purpose, behavior, and the tools it can use. @@ -320,7 +320,7 @@ agent.output_schema = """ ### Add agent parameters -Agent parameters are parameters that can be used by [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) when the agent queries the database on behalf of the LLM. +Agent parameters are parameters that can be used by [query tools](#query-tools) when the agent queries the database on behalf of the LLM. Values for agent parameters are provided by the client, or by a user through the client, when a chat is started. When the agent is requested to use a query tool that uses agent parameters, it replaces these parameters with the values provided by the user before running the query. @@ -371,7 +371,7 @@ agent tools in response to a single user prompt. Use `max_model_iterations_per_c Note that you can improve the TTFB (Time To First Byte) by getting the LLM's response in chunks using streaming. -Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses). +Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). @@ -774,7 +774,7 @@ You can retrieve the configuration of **existing agents** using `get_agents`. | Property | Type | Description | |----------|------|-------------| | agent_id | `str` | The agent unique ID | - | conversation_id | `str` | The [conversation ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) | + | conversation_id | `str` | The [conversation ID](#setting-a-conversation) | | creation_options | `AiConversationCreationOptions` | Conversation creation options (see class definition below) | | change_vector | `str` | Optional change vector for concurrency control | @@ -819,7 +819,7 @@ During the conversation, the LLM can request the agent to trigger action tools. The agent will pass a requested action tool's name and parameters to the client, and it is then up to the client to process the request. -The client can process an action-tool request using a [handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) or a [receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers). +The client can process an action-tool request using a [handler](#action-tool-handlers) or a [receiver](#action-tool-receivers). #### Action-tool Handlers A **handler** is created for a specific action tool and registered with the server using the `handle` method. @@ -1039,7 +1039,7 @@ The LLM response is returned by the agent to the client in an `AiAnswer` object, Set the user prompt using the `set_user_prompt` method, and run the conversationusing `chat.run`. You can also use `chat.stream` to stream the LLM's response as it is generated. -Learn how to do this in the [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) section. +Learn how to do this in the [Stream LLM responses](#stream-llm-responses) section. ```python @@ -1056,14 +1056,14 @@ if response.status == AiConversationStatus.DONE: ``` -See the full example [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example). +See the full example [below](#full-example). -You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `chat.stream` method, instead of using [chat.run](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. +You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `chat.stream` method, instead of using [chat.run](#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. Streaming the response allows the client to start processing it before it is complete, which can improve the application's responsiveness. diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx index a515ae3465..9e741f5434 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx @@ -18,22 +18,22 @@ import ContentFrame from "@site/src/components/ContentFrame"; * In this article: - * [Create AI Agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#create-ai-agent) - * [Configure basic settings](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-basic-settings) - * [Set agent parameters](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#set-agent-parameters) - * [Define agent tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#define-agent-tools) - * [Add query tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#add-query-tools) - * [Add action tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#add-action-tools) - * [Define sub-agents](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#define-sub-agents) - * [Configure chat trimming](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-chat-trimming) - * [Save and Run your agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#save-and-run-your-agent) - * [Start new chat](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#start-new-chat) - * [Adding file attachments](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#adding-file-attachments) - * [Agent interaction](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#agent-interaction) - * [Action tool dialog](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#action-tool-dialog) - * [Agent results](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#agent-results) - * [Test your agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#test-your-agent) - * [Runtime view and Test results](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#runtime-view-and-test-results) + * [Create AI Agent](#create-ai-agent) + * [Configure basic settings](#configure-basic-settings) + * [Set agent parameters](#set-agent-parameters) + * [Define agent tools](#define-agent-tools) + * [Add query tools](#add-query-tools) + * [Add action tools](#add-action-tools) + * [Define sub-agents](#define-sub-agents) + * [Configure chat trimming](#configure-chat-trimming) + * [Save and Run your agent](#save-and-run-your-agent) + * [Start new chat](#start-new-chat) + * [Adding file attachments](#adding-file-attachments) + * [Agent interaction](#agent-interaction) + * [Action tool dialog](#action-tool-dialog) + * [Agent results](#agent-results) + * [Test your agent](#test-your-agent) + * [Runtime view and Test results](#runtime-view-and-test-results) diff --git a/docs/ai-integration/ai-agents/multi-agents.mdx b/docs/ai-integration/ai-agents/multi-agents.mdx index 04ccad99e3..0bdb31737c 100644 --- a/docs/ai-integration/ai-agents/multi-agents.mdx +++ b/docs/ai-integration/ai-agents/multi-agents.mdx @@ -35,22 +35,22 @@ import ContentFrame from "@site/src/components/ContentFrame"; An agent cannot create another agent at runtime. * In this article: - * [What is a multi-agents hierarchy](../../ai-integration/ai-agents/multi-agents.mdx#what-is-a-multi-agents-hierarchy) - * [Root, sub-agents, and the specialist pattern](../../ai-integration/ai-agents/multi-agents.mdx#root-sub-agents-and-the-specialist-pattern) - * [When to use a multi-agents hierarchy](../../ai-integration/ai-agents/multi-agents.mdx#when-to-use-a-multi-agents-hierarchy) - * [What a multi-agents hierarchy is not](../../ai-integration/ai-agents/multi-agents.mdx#what-a-multi-agents-hierarchy-is-not) - * [How a multi-agents hierarchy runs](../../ai-integration/ai-agents/multi-agents.mdx#how-a-multi-agents-hierarchy-runs) - * [Conversation flow across the hierarchy](../../ai-integration/ai-agents/multi-agents.mdx#conversation-flow-across-the-hierarchy) - * [Conversation documents and sub-conversation isolation](../../ai-integration/ai-agents/multi-agents.mdx#conversation-documents-and-sub-conversation-isolation) - * [Action tool routing back to the client](../../ai-integration/ai-agents/multi-agents.mdx#action-tool-routing-back-to-the-client) - * [Passing parameters through the hierarchy](../../ai-integration/ai-agents/multi-agents.mdx#passing-parameters-through-the-hierarchy) - * [Parameter propagation by name](../../ai-integration/ai-agents/multi-agents.mdx#parameter-propagation-by-name) - * [Parameters not declared on the root agent](../../ai-integration/ai-agents/multi-agents.mdx#parameters-not-declared-on-the-root-agent) - * [Parameter visibility to the LLM](../../ai-integration/ai-agents/multi-agents.mdx#parameter-visibility-to-the-llm) - * [Forbidding the parent from generating a parameter value](../../ai-integration/ai-agents/multi-agents.mdx#forbidding-the-parent-from-generating-a-parameter-value) - * [Security considerations specific to multi-agent setups](../../ai-integration/ai-agents/multi-agents.mdx#security-considerations-specific-to-multi-agent-setups) - * [Limitations](../../ai-integration/ai-agents/multi-agents.mdx#limitations) - * [Example](../../ai-integration/ai-agents/multi-agents.mdx#example) + * [What is a multi-agents hierarchy](#what-is-a-multi-agents-hierarchy) + * [Root, sub-agents, and the specialist pattern](#root-sub-agents-and-the-specialist-pattern) + * [When to use a multi-agents hierarchy](#when-to-use-a-multi-agents-hierarchy) + * [What a multi-agents hierarchy is not](#what-a-multi-agents-hierarchy-is-not) + * [How a multi-agents hierarchy runs](#how-a-multi-agents-hierarchy-runs) + * [Conversation flow across the hierarchy](#conversation-flow-across-the-hierarchy) + * [Conversation documents and sub-conversation isolation](#conversation-documents-and-sub-conversation-isolation) + * [Action tool routing back to the client](#action-tool-routing-back-to-the-client) + * [Passing parameters through the hierarchy](#passing-parameters-through-the-hierarchy) + * [Parameter propagation by name](#parameter-propagation-by-name) + * [Parameters not declared on the root agent](#parameters-not-declared-on-the-root-agent) + * [Parameter visibility to the LLM](#parameter-visibility-to-the-llm) + * [Forbidding the parent from generating a parameter value](#forbidding-the-parent-from-generating-a-parameter-value) + * [Security considerations specific to multi-agent setups](#security-considerations-specific-to-multi-agent-setups) + * [Limitations](#limitations) + * [Example](#example) @@ -135,7 +135,7 @@ When a client starts a conversation with the root agent: 2. The root agent processes the user's message. It decides, based on the message and the descriptions of its sub-agents, whether to invoke a sub-agent. 3. When the root agent invokes a sub-agent, the server opens a **sub-conversation** scoped to this sub-agent. The sub-agent receives the parameters it needs (see - [Parameter propagation by name](../../ai-integration/ai-agents/multi-agents.mdx#parameter-propagation-by-name)) and runs its own cycle: querying, reasoning, possibly invoking further sub-agents or action tools. + [Parameter propagation by name](#parameter-propagation-by-name)) and runs its own cycle: querying, reasoning, possibly invoking further sub-agents or action tools. 4. The sub-agent returns a concise result to the root agent. The root's LLM sees this result, not the sub-agent's full exchange with the model. @@ -168,7 +168,7 @@ This structure has two practical consequences: independently - for example, to see exactly what a validator agent decided and why. Parameter values travel with the conversation. All parameters provided when the conversation was started are stored on each conversation document in the chain, so a sub-agent can read the parameters it needs without the parent having to pass them explicitly each time. -What the LLM _sees_ is a separate question, covered in [Parameter visibility to the LLM](../../ai-integration/ai-agents/multi-agents.mdx#parameter-visibility-to-the-llm). +What the LLM _sees_ is a separate question, covered in [Parameter visibility to the LLM](#parameter-visibility-to-the-llm). @@ -218,10 +218,10 @@ parameter the sub-agent has declared in its configuration is resolved as follows inherited by the sub-agent. * If the parent does not have a matching parameter, and the conversation-creation options include a parameter with this name, that value is used (see - [Parameters not declared on the root agent](../../ai-integration/ai-agents/multi-agents.mdx#parameters-not-declared-on-the-root-agent)). + [Parameters not declared on the root agent](#parameters-not-declared-on-the-root-agent)). * Otherwise, the LLM on the parent side is asked to generate a value, unless the - sub-agent's parameter is marked with `ForbidModelGeneration` (see [Forbidding the parent from generating a parameter value](../../ai-integration/ai-agents/multi-agents.mdx#forbidding-the-parent-from-generating-a-parameter-value)). + sub-agent's parameter is marked with `ForbidModelGeneration` (see [Forbidding the parent from generating a parameter value](#forbidding-the-parent-from-generating-a-parameter-value)). The propagation is based on the parameter **name**: nothing else needs to be repeated. Two agents that declare a parameter called `userId` will naturally share values for this parameter when one invokes the other. @@ -250,7 +250,7 @@ var chat = store.AI.Conversation(rootAgentId, "chats/",
-The parameter is written into the conversation documents of agents that need it; whether the LLM at each level can see the value is governed by the rules in [Parameter visibility to the LLM](../../ai-integration/ai-agents/multi-agents.mdx#parameter-visibility-to-the-llm). +The parameter is written into the conversation documents of agents that need it; whether the LLM at each level can see the value is governed by the rules in [Parameter visibility to the LLM](#parameter-visibility-to-the-llm). diff --git a/docs/ai-integration/ai-agents/overview.mdx b/docs/ai-integration/ai-agents/overview.mdx index 0e7daf60ec..48a9c68fc1 100644 --- a/docs/ai-integration/ai-agents/overview.mdx +++ b/docs/ai-integration/ai-agents/overview.mdx @@ -17,7 +17,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; # AI agents: Overview -* An AI agent is a highly customizable [mediation component](../../ai-integration/ai-agents/overview.mdx#ai-agent-usage-flowchart) that an authorized client can tailor to its needs and install on the server. The agent serves the client by facilitating communication between the client, an LLM, and a RavenDB database. +* An AI agent is a highly customizable [mediation component](#ai-agent-usage-flowchart) that an authorized client can tailor to its needs and install on the server. The agent serves the client by facilitating communication between the client, an LLM, and a RavenDB database. * Clients can use AI agents to automate complex workflows by leveraging LLM capabilities such as data analysis, decision-making, and natural language processing. @@ -28,15 +28,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Delegating the communication with the LLM to an AI agent can significantly reduce client code complexity and development overhead. * In this article: - * [Defining and running AI agents](../../ai-integration/ai-agents/overview.mdx#defining-and-running-an-ai-agent) - * [The main stages in defining an AI agent](../../ai-integration/ai-agents/overview.mdx#the-main-stages-in-defining-an-ai-agent) - * [What is a conversation](../../ai-integration/ai-agents/overview.mdx#what-is-a-conversation) - * [Initiating a conversation](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation) - * [AI agent usage flowchart](../../ai-integration/ai-agents/overview.mdx#ai-agent-usage-flowchart) - * [Streaming LLM responses](../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) - * [Reducing throughput and expediting LLM response](../../ai-integration/ai-agents/overview.mdx#reducing-throughput-and-expediting-llm-response) - * [Multi-agents](../../ai-integration/ai-agents/overview.mdx#multi-agents) - * [Common use cases](../../ai-integration/ai-agents/overview.mdx#common-use-cases) + * [Defining and running AI agents](#defining-and-running-an-ai-agent) + * [The main stages in defining an AI agent](#the-main-stages-in-defining-an-ai-agent) + * [What is a conversation](#what-is-a-conversation) + * [Initiating a conversation](#initiating-a-conversation) + * [AI agent usage flowchart](#ai-agent-usage-flowchart) + * [Streaming LLM responses](#streaming-llm-responses) + * [Reducing throughput and expediting LLM response](#reducing-throughput-and-expediting-llm-response) + * [Multi-agents](#multi-agents) + * [Common use cases](#common-use-cases) @@ -83,7 +83,7 @@ To define an AI agent, the client needs to specify: The LLM will be able to invoke query tools freely to retrieve data from the database. * **Read-only operations** Query tools can apply **read operations** only. - To make changes in the database, use [action tools](../../ai-integration/ai-agents/overview.mdx#action-tools). + To make changes in the database, use [action tools](#action-tools). Note that actions can be performed only by the client. The LLM can just request the client to perform actions on its behalf. @@ -114,7 +114,7 @@ To define an AI agent, the client needs to specify: ### What is a conversation A conversation is a communication session between the client, the agent, and the LLM that maintains the history of messages exchanged between these participants since the conversation began. -* The conversation starts when the client invokes the agent and provides it with an [initial context](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation). +* The conversation starts when the client invokes the agent and provides it with an [initial context](#initiating-a-conversation). * The conversation may include multiple "turns" of message exchanges between the client and the LLM, mediated by the agent. * Each turn starts with a new **user prompt** from the client. * During the turn, the LLM can trigger the agent to run queries or request the client to perform actions, using [defined query and action tools](../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools). @@ -137,12 +137,12 @@ A conversation is a communication session between the client, the agent, and the To start a conversation with the LLM, the agent will send to the LLM an **initial context** that includes - -* The pre-defined [agent configuration](../../ai-integration/ai-agents/overview.mdx#the-main-stages-in-defining-an-ai-agent) (automatically sent by the agent) with: +* The pre-defined [agent configuration](#the-main-stages-in-defining-an-ai-agent) (automatically sent by the agent) with: * The system prompt * A response object that defines the layout for the LLM response * Optional agent parameters * Optional Query tools - (and if any query tool is configured as an [initial-context query](../../ai-integration/ai-agents/overview.mdx#initial-context-queries) - results for this query) + (and if any query tool is configured as an [initial-context query](#initial-context-queries) - results for this query) * Optional Action tools * **Values for agent parameters** @@ -201,7 +201,7 @@ The flowchart below illustrates interactions between the User, RavenDB client, A The client can interact with the database directly, either by its own initiative or as a result of AI agent action requests (query requests are handled by the agent). 3. **Client`<->`Agent** flow - * To invoke an agent, the client needs to provide it with an [initial context](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation). + * To invoke an agent, the client needs to provide it with an [initial context](#initiating-a-conversation). * During the conversation, the agent may send to the client action requests on behalf of the LLM. * When the LLM provides the agent with its final response, the agent will provide it to the client. The client does not need to reply to this message. @@ -215,7 +215,7 @@ The flowchart below illustrates interactions between the User, RavenDB client, A * When the agent is requested to run a query that includes _LLM parameters_, it will replace these parameters with values provided by the LLM before running the query. 5. **Agent`<->`Model** flow - * **When a conversation is started**, the agent needs to provide the AI model with an [initial context](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation), partly defined by the agent configuration and partly by the client. + * **When a conversation is started**, the agent needs to provide the AI model with an [initial context](#initiating-a-conversation), partly defined by the agent configuration and partly by the client. * **During the conversation**, the AI model can respond to the agent with - * Requests for queries. If a query includes LLM parameters, the LLM will include values for them, and the agent will replace the parameters with these values, run the query, and return its results to the LLM. diff --git a/docs/ai-integration/ai-agents/security-concerns.mdx b/docs/ai-integration/ai-agents/security-concerns.mdx index 7592ce18a8..3c3719a860 100644 --- a/docs/ai-integration/ai-agents/security-concerns.mdx +++ b/docs/ai-integration/ai-agents/security-concerns.mdx @@ -20,13 +20,13 @@ import ContentFrame from "@site/src/components/ContentFrame"; This page covers potential security concerns related to AI agents and the mitigation strategies for these concerns. * On this page: - * [Unauthorized database access](../../ai-integration/ai-agents/security-concerns.mdx#unauthorized-database-access) - * [Data compromise during transit](../../ai-integration/ai-agents/security-concerns.mdx#data-compromise-during-transit) - * [Untraceable malicious or unexpected actions](../../ai-integration/ai-agents/security-concerns.mdx#untraceable-malicious-or-unexpected-actions) - * [AI model data memorization](../../ai-integration/ai-agents/security-concerns.mdx#ai-model-data-memorization) - * [Validation or injection attacks via user input](../../ai-integration/ai-agents/security-concerns.mdx#validation-or-injection-attacks-via-user-input) - * [LLM exposure in multi-agent setups](../../ai-integration/ai-agents/security-concerns.mdx#llm-exposure-in-multi-agent-setups) - * [Runaway iterations in multi-agent setups](../../ai-integration/ai-agents/security-concerns.mdx#runaway-iterations-in-multi-agent-setups) + * [Unauthorized database access](#unauthorized-database-access) + * [Data compromise during transit](#data-compromise-during-transit) + * [Untraceable malicious or unexpected actions](#untraceable-malicious-or-unexpected-actions) + * [AI model data memorization](#ai-model-data-memorization) + * [Validation or injection attacks via user input](#validation-or-injection-attacks-via-user-input) + * [LLM exposure in multi-agent setups](#llm-exposure-in-multi-agent-setups) + * [Runaway iterations in multi-agent setups](#runaway-iterations-in-multi-agent-setups) diff --git a/docs/ai-integration/ai-tasks-list-view.mdx b/docs/ai-integration/ai-tasks-list-view.mdx index f6853ea921..5f33c41d64 100644 --- a/docs/ai-integration/ai-tasks-list-view.mdx +++ b/docs/ai-integration/ai-tasks-list-view.mdx @@ -31,7 +31,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; See the [Task errors overview](../monitoring/task-errors/overview.mdx) for an introduction. * In this article: - * [AI Tasks - list view](../ai-integration/ai-tasks-list-view.mdx#ai-tasks---list-view) + * [AI Tasks - list view](#ai-tasks---list-view) diff --git a/docs/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx b/docs/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx index 3a527ab834..dce36e8983 100644 --- a/docs/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -70,7 +70,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Deployment Name_, and _Model_ name. * Additional settings specific to chat models are: _Prompt Cache Key_ & _Temperature_. diff --git a/docs/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx b/docs/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx index 9b92ea1ee9..1e659efc88 100644 --- a/docs/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -70,7 +70,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Deployment Name_, and _Model_ name. * Additional settings specific to chat models are: _Prompt Cache Key_ & _Temperature_. diff --git a/docs/ai-integration/connection-strings/content/_azure-open-ai-python.mdx b/docs/ai-integration/connection-strings/content/_azure-open-ai-python.mdx index c4bd9d48c1..3e5cc6fc70 100644 --- a/docs/ai-integration/connection-strings/content/_azure-open-ai-python.mdx +++ b/docs/ai-integration/connection-strings/content/_azure-open-ai-python.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -70,7 +70,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Deployment Name_, and _Model_ name. * Additional settings specific to chat models are: _Prompt Cache Key_ & _Temperature_. diff --git a/docs/ai-integration/connection-strings/content/_embedded-csharp.mdx b/docs/ai-integration/connection-strings/content/_embedded-csharp.mdx index d46702d5c9..690d8ced66 100644 --- a/docs/ai-integration/connection-strings/content/_embedded-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_embedded-csharp.mdx @@ -15,9 +15,9 @@ import Panel from '@site/src/components/Panel'; depending on your workload and usage patterns. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/embedded.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_embedded-nodejs.mdx b/docs/ai-integration/connection-strings/content/_embedded-nodejs.mdx index d0eebfe0fc..017523f1b9 100644 --- a/docs/ai-integration/connection-strings/content/_embedded-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_embedded-nodejs.mdx @@ -15,9 +15,9 @@ import Panel from '@site/src/components/Panel'; depending on your workload and usage patterns. * In this article: - * [Define the connection string - from the Studio](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-the-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/embedded.mdx#syntax) + * [Define the connection string - from the Studio](#define-the-connection-string-from-the-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_embedded-python.mdx b/docs/ai-integration/connection-strings/content/_embedded-python.mdx index 96d85e28a5..ffe8d6016b 100644 --- a/docs/ai-integration/connection-strings/content/_embedded-python.mdx +++ b/docs/ai-integration/connection-strings/content/_embedded-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; depending on your workload and usage patterns. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/embedded.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_google-ai-csharp.mdx b/docs/ai-integration/connection-strings/content/_google-ai-csharp.mdx index b9ea0b009e..d13b4742a1 100644 --- a/docs/ai-integration/connection-strings/content/_google-ai-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_google-ai-csharp.mdx @@ -14,11 +14,11 @@ import Panel from '@site/src/components/Panel'; * This configuration is not compatible with Vertex AI endpoints or credentials. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/google-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -69,7 +69,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _AI Version_, _API Key_, _Endpoint_, and _Model_ name. * One additional setting is specific to chat models: _Prompt Cache Key_. diff --git a/docs/ai-integration/connection-strings/content/_google-ai-nodejs.mdx b/docs/ai-integration/connection-strings/content/_google-ai-nodejs.mdx index bb3da23774..3ae39553b9 100644 --- a/docs/ai-integration/connection-strings/content/_google-ai-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_google-ai-nodejs.mdx @@ -14,11 +14,11 @@ import Panel from '@site/src/components/Panel'; * This configuration is not compatible with Vertex AI endpoints or credentials. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/google-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -69,7 +69,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _AI Version_, _API Key_, _Endpoint_, and _Model_ name. * One additional setting is specific to chat models: _Prompt Cache Key_. diff --git a/docs/ai-integration/connection-strings/content/_google-ai-python.mdx b/docs/ai-integration/connection-strings/content/_google-ai-python.mdx index d56ee9b5b2..18f934c311 100644 --- a/docs/ai-integration/connection-strings/content/_google-ai-python.mdx +++ b/docs/ai-integration/connection-strings/content/_google-ai-python.mdx @@ -14,11 +14,11 @@ import Panel from '@site/src/components/Panel'; * This configuration is not compatible with Vertex AI endpoints or credentials. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/google-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -69,7 +69,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/google-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _AI Version_, _API Key_, _Endpoint_, and _Model_ name. * One additional setting is specific to chat models: _Prompt Cache Key_. diff --git a/docs/ai-integration/connection-strings/content/_hugging-face-csharp.mdx b/docs/ai-integration/connection-strings/content/_hugging-face-csharp.mdx index 4e98139012..efb6154fa4 100644 --- a/docs/ai-integration/connection-strings/content/_hugging-face-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_hugging-face-csharp.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/hugging-face.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx b/docs/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx index 41a832e388..04ea40133a 100644 --- a/docs/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/hugging-face.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_hugging-face-python.mdx b/docs/ai-integration/connection-strings/content/_hugging-face-python.mdx index d23ae6bd8a..f7e42145b7 100644 --- a/docs/ai-integration/connection-strings/content/_hugging-face-python.mdx +++ b/docs/ai-integration/connection-strings/content/_hugging-face-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/hugging-face.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx b/docs/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx index 72e86d7f40..26f0691050 100644 --- a/docs/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/mistral-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx b/docs/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx index 638f5c4d32..9cfecfeabd 100644 --- a/docs/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/mistral-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_mistral-ai-python.mdx b/docs/ai-integration/connection-strings/content/_mistral-ai-python.mdx index d4e64d5308..80c1885291 100644 --- a/docs/ai-integration/connection-strings/content/_mistral-ai-python.mdx +++ b/docs/ai-integration/connection-strings/content/_mistral-ai-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/mistral-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_ollama-csharp.mdx b/docs/ai-integration/connection-strings/content/_ollama-csharp.mdx index d96a0903ea..9ba1319062 100644 --- a/docs/ai-integration/connection-strings/content/_ollama-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_ollama-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/ollama.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -58,7 +58,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _URI_, and _Model_ name. * In addition, two fields are specific to chat models: _Temperature_ and _Thinking mode_. diff --git a/docs/ai-integration/connection-strings/content/_ollama-nodejs.mdx b/docs/ai-integration/connection-strings/content/_ollama-nodejs.mdx index c8fd1aca3d..36721e9b5f 100644 --- a/docs/ai-integration/connection-strings/content/_ollama-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_ollama-nodejs.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/ollama.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -58,7 +58,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _URI_, and _Model_ name. * In addition, two fields are specific to chat models: _Temperature_ and _Thinking mode_. diff --git a/docs/ai-integration/connection-strings/content/_ollama-python.mdx b/docs/ai-integration/connection-strings/content/_ollama-python.mdx index bcc06c8dbf..4ec155873e 100644 --- a/docs/ai-integration/connection-strings/content/_ollama-python.mdx +++ b/docs/ai-integration/connection-strings/content/_ollama-python.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string---from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/ollama.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) @@ -54,7 +54,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _URI_, and _Model_ name. * In addition, two fields are specific to chat models: _Temperature_ and _Thinking mode_. diff --git a/docs/ai-integration/connection-strings/content/_open-ai-csharp.mdx b/docs/ai-integration/connection-strings/content/_open-ai-csharp.mdx index a0a3476279..1f21544ca6 100644 --- a/docs/ai-integration/connection-strings/content/_open-ai-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_open-ai-csharp.mdx @@ -15,11 +15,11 @@ import Panel from '@site/src/components/Panel'; As long as the provider follows the OpenAI API format, RavenDB will be able to use it for Embeddings generation, Gen AI tasks, and chat-based agent interactions. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-mode), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-mode), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Model_ name, _Organization ID_, and _Project ID_. * Additional settings specific to chat models are: _Prompt Cache Key_ & _Temperature_. diff --git a/docs/ai-integration/connection-strings/content/_open-ai-nodejs.mdx b/docs/ai-integration/connection-strings/content/_open-ai-nodejs.mdx index 12a44cf2a2..417ab7b63d 100644 --- a/docs/ai-integration/connection-strings/content/_open-ai-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_open-ai-nodejs.mdx @@ -15,11 +15,11 @@ import Panel from '@site/src/components/Panel'; As long as the provider follows the OpenAI API format, RavenDB will be able to use it for Embeddings generation, Gen AI tasks, and chat-based agent interactions. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-mode), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-mode), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Model_ name, _Organization ID_, and _Project ID_. * Additional settings specific to chat models are: _Prompt Cache Key_ & _Temperature_. diff --git a/docs/ai-integration/connection-strings/content/_open-ai-python.mdx b/docs/ai-integration/connection-strings/content/_open-ai-python.mdx index 9e58e8026d..10b3b0dcb4 100644 --- a/docs/ai-integration/connection-strings/content/_open-ai-python.mdx +++ b/docs/ai-integration/connection-strings/content/_open-ai-python.mdx @@ -15,11 +15,11 @@ import Panel from '@site/src/components/Panel'; As long as the provider follows the OpenAI API format, RavenDB will be able to use it for Embeddings generation, Gen AI tasks, and chat-based agent interactions. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-mode), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-mode), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Model_ name, _Organization ID_, and _Project ID_. * Additional settings specific to chat models are: _Prompt Cache Key_ & _Temperature_. diff --git a/docs/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx b/docs/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx index b223ea7037..4219f6d737 100644 --- a/docs/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx +++ b/docs/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/vertex-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx b/docs/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx index c70b6ad20b..5636c14e7d 100644 --- a/docs/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx +++ b/docs/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/vertex-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/content/_vertex-ai-python.mdx b/docs/ai-integration/connection-strings/content/_vertex-ai-python.mdx index 33d2450e10..0bfb17da8c 100644 --- a/docs/ai-integration/connection-strings/content/_vertex-ai-python.mdx +++ b/docs/ai-integration/connection-strings/content/_vertex-ai-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/vertex-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/docs/ai-integration/connection-strings/overview.mdx b/docs/ai-integration/connection-strings/overview.mdx index 7cd42e4adc..30ab4abea8 100644 --- a/docs/ai-integration/connection-strings/overview.mdx +++ b/docs/ai-integration/connection-strings/overview.mdx @@ -49,8 +49,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; --- * In this article: - * [The AI Connection Strings view](../../ai-integration/connection-strings/overview.mdx#the-ai-connection-strings-view) - * [Creating an AI connection string (from Studio)](../../ai-integration/connection-strings/overview.mdx#creating-an-ai-connection-string-from-studio) + * [The AI Connection Strings view](#the-ai-connection-strings-view) + * [Creating an AI connection string (from Studio)](#creating-an-ai-connection-string-from-studio) diff --git a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx index 45b92702a0..657853dabf 100644 --- a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx +++ b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx @@ -21,7 +21,7 @@ import Panel from "@site/src/components/Panel"; 5. And finally, runs a user-defined script that potentially acts upon the results. * The main steps in defining a GenAI task are: - * Defining a [Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) + * Defining a [Connection string](#defining-a-connection-string) to the AI model * Defining a [Context generation script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) * Defining a [Prompt](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt) @@ -29,9 +29,9 @@ import Panel from "@site/src/components/Panel"; * Defining an [Update script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) * In this article: - * [Defining a Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) - * [Defining the GenAI task](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-the-genai-task) - * [Full example](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#full-example) + * [Defining a Connection string](#defining-a-connection-string) + * [Defining the GenAI task](#defining-the-genai-task) + * [Full example](#full-example) diff --git a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx index ccf21c3e19..d661c2cab2 100644 --- a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx +++ b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; 5. Runs a user-defined script that may act on those results. * The main steps in defining a GenAI task are: - * Defining a [Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#define-a-connection-string) + * Defining a [Connection string](#define-a-connection-string) to the AI model * Defining a [Context generation script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) * Defining a [Prompt](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt) @@ -28,10 +28,10 @@ import Panel from "@site/src/components/Panel"; * Defining an [Update script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) * In this article: - * [Define a connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#define-a-connection-string) - * [Define the GenAI task](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#define-the-genai-task) - * [Full example](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#full-example) - * [Syntax](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#syntax) + * [Define a connection string](#define-a-connection-string) + * [Define the GenAI task](#define-the-genai-task) + * [Full example](#full-example) + * [Syntax](#syntax) diff --git a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx index 450f12c126..2eb10acf59 100644 --- a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx +++ b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx @@ -21,7 +21,7 @@ import Panel from "@site/src/components/Panel"; 5. And finally, runs a user-defined script that potentially acts upon the results. * The main steps in defining a GenAI task are: - * Defining a [Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) + * Defining a [Connection string](#defining-a-connection-string) to the AI model * Defining a [Context generation script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) * Defining a [Prompt](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt) @@ -29,9 +29,9 @@ import Panel from "@site/src/components/Panel"; * Defining an [Update script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) * In this article: - * [Defining a Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) - * [Defining the GenAI task](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-the-genai-task) - * [Full example](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#full-example) + * [Defining a Connection string](#defining-a-connection-string) + * [Defining the GenAI task](#defining-the-genai-task) + * [Full example](#full-example) diff --git a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx index 5fea49e522..32b7b61c0f 100644 --- a/docs/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx +++ b/docs/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx @@ -16,13 +16,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: - * [The GenAI Task wizard](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#the-genai-task-wizard) - * [Add a GenAI Task](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#add-a-genai-task) - * [Configure basic settings](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#configure-basic-settings) - * [Generate context objects](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#generate-context-objects) - * [Define Prompt and JSON schema](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#define-prompt-and-json-schema) - * [Provide update script](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#provide-update-script) - * [Review configuration and Save task](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#review-configuration-and-save-task) + * [The GenAI Task wizard](#the-genai-task-wizard) + * [Add a GenAI Task](#add-a-genai-task) + * [Configure basic settings](#configure-basic-settings) + * [Generate context objects](#generate-context-objects) + * [Define Prompt and JSON schema](#define-prompt-and-json-schema) + * [Provide update script](#provide-update-script) + * [Review configuration and Save task](#review-configuration-and-save-task) @@ -171,7 +171,7 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * **Select a document from the source collection** Select a document to test your context generation script on. * To use the same sample document we're using to demonstrate the process, - add [posts/1](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#sample-data) and select it here. + add [posts/1](#sample-data) and select it here. * Or if you prefer it, click `enter a document manually` and enter the sample document content yourself. * To run the test, click the **Test context** button. If all works well, you will see a list of context objects created by your script, one for each comment. @@ -182,7 +182,7 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Configure basic settings](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#configure-basic-settings). + Click to return to the previous step, [Configure basic settings](#configure-basic-settings). * **Test Context** Click to test your context generation script on the document selected/entered in the playground area. * You do not have to use the playground; you'll be able to define and save your task without testing @@ -190,7 +190,7 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * However, running the test here will allow you to use the generated result set in the playground of the next wizard step. * **Next** - Click to advance to the next step, [Define prompt & JSON schema](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#define-prompt-and-json-schema). + Click to advance to the next step, [Define prompt & JSON schema](#define-prompt-and-json-schema).
@@ -289,12 +289,12 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Generate context objects](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#generate-context-objects). + Click to return to the previous step, [Generate context objects](#generate-context-objects). * **Test Context** Click to test the prompt and JSON schema you define above, on the context objects generated from the document you provided. * **Next** - Click to advance to the next step, [Provide update script](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#provide-update-script). + Click to advance to the next step, [Provide update script](#provide-update-script).
@@ -340,14 +340,14 @@ The update script set in this step, determines what actions should be taken on t * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Define Prompt and JSON schema](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#define-prompt-and-json-schema). + Click to return to the previous step, [Define Prompt and JSON schema](#define-prompt-and-json-schema). * **Test Context** Click to test the update script you define above. Note that even though in our case we remove comments from existing documents, the update script can leave the original document unchanged, create new documents, and so on - as you choose. * **Next** - Click to advance to the next step, [Review configuration and Save task](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#review-configuration-and-save-task). + Click to advance to the next step, [Review configuration and Save task](#review-configuration-and-save-task).
@@ -373,7 +373,7 @@ If your task is enabled, it will start running when you save it. * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Provide update script](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#provide-update-script). + Click to return to the previous step, [Provide update script](#provide-update-script). * **Save** Click to save your task. If enabled, saving the task will start its execution. diff --git a/docs/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx b/docs/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx index e12428dd5c..c83fb2dc41 100644 --- a/docs/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx +++ b/docs/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx @@ -20,7 +20,7 @@ regarding the safety of data sent to an AI model through the task and the security of the database while running such tasks. * In this article: - * [Security measures](../../ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx#security-measures) + * [Security measures](#security-measures) ## Security measures diff --git a/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx b/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx index 23f713eeaa..4fe32ed6c5 100644 --- a/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx +++ b/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx @@ -16,8 +16,8 @@ import Panel from "@site/src/components/Panel"; See the examples below to learn how to extract the `TaskID` and use it to register the modified task configuration. * In this article: - * [Modify task configuration](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#modify-task-configuration) - * [Syntax](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#syntax) + * [Modify task configuration](#modify-task-configuration) + * [Syntax](#syntax) diff --git a/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx b/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx index 0e72ee03af..ae23735217 100644 --- a/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx +++ b/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx @@ -25,8 +25,8 @@ import Panel from "@site/src/components/Panel"; See the examples below to learn how to extract the _taskID_ and use it to register the modified task configuration. * In this article: - * [Modify task configuration](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#modify-task-configuration) - * [Syntax](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#syntax) + * [Modify task configuration](#modify-task-configuration) + * [Syntax](#syntax) diff --git a/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx b/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx index 077b2ba47c..38717adde2 100644 --- a/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx +++ b/docs/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx @@ -16,8 +16,8 @@ import Panel from "@site/src/components/Panel"; See the examples below to learn how to extract the `task_id` and use it to register the modified task configuration. * In this article: - * [Modify task configuration](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#modify-task-configuration) - * [Syntax](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#syntax) + * [Modify task configuration](#modify-task-configuration) + * [Syntax](#syntax) diff --git a/docs/ai-integration/gen-ai-integration/overview.mdx b/docs/ai-integration/gen-ai-integration/overview.mdx index d99d42a71d..26a345b522 100644 --- a/docs/ai-integration/gen-ai-integration/overview.mdx +++ b/docs/ai-integration/gen-ai-integration/overview.mdx @@ -22,21 +22,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; While creating a GenAI task via Studio, a smart interactive **test environment** is provided, allowing each phase of the task to be tested in a secluded playground, freely and without changing your data, while at the same time producing a result set that can be tried out by the next phase. * A task can be built in minutes, e.g. to generate automated responses to frequently asked questions, escalate support tickets, summarize lengthy documents, enhance data security by detecting anomalies, or numerous other applications. - See a few additional examples in the [common use cases](../../ai-integration/gen-ai-integration/overview.mdx#common-use-cases) section below. + See a few additional examples in the [common use cases](#common-use-cases) section below. * You can use local and remote AI models, e.g. a local `Ollama llama3.2` service during a development phase that requires speed and no additional costs, and a remote `OpenAI gpt-4o-mini` when you need a live service with advanced capabilities. * In this article: - * [RavenDB GenAI tasks](../../ai-integration/gen-ai-integration/overview.mdx#ravendb-genai-tasks) - * [The flow](../../ai-integration/gen-ai-integration/overview.mdx#the-flow) - * [The elements](../../ai-integration/gen-ai-integration/overview.mdx#the-elements) - * [How to create and run a GenAI task](../../ai-integration/gen-ai-integration/overview.mdx#how-to-create-and-run-a-genai-task) - * [Runtime](../../ai-integration/gen-ai-integration/overview.mdx#runtime) - * [Tracking of processed document parts](../../ai-integration/gen-ai-integration/overview.mdx#tracking-of-processed-document-parts) - * [Monitoring the tasks](../../ai-integration/gen-ai-integration/overview.mdx#monitoring-the-tasks) - * [Licensing](../../ai-integration/gen-ai-integration/overview.mdx#licensing) - * [Supported services](../../ai-integration/gen-ai-integration/overview.mdx#supported-services) - * [Common use cases](../../ai-integration/gen-ai-integration/overview.mdx#common-use-cases) + * [RavenDB GenAI tasks](#ravendb-genai-tasks) + * [The flow](#the-flow) + * [The elements](#the-elements) + * [How to create and run a GenAI task](#how-to-create-and-run-a-genai-task) + * [Runtime](#runtime) + * [Tracking of processed document parts](#tracking-of-processed-document-parts) + * [Monitoring the tasks](#monitoring-the-tasks) + * [Licensing](#licensing) + * [Supported services](#supported-services) + * [Common use cases](#common-use-cases) @@ -53,18 +53,18 @@ Let's put the stages described above in order. 1. A GenAI task continuously monitors the collection it is associated with. 2. When a document is added or modified, the task retrieves it. 3. The task generates context objects based on the source document data. - To generate these objects, the task applies a user-defined [context generation script](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) + To generate these objects, the task applies a user-defined [context generation script](#the-elements_context-objects) that runs through the source document and generates context objects based on the document data. 4. The task sends each context object to a GenAI model for processing. * The task is associated with a [Connection string](../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#studio_connection-string) that defines how to connect to the AI model. * Each context object is sent via a separate connection to the AI model. (note that the number of concurrent connections to the AI model is configurable via the [MaxConcurrency](../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#genaiconfiguration) setting.) - * Each context object is sent along with a user-defined [Prompt](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt), + * Each context object is sent along with a user-defined [Prompt](#the-elements_prompt), that instructs the AI model what to do with the data, and - a user-defined [JSON schema](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_json-schema) + a user-defined [JSON schema](#the-elements_json-schema) that instructs the AI model how to shape its response. -5. When the AI model returns its response, a user-defined [Update script](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) +5. When the AI model returns its response, a user-defined [Update script](#the-elements_update-script) is applied to handle the results. ### The elements: diff --git a/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx b/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx index 27adbb822c..4a487b8ba6 100644 --- a/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx +++ b/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; PDF files are sent to the LLM in base64-encoded strings. * In this article: - * [Sending attachments to the LLM](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_api.mdx#sending-attachments-to-the-llm) + * [Sending attachments to the LLM](#sending-attachments-to-the-llm) diff --git a/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx b/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx index a645b9b790..05304a52a0 100644 --- a/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx +++ b/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx @@ -24,7 +24,7 @@ import Panel from "@site/src/components/Panel"; is available in [Processing attachments: Studio](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx). * In this article: - * [Sending attachments to the LLM - via the Client API](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_api.mdx#sending-attachments-to-the-llm) + * [Sending attachments to the LLM - via the Client API](#sending-attachments-to-the-llm) diff --git a/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx b/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx index 5acf7b92da..715da967c6 100644 --- a/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx +++ b/docs/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; PDF files are sent to the LLM in base64-encoded strings. * In this article: - * [Sending attachments to the LLM](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_api.mdx#sending-attachments-to-the-llm) + * [Sending attachments to the LLM](#sending-attachments-to-the-llm) diff --git a/docs/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx b/docs/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx index 66e43c7c47..1e73583ffb 100644 --- a/docs/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx +++ b/docs/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx @@ -31,13 +31,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; E.g., to process image files you can use OpenAI's `gpt-4.1-mini` model. * In this article: - * [Include attachments in the Context generation script](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#include-attachments-in-the-context-generation-script) - * [Conditional attachment](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#conditional-attachment) - * [Multiple attachments](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#multiple-attachments) - * [Embedding base64-encoded images in the context object](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#embedding-base64-encoded-images-in-the-context-object) - * [Embedding text in the context object](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#embedding-text-in-the-context-object) - * [Set task Prompt and JSON schema](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#set-task-prompt-and-json-schema) - * [Set task Update script](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#set-task-update-script) + * [Include attachments in the Context generation script](#include-attachments-in-the-context-generation-script) + * [Conditional attachment](#conditional-attachment) + * [Multiple attachments](#multiple-attachments) + * [Embedding base64-encoded images in the context object](#embedding-base64-encoded-images-in-the-context-object) + * [Embedding text in the context object](#embedding-text-in-the-context-object) + * [Set task Prompt and JSON schema](#set-task-prompt-and-json-schema) + * [Set task Update script](#set-task-update-script) diff --git a/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx b/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx index 5a5dcdd8d8..ec3cee2bf6 100644 --- a/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx +++ b/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx @@ -16,13 +16,13 @@ import Panel from '@site/src/components/Panel'; to understand the embeddings generation process flow. * In this article: - * [Configuring an embeddings generation task - from the Studio](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-studio) - * [Configuring an embeddings generation task - from the Client API](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-client-api) - * [Define source using PATHS](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-paths) - * [Define source using SCRIPT](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) - * [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) - * [Adding a context prefix to chunks](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#adding-a-context-prefix-to-chunks) - * [Syntax](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#syntax) + * [Configuring an embeddings generation task - from the Studio](#configuring-an-embeddings-generation-task-from-the-studio) + * [Configuring an embeddings generation task - from the Client API](#configuring-an-embeddings-generation-task-from-the-client-api) + * [Define source using PATHS](#configure-an-embeddings-generation-task---define-source-using-paths) + * [Define source using SCRIPT](#configure-an-embeddings-generation-task---define-source-using-script) + * [Chunking methods and tokens](#chunking-methods-and-tokens) + * [Adding a context prefix to chunks](#adding-a-context-prefix-to-chunks) + * [Syntax](#syntax) @@ -85,7 +85,7 @@ import Panel from '@site/src/components/Panel'; Enter the property name from the document that contains the text for embedding generation. * **Chunking method** Select the method for splitting the source text into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). * **Overlap tokens** @@ -105,7 +105,7 @@ import Panel from '@site/src/components/Panel'; 1. **Embeddings source** Select `Script` to define the source content and chunking methods using a JavaScript script. 2. **Script** - Refer to section [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) for available JavaScript methods. + Refer to section [Chunking methods and tokens](#chunking-methods-and-tokens) for available JavaScript methods. 3. **Default chunking method** The selected chunking method will be used by default when no method is specified in the script. e.g., when the script contains: `Name: this.Name`. @@ -147,7 +147,7 @@ import Panel from '@site/src/components/Panel'; generated by the task for **search terms in vector search queries**. 2. **Chunking method** Select the method for splitting the search term into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). 3. **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). 4. **Overlap tokens** @@ -266,7 +266,7 @@ var addAiIntegrationTaskResult = store.Maintenance.Send(addEmbeddingsGenerationT Each KEY in the object represents a document field, and the VALUE is a text-splitting function that processes the field's content before generating embeddings. * These methods ensure that the text chunks derived from document fields stay within the token limits required by the provider, preventing request rejection. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * For example: @@ -446,13 +446,13 @@ embeddings.generate({ ... }).withContextPrefix(contextPrefix); | **htmlText** | `string` | A string containing HTML content to process. | | **maxTokensPerChunk / maxTokensPerLine** | `number` | The maximum number of tokens allowed per chunk.
Default is `512`. | | **overlapTokens** | `number` (optional) | The number of tokens to overlap between consecutive chunks. Helps preserve context continuity across chunks (e.g., between paragraphs).
Default is `0`. | -| **contextPrefix** | `string` | Text that is prepended to chunks before they are sent to the embedding model. Required when `withContextPrefix(...)` is used. Cannot be empty or whitespace-only.
Learn more in [Adding a context prefix to chunks](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#adding-a-context-prefix-to-chunks). | +| **contextPrefix** | `string` | Text that is prepended to chunks before they are sent to the embedding model. Required when `withContextPrefix(...)` is used. Cannot be empty or whitespace-only.
Learn more in [Adding a context prefix to chunks](#adding-a-context-prefix-to-chunks). | -Use `withContextPrefix(contextPrefix)` in a [SCRIPT-based](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) +Use `withContextPrefix(contextPrefix)` in a [SCRIPT-based](#configure-an-embeddings-generation-task---define-source-using-script) embeddings task to prepend context to the text sent to the embedding model. This is useful when individual chunks omit identifying document information, such as a title, category, or company name. @@ -493,11 +493,11 @@ embeddings.generate({ #### SCRIPT vs PATHS context prefixes -Use the [SCRIPT option](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) +Use the [SCRIPT option](#configure-an-embeddings-generation-task---define-source-using-script) with `withContextPrefix(...)` when the prefix must be computed per document, for example from `this.Title` or `this.Category`. -For source paths configured through the [PATHS option](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-paths) in the Client API, +For source paths configured through the [PATHS option](#configure-an-embeddings-generation-task---define-source-using-paths) in the Client API, you can set a constant prefix with the `ChunkingOptions.ContextPrefix` property in the relevant `EmbeddingPathConfiguration`. Unlike the SCRIPT option, the PATHS option applies the same prefix text to every document for that path. diff --git a/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx b/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx index 6b5b35c560..2b26614e4f 100644 --- a/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx +++ b/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx @@ -16,13 +16,13 @@ import Panel from '@site/src/components/Panel'; to understand the embeddings generation process flow. * In this article: - * [Configuring an embeddings generation task - from the Studio](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-studio) - * [Configuring an embeddings generation task - from the Client API](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-client-api) - * [Define source using PATHS](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-paths) - * [Define source using SCRIPT](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) - * [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) - * [Adding a context prefix to chunks](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#adding-a-context-prefix-to-chunks) - * [Syntax](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#syntax) + * [Configuring an embeddings generation task - from the Studio](#configuring-an-embeddings-generation-task-from-the-studio) + * [Configuring an embeddings generation task - from the Client API](#configuring-an-embeddings-generation-task-from-the-client-api) + * [Define source using PATHS](#configure-an-embeddings-generation-task---define-source-using-paths) + * [Define source using SCRIPT](#configure-an-embeddings-generation-task---define-source-using-script) + * [Chunking methods and tokens](#chunking-methods-and-tokens) + * [Adding a context prefix to chunks](#adding-a-context-prefix-to-chunks) + * [Syntax](#syntax) @@ -85,7 +85,7 @@ import Panel from '@site/src/components/Panel'; Enter the property name from the document that contains the text for embedding generation. * **Chunking method** Select the method for splitting the source text into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). * **Overlap tokens** @@ -105,7 +105,7 @@ import Panel from '@site/src/components/Panel'; 1. **Embeddings source** Select `Script` to define the source content and chunking methods using a JavaScript script. 2. **Script** - Refer to section [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) for available JavaScript methods. + Refer to section [Chunking methods and tokens](#chunking-methods-and-tokens) for available JavaScript methods. 3. **Default chunking method** The selected chunking method will be used by default when no method is specified in the script. e.g., when the script contains: `Name: this.Name`. @@ -147,7 +147,7 @@ import Panel from '@site/src/components/Panel'; generated by the task for **search terms in vector search queries**. 2. **Chunking method** Select the method for splitting the search term into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). 3. **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). 4. **Overlap tokens** @@ -256,7 +256,7 @@ const addAiIntegrationTaskResult = Each KEY in the object represents a document field, and the VALUE is a text-splitting function that processes the field's content before generating embeddings. * These methods ensure that the text chunks derived from document fields stay within the token limits required by the provider, preventing request rejection. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * For example: @@ -434,13 +434,13 @@ embeddings.generate({ ... }).withContextPrefix(contextPrefix); | **htmlText** | `string` | A string containing HTML content to process. | | **maxTokensPerChunk / maxTokensPerLine** | `number` | The maximum number of tokens allowed per chunk.
Default is `512`. | | **overlapTokens** | `number` (optional) | The number of tokens to overlap between consecutive chunks. Helps preserve context continuity across chunks (e.g., between paragraphs).
Default is `0`. | -| **contextPrefix** | `string` | Text that is prepended to chunks before they are sent to the embedding model. Required when `withContextPrefix(...)` is used. Cannot be empty or whitespace-only.
Learn more in [Adding a context prefix to chunks](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#adding-a-context-prefix-to-chunks). | +| **contextPrefix** | `string` | Text that is prepended to chunks before they are sent to the embedding model. Required when `withContextPrefix(...)` is used. Cannot be empty or whitespace-only.
Learn more in [Adding a context prefix to chunks](#adding-a-context-prefix-to-chunks). | -Use `withContextPrefix(contextPrefix)` in a [SCRIPT-based](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) embeddings task to prepend context to the text sent to the embedding model. +Use `withContextPrefix(contextPrefix)` in a [SCRIPT-based](#configure-an-embeddings-generation-task---define-source-using-script) embeddings task to prepend context to the text sent to the embedding model. This is useful when individual chunks omit identifying document information, such as a title, category, or company name. In a script, `contextPrefix` can be a string literal, a document field such as `this.Title`, or any string expression produced by the script. diff --git a/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-python.mdx b/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-python.mdx index 4432b6a7b1..30276c1b52 100644 --- a/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-python.mdx +++ b/docs/ai-integration/generating-embeddings/content/_embeddings-generation-task-python.mdx @@ -16,13 +16,13 @@ import Panel from '@site/src/components/Panel'; to understand the embeddings generation process flow. * In this article: - * [Configuring an embeddings generation task - from the Studio](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-studio) - * [Configuring an embeddings generation task - from the Client API](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-client-api) - * [Define source using PATHS](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-paths) - * [Define source using SCRIPT](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) - * [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) - * [Adding a context prefix to chunks](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#adding-a-context-prefix-to-chunks) - * [Syntax](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#syntax) + * [Configuring an embeddings generation task - from the Studio](#configuring-an-embeddings-generation-task-from-the-studio) + * [Configuring an embeddings generation task - from the Client API](#configuring-an-embeddings-generation-task-from-the-client-api) + * [Define source using PATHS](#configure-an-embeddings-generation-task---define-source-using-paths) + * [Define source using SCRIPT](#configure-an-embeddings-generation-task---define-source-using-script) + * [Chunking methods and tokens](#chunking-methods-and-tokens) + * [Adding a context prefix to chunks](#adding-a-context-prefix-to-chunks) + * [Syntax](#syntax) @@ -85,7 +85,7 @@ import Panel from '@site/src/components/Panel'; Enter the property name from the document that contains the text for embedding generation. * **Chunking method** Select the method for splitting the source text into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). * **Overlap tokens** @@ -105,7 +105,7 @@ import Panel from '@site/src/components/Panel'; 1. **Embeddings source** Select `Script` to define the source content and chunking methods using a JavaScript script. 2. **Script** - Refer to section [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) for available JavaScript methods. + Refer to section [Chunking methods and tokens](#chunking-methods-and-tokens) for available JavaScript methods. 3. **Default chunking method** The selected chunking method will be used by default when no method is specified in the script. e.g., when the script contains: `Name: this.Name`. @@ -147,7 +147,7 @@ import Panel from '@site/src/components/Panel'; generated by the task for **search terms in vector search queries**. 2. **Chunking method** Select the method for splitting the search term into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). 3. **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). 4. **Overlap tokens** @@ -268,7 +268,7 @@ add_ai_integration_task_result = store.maintenance.send(add_embeddings_generatio Each KEY in the object represents a document field, and the VALUE is a text-splitting function that processes the field's content before generating embeddings. * These methods ensure that the text chunks derived from document fields stay within the token limits required by the provider, preventing request rejection. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * For example: @@ -449,13 +449,13 @@ embeddings.generate({ ... }).withContextPrefix(contextPrefix); | **htmlText** | `string` | A string containing HTML content to process. | | **maxTokensPerChunk / maxTokensPerLine** | `number` | The maximum number of tokens allowed per chunk.
Default is `512`. | | **overlapTokens** | `number` (optional) | The number of tokens to overlap between consecutive chunks. Helps preserve context continuity across chunks (e.g., between paragraphs).
Default is `0`. | -| **contextPrefix** | `string` | Text that is prepended to chunks before they are sent to the embedding model. Required when `withContextPrefix(...)` is used. Cannot be empty or whitespace-only.
Learn more in [Adding a context prefix to chunks](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#adding-a-context-prefix-to-chunks). | +| **contextPrefix** | `string` | Text that is prepended to chunks before they are sent to the embedding model. Required when `withContextPrefix(...)` is used. Cannot be empty or whitespace-only.
Learn more in [Adding a context prefix to chunks](#adding-a-context-prefix-to-chunks). | -Use `withContextPrefix(contextPrefix)` in a [SCRIPT-based](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) embeddings task to prepend context to the text sent to the embedding model. +Use `withContextPrefix(contextPrefix)` in a [SCRIPT-based](#configure-an-embeddings-generation-task---define-source-using-script) embeddings task to prepend context to the text sent to the embedding model. This is useful when individual chunks omit identifying document information, such as a title, category, or company name. In a script, `contextPrefix` can be a string literal, a document field such as `this.Title`, or any string expression produced by the script. diff --git a/docs/ai-integration/generating-embeddings/content/_overview-csharp.mdx b/docs/ai-integration/generating-embeddings/content/_overview-csharp.mdx index a2bbd44c61..411bc9e517 100644 --- a/docs/ai-integration/generating-embeddings/content/_overview-csharp.mdx +++ b/docs/ai-integration/generating-embeddings/content/_overview-csharp.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; **embeddings generation tasks** using external service providers, as explained below. * In this article: - * [Embeddings generation - overview](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation-overview) - * [Embeddings generation - process flow](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---process-flow) - * [Supported providers](../../../ai-integration/generating-embeddings/overview.mdx#supported-providers) - * [Creating an embeddings generation task](../../../ai-integration/generating-embeddings/overview.mdx#creating-an-embeddings-generation-task) - * [Monitoring the tasks](../../../ai-integration/generating-embeddings/overview.mdx#monitoring-the-tasks) - * [Get embeddings generation task details](../../../ai-integration/generating-embeddings/overview.mdx#get-embeddings-generation-task-details) + * [Embeddings generation - overview](#embeddings-generation-overview) + * [Embeddings generation - process flow](#embeddings-generation---process-flow) + * [Supported providers](#supported-providers) + * [Creating an embeddings generation task](#creating-an-embeddings-generation-task) + * [Monitoring the tasks](#monitoring-the-tasks) + * [Get embeddings generation task details](#get-embeddings-generation-task-details) diff --git a/docs/ai-integration/generating-embeddings/content/_overview-nodejs.mdx b/docs/ai-integration/generating-embeddings/content/_overview-nodejs.mdx index 5e5ef046ba..052176767b 100644 --- a/docs/ai-integration/generating-embeddings/content/_overview-nodejs.mdx +++ b/docs/ai-integration/generating-embeddings/content/_overview-nodejs.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; **embeddings generation tasks** using external service providers, as explained below. * In this article: - * [Embeddings generation - overview](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation-overview) - * [Embeddings generation - process flow](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---process-flow) - * [Supported providers](../../../ai-integration/generating-embeddings/overview.mdx#supported-providers) - * [Creating an embeddings generation task](../../../ai-integration/generating-embeddings/overview.mdx#creating-an-embeddings-generation-task) - * [Monitoring the tasks](../../../ai-integration/generating-embeddings/overview.mdx#monitoring-the-tasks) - * [Get embeddings generation task details](../../../ai-integration/generating-embeddings/overview.mdx#get-embeddings-generation-task-details) + * [Embeddings generation - overview](#embeddings-generation-overview) + * [Embeddings generation - process flow](#embeddings-generation---process-flow) + * [Supported providers](#supported-providers) + * [Creating an embeddings generation task](#creating-an-embeddings-generation-task) + * [Monitoring the tasks](#monitoring-the-tasks) + * [Get embeddings generation task details](#get-embeddings-generation-task-details) diff --git a/docs/ai-integration/generating-embeddings/content/_overview-python.mdx b/docs/ai-integration/generating-embeddings/content/_overview-python.mdx index ba18b1d5d1..afab64fa57 100644 --- a/docs/ai-integration/generating-embeddings/content/_overview-python.mdx +++ b/docs/ai-integration/generating-embeddings/content/_overview-python.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; **embeddings generation tasks** using external service providers, as explained below. * In this article: - * [Embeddings generation - overview](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation-overview) - * [Embeddings generation - process flow](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---process-flow) - * [Supported providers](../../../ai-integration/generating-embeddings/overview.mdx#supported-providers) - * [Creating an embeddings generation task](../../../ai-integration/generating-embeddings/overview.mdx#creating-an-embeddings-generation-task) - * [Monitoring the tasks](../../../ai-integration/generating-embeddings/overview.mdx#monitoring-the-tasks) - * [Get embeddings generation task details](../../../ai-integration/generating-embeddings/overview.mdx#get-embeddings-generation-task-details) + * [Embeddings generation - overview](#embeddings-generation-overview) + * [Embeddings generation - process flow](#embeddings-generation---process-flow) + * [Supported providers](#supported-providers) + * [Creating an embeddings generation task](#creating-an-embeddings-generation-task) + * [Monitoring the tasks](#monitoring-the-tasks) + * [Get embeddings generation task details](#get-embeddings-generation-task-details) diff --git a/docs/ai-integration/generating-embeddings/embedding-collections.mdx b/docs/ai-integration/generating-embeddings/embedding-collections.mdx index 84fb804ea2..23ec56ce0b 100644 --- a/docs/ai-integration/generating-embeddings/embedding-collections.mdx +++ b/docs/ai-integration/generating-embeddings/embedding-collections.mdx @@ -27,8 +27,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; It is recommended to first refer to this [Overview](../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---overview) to understand the embeddings generation process flow. * In this article: - * [The embeddings collections](../../ai-integration/generating-embeddings/embedding-collections.mdx#the-embeddings-collections) - * [The embeddings cache collection](../../ai-integration/generating-embeddings/embedding-collections.mdx#the-embeddings-cache-collection) + * [The embeddings collections](#the-embeddings-collections) + * [The embeddings cache collection](#the-embeddings-cache-collection) ## The embeddings collections diff --git a/docs/ai-integration/start.mdx b/docs/ai-integration/start.mdx index a2d8a5c6dc..f124bd436d 100644 --- a/docs/ai-integration/start.mdx +++ b/docs/ai-integration/start.mdx @@ -24,7 +24,7 @@ Ship AI-powered features faster with RavenDB’s native tools. ### Native AI features that create intelligent applications RavenDB is equipped with a set of powerful native AI features that can be used independently or in conjunction with each other, allowing you to easily integrate advanced AI capabilities into your applications. -These features include [AI agents](../ai-integration/start.mdx#ai-agents), [GenAI tasks](../ai-integration/start.mdx#genai-tasks), [Embeddings generation](../ai-integration/start.mdx#embeddings-generation), and [Vector search](../ai-integration/start.mdx#vector-search). +These features include [AI agents](#ai-agents), [GenAI tasks](#genai-tasks), [Embeddings generation](#embeddings-generation), and [Vector search](#vector-search). ### Use cases RavenDB AI features help you ship any AI-related scenario quickly, including: diff --git a/docs/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx b/docs/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx index dedd319a35..1e980239a4 100644 --- a/docs/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx +++ b/docs/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx @@ -14,10 +14,10 @@ import Panel from '@site/src/components/Panel'; Learn more in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). * In this article: - * [Supported data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#supported-data-types-for-vector-search) - * [Textual data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#textual-data) - * [Numerical data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#numerical-data) - * [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) + * [Supported data types for vector search](#supported-data-types-for-vector-search) + * [Textual data](#textual-data) + * [Numerical data](#numerical-data) + * [RavenVector](#ravenvector) @@ -41,7 +41,7 @@ import Panel from '@site/src/components/Panel'; * Ensure that all vectors within this field across all documents in the collection are generated by the **same model** and model version and have the **same dimensions**. * Consistency in both dimensionality and model source is crucial for meaningful comparisons in the vector space. -* In addition to the native types described below, we highly recommended using [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) +* In addition to the native types described below, we highly recommended using [RavenVector](#ravenvector) for efficient storage and fast queries when working with numerical embeddings. diff --git a/docs/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx b/docs/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx index af637aa673..d671308e85 100644 --- a/docs/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx +++ b/docs/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx @@ -14,10 +14,10 @@ import Panel from '@site/src/components/Panel'; Learn more in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). * In this article: - * [Supported data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#supported-data-types-for-vector-search) - * [Textual data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#textual-data) - * [Numerical data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#numerical-data) - * [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) + * [Supported data types for vector search](#supported-data-types-for-vector-search) + * [Textual data](#textual-data) + * [Numerical data](#numerical-data) + * [RavenVector](#ravenvector) @@ -41,7 +41,7 @@ import Panel from '@site/src/components/Panel'; * Ensure that all vectors within this field across all documents in the collection are generated by the **same model** and model version and have the **same dimensions**. * Consistency in both dimensionality and model source is crucial for meaningful comparisons in the vector space. -* In addition to the native types described below, we highly recommended using [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) +* In addition to the native types described below, we highly recommended using [RavenVector](#ravenvector) for efficient storage and fast queries when working with numerical embeddings. diff --git a/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx b/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx index 7372db0032..d064f230d8 100644 --- a/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx +++ b/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; indexing a vector field. * In this article: - * [Overview](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#overview) - * [Indexing TEXT attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-text-attachments) - * [Indexing NUMERICAL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-numerical-attachments) - * [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) - * [JS index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#js-index) - * [Indexing ALL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-all-attachments) + * [Overview](#overview) + * [Indexing TEXT attachments](#indexing-text-attachments) + * [Indexing NUMERICAL attachments](#indexing-numerical-attachments) + * [LINQ index](#linq-index) + * [JS index](#js-index) + * [Indexing ALL attachments](#indexing-all-attachments) @@ -601,7 +601,7 @@ where vector.search(VectorFromAttachment, $queryVector) ### JS index -* The following is the JavaScript index format equivalent to the [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) shown above. +* The following is the JavaScript index format equivalent to the [LINQ index](#linq-index) shown above. * The main difference is that JavaScript indexes do Not support `getContentAsStream()` on attachment objects: * Because of this, embedding vectors must be stored in attachments as **Base64-encoded strings**. diff --git a/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx b/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx index 7eb1533a3a..eafe479c7f 100644 --- a/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx +++ b/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; indexing a vector field. * In this article: - * [Overview](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#overview) - * [Indexing TEXT attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-text-attachments) - * [Indexing NUMERICAL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-numerical-attachments) - * [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) - * [JS index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#js-index) - * [Indexing ALL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-all-attachments) + * [Overview](#overview) + * [Indexing TEXT attachments](#indexing-text-attachments) + * [Indexing NUMERICAL attachments](#indexing-numerical-attachments) + * [LINQ index](#linq-index) + * [JS index](#js-index) + * [Indexing ALL attachments](#indexing-all-attachments) diff --git a/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx b/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx index 57edcfaceb..e7f892e447 100644 --- a/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx +++ b/docs/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx @@ -11,12 +11,12 @@ import TabItem from '@theme/TabItem'; indexing a vector field. * In this article: - * [Overview](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#overview) - * [Indexing TEXT attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-text-attachments) - * [Indexing NUMERICAL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-numerical-attachments) - * [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) - * [JS index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#js-index) - * [Indexing ALL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-all-attachments) + * [Overview](#overview) + * [Indexing TEXT attachments](#indexing-text-attachments) + * [Indexing NUMERICAL attachments](#indexing-numerical-attachments) + * [LINQ index](#linq-index) + * [JS index](#js-index) + * [Indexing ALL attachments](#indexing-all-attachments) diff --git a/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx b/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx index fd9d11719f..53d8220dd2 100644 --- a/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx +++ b/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx @@ -9,23 +9,23 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to run a vector search using a static-index, see [vector search using a static-index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx). * In this article: - * [What is a vector search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#what-is-a-vector-search) - * [Dynamic vector search - query overview](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---query-overview) - * [Creating embeddings for the auto-index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#creating-embeddings-for-the-auto-index) - * [Retrieving results](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#retrieving-results) - * [The dynamic query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) - * [Corax auto-indexes](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) - * [Dynamic vector search - querying TEXT](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - * [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text) - * [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks) - * [Dynamic vector search - querying NUMERICAL content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content) - * [Dynamic vector search - querying for similar documents](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents) - * [Dynamic vector search - exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) - * [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) - * [Querying vector fields and regular data in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-vector-fields-and-regular-data-in-the-same-query) - * [How filtered vector search works](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#how-filtered-vector-search-works) - * [Combining multiple vector searches in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#combining-multiple-vector-searches-in-the-same-query) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#syntax) + * [What is a vector search](#what-is-a-vector-search) + * [Dynamic vector search - query overview](#dynamic-vector-search---query-overview) + * [Creating embeddings for the auto-index](#creating-embeddings-for-the-auto-index) + * [Retrieving results](#retrieving-results) + * [The dynamic query parameters](#the-dynamic-query-parameters) + * [Corax auto-indexes](#corax-auto-indexes) + * [Dynamic vector search - querying TEXT](#dynamic-vector-search---querying-text) + * [Querying raw text](#querying-raw-text) + * [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks) + * [Dynamic vector search - querying NUMERICAL content](#dynamic-vector-search---querying-numerical-content) + * [Dynamic vector search - querying for similar documents](#dynamic-vector-search---querying-for-similar-documents) + * [Dynamic vector search - exact search](#dynamic-vector-search---exact-search) + * [Quantization options](#quantization-options) + * [Querying vector fields and regular data in the same query](#querying-vector-fields-and-regular-data-in-the-same-query) + * [How filtered vector search works](#how-filtered-vector-search-works) + * [Combining multiple vector searches in the same query](#combining-multiple-vector-searches-in-the-same-query) + * [Syntax](#syntax) @@ -51,7 +51,7 @@ import CodeBlock from '@theme/CodeBlock'; * Note: Vector search queries cannot be used with [Subscription queries](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query). -* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) to process the query, +* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](#corax-auto-indexes) to process the query, and the results are retrieved from that index. * To make a **dynamic vector search query**: @@ -71,17 +71,17 @@ import CodeBlock from '@theme/CodeBlock'; Embeddings can be created from textual content in your documents by defining [Tasks that generate embeddings](../../../ai-integration/generating-embeddings/overview.mdx). When performing a dynamic vector search query over textual data and explicitly specifying the task, results will be retrieved by comparing your search term against the embeddings previously generated by that task. - A query example is available in: [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks). + A query example is available in: [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks). * **Default embeddings generation**: When querying textual data without specifying a task, RavenDB generates an embedding vector for the specified document field in each document of the queried collection, using the built-in [bge-micro-v2](https://huggingface.co/TaylorAI/bge-micro-v2) sentence-transformer model. - A query example is available in: [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). + A query example is available in: [Querying raw text](#querying-raw-text). * **Creating embeddings from NUMERICAL arrays**: When querying over pre-made numerical arrays that are already in vector format, RavenDB will index them without transformation (unless further quantization is applied). - A query example is available in: [Vector search on numerical content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + A query example is available in: [Vector search on numerical content](#dynamic-vector-search---querying-numerical-content). To avoid index errors, ensure that the dimensionality of these numerical arrays (i.e., their length) is consistent across all your source documents for the field you are querying. @@ -91,7 +91,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Quantizing the embeddings**: The embeddings are quantized based on the parameters specified in the query. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Indexing the embeddings**: RavenDB indexes the embeddings on the server using the [HNSW algorithm](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world). @@ -107,7 +107,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Processing the query**: To ensure consistent comparisons, the **search term** is transformed into an embedding vector using the same method as the document fields. The server will search for the most similar vectors in the indexed vector space, - taking into account all the [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) described below. + taking into account all the [query parameters](#the-dynamic-query-parameters) described below. The documents that correspond to the resulting vectors are then returned to the client. * **Search results**: @@ -127,7 +127,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Target quantization** You can specify the quantization encoding for the embeddings that will be created from source data. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Minimum similarity** You can specify the minimum similarity to use when searching for related vectors. @@ -155,7 +155,7 @@ import CodeBlock from '@theme/CodeBlock'; * _Exact search_: Perform a thorough scan of the vectors to find the actual closest vectors, offering better accuracy but at a higher computational cost. - Learn more in [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search). + Learn more in [Exact search](#dynamic-vector-search---exact-search). @@ -201,7 +201,7 @@ import CodeBlock from '@theme/CodeBlock'; * Since this query does not specify a target quantization format, the generated embedding vectors will be encoded in the default _Single_ format (single-precision floating-point). - Refer to [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) for examples that specify the destination quantization. + Refer to [Quantization options](#quantization-options) for examples that specify the destination quantization. @@ -440,10 +440,10 @@ where vector.search(embedding.text(Name, ai.task('id-for-task-open-ai')), $searc numerical vector searches require your source data to already be in an embedding vector format. * If your raw data is in a _float_ format, you can request further quantization of the embeddings that will be indexed in the auto-index. - See an example of this in: [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + See an example of this in: [Quantization options](#quantization-options). * Raw data that is already formatted as _Int8_ or _Binary_ **cannot** be quantized to lower-form (e.g. Int8 -> Int1). - When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#vectorquanitzer). + When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](#vectorquanitzer). #### Sample data: @@ -778,8 +778,8 @@ where vector.search(TagsEmbeddedAsBase64, $queryVectorBase64) ## Dynamic vector search - querying for similar documents * In the above examples, to find documents with similar content, the query was given an arbitrary input - - either a [raw textual search term](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - or a [numerical query vector](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + either a [raw textual search term](#dynamic-vector-search---querying-text) + or a [numerical query vector](#dynamic-vector-search---querying-numerical-content). * RavenDB also allows you to search for documents whose content is similar to an **existing document**: @@ -1431,9 +1431,9 @@ RavenDB first evaluates the filter to determine how many documents match and the * The filter match count is **below** the scanning threshold (default: `1024`). Can be customized via the [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) configuration key. - * An [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) is explicitly requested. + * An [Exact search](#dynamic-vector-search---exact-search) is explicitly requested. * The requested _number of candidates_ exceeds half the filter match count. - Learn about the _number of candidates_ param in [The query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + Learn about the _number of candidates_ param in [The query parameters](#the-dynamic-query-parameters). In this mode, an exact search is performed over **only** the documents that match the filter. @@ -1601,7 +1601,7 @@ or * Each vector search clause is evaluated independently - the search algorithm runs separately for each vector field. * Each clause retrieves a limited number of candidates, determined by the _NumberOfCandidates_ parameter. - * You can explicitly set this value in the query clause, see [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + * You can explicitly set this value in the query clause, see [query parameters](#the-dynamic-query-parameters). * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key (default is 16). * **The final result set** is computed by applying the logical operators (and, or) between these independently retrieved sets. diff --git a/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx b/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx index d92914b44d..b708fd2d89 100644 --- a/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx +++ b/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx @@ -9,23 +9,23 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to run a vector search using a static-index, see [vector search using a static-index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx). * In this article: - * [What is a vector search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#what-is-a-vector-search) - * [Dynamic vector search - query overview](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---query-overview) - * [Creating embeddings for the auto-index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#creating-embeddings-for-the-auto-index) - * [Retrieving results](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#retrieving-results) - * [The dynamic query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) - * [Corax auto-indexes](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) - * [Dynamic vector search - querying TEXT](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - * [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text) - * [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks) - * [Dynamic vector search - querying NUMERICAL content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content) - * [Dynamic vector search - querying for similar documents](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents) - * [Dynamic vector search - exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) - * [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) - * [Querying vector fields and regular data in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-vector-fields-and-regular-data-in-the-same-query) - * [How filtered vector search works](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#how-filtered-vector-search-works) - * [Combining multiple vector searches in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#combining-multiple-vector-searches-in-the-same-query) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#syntax) + * [What is a vector search](#what-is-a-vector-search) + * [Dynamic vector search - query overview](#dynamic-vector-search---query-overview) + * [Creating embeddings for the auto-index](#creating-embeddings-for-the-auto-index) + * [Retrieving results](#retrieving-results) + * [The dynamic query parameters](#the-dynamic-query-parameters) + * [Corax auto-indexes](#corax-auto-indexes) + * [Dynamic vector search - querying TEXT](#dynamic-vector-search---querying-text) + * [Querying raw text](#querying-raw-text) + * [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks) + * [Dynamic vector search - querying NUMERICAL content](#dynamic-vector-search---querying-numerical-content) + * [Dynamic vector search - querying for similar documents](#dynamic-vector-search---querying-for-similar-documents) + * [Dynamic vector search - exact search](#dynamic-vector-search---exact-search) + * [Quantization options](#quantization-options) + * [Querying vector fields and regular data in the same query](#querying-vector-fields-and-regular-data-in-the-same-query) + * [How filtered vector search works](#how-filtered-vector-search-works) + * [Combining multiple vector searches in the same query](#combining-multiple-vector-searches-in-the-same-query) + * [Syntax](#syntax) @@ -51,7 +51,7 @@ import CodeBlock from '@theme/CodeBlock'; * Note: Vector search queries cannot be used with [Subscription queries](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query). -* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) to process the query, +* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](#corax-auto-indexes) to process the query, and the results are retrieved from that index. * To make a **dynamic vector search query**: @@ -71,17 +71,17 @@ import CodeBlock from '@theme/CodeBlock'; Embeddings can be created from textual content in your documents by defining [Tasks that generate embeddings](../../../ai-integration/generating-embeddings/overview.mdx). When performing a dynamic vector search query over textual data and explicitly specifying the task, results will be retrieved by comparing your search term against the embeddings previously generated by that task. - A query example is available in: [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks). + A query example is available in: [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks). * **Default embeddings generation**: When querying textual data without specifying a task, RavenDB generates an embedding vector for the specified document field in each document of the queried collection, using the built-in [bge-micro-v2](https://huggingface.co/TaylorAI/bge-micro-v2) sentence-transformer model. - A query example is available in: [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). + A query example is available in: [Querying raw text](#querying-raw-text). * **Creating embeddings from NUMERICAL arrays**: When querying over pre-made numerical arrays that are already in vector format, RavenDB will index them without transformation (unless further quantization is applied). - A query example is available in: [Vector search on numerical content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + A query example is available in: [Vector search on numerical content](#dynamic-vector-search---querying-numerical-content). To avoid index errors, ensure that the dimensionality of these numerical arrays (i.e., their length) is consistent across all your source documents for the field you are querying. @@ -91,7 +91,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Quantizing the embeddings**: The embeddings are quantized based on the parameters specified in the query. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Indexing the embeddings**: RavenDB indexes the embeddings on the server using the [HNSW algorithm](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world). @@ -107,7 +107,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Processing the query**: To ensure consistent comparisons, the **search term** is transformed into an embedding vector using the same method as the document fields. The server will search for the most similar vectors in the indexed vector space, - taking into account all the [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) described below. + taking into account all the [query parameters](#the-dynamic-query-parameters) described below. The documents that correspond to the resulting vectors are then returned to the client. * **Search results**: @@ -127,7 +127,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Target quantization** You can specify the quantization encoding for the embeddings that will be created from source data. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Minimum similarity** You can specify the minimum similarity to use when searching for related vectors. @@ -155,7 +155,7 @@ import CodeBlock from '@theme/CodeBlock'; * _Exact search_: Perform a thorough scan of the vectors to find the actual closest vectors, offering better accuracy but at a higher computational cost. - Learn more in [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search). + Learn more in [Exact search](#dynamic-vector-search---exact-search). @@ -201,7 +201,7 @@ import CodeBlock from '@theme/CodeBlock'; * Since this query does not specify a target quantization format, the generated embedding vectors will be encoded in the default _Single_ format (single-precision floating-point). - Refer to [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) for examples that specify the destination quantization. + Refer to [Quantization options](#quantization-options) for examples that specify the destination quantization. @@ -341,10 +341,10 @@ where vector.search(embedding.text(Name, ai.task('id-for-task-open-ai')), $searc numerical vector searches require your source data to already be in an embedding vector format. * If your raw data is in a _float_ format, you can request further quantization of the embeddings that will be indexed in the auto-index. - See an example of this in: [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + See an example of this in: [Quantization options](#quantization-options). * Raw data that is already formatted as _Int8_ or _Binary_ **cannot** be quantized to lower-form (e.g. Int8 -> Int1). - When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#vectorquanitzer). + When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](#vectorquanitzer). #### Sample data: @@ -585,8 +585,8 @@ where vector.search(tagsEmbeddedAsBase64, $queryVectorBase64) ## Dynamic vector search - querying for similar documents * In the above examples, to find documents with similar content, the query was given an arbitrary input - - either a [raw textual search term](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - or a [numerical query vector](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + either a [raw textual search term](#dynamic-vector-search---querying-text) + or a [numerical query vector](#dynamic-vector-search---querying-numerical-content). * RavenDB also allows you to search for documents whose content is similar to an **existing document**: @@ -978,9 +978,9 @@ RavenDB first evaluates the filter to determine how many documents match and the * The filter match count is **below** the scanning threshold (default: `1024`). Can be customized via the [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) configuration key. - * An [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) is explicitly requested. + * An [Exact search](#dynamic-vector-search---exact-search) is explicitly requested. * The requested _number of candidates_ exceeds half the filter match count. - Learn about the _number of candidates_ param in [The query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + Learn about the _number of candidates_ param in [The query parameters](#the-dynamic-query-parameters). In this mode, an exact search is performed over **only** the documents that match the filter. @@ -1098,7 +1098,7 @@ or * Each vector search clause is evaluated independently - the search algorithm runs separately for each vector field. * Each clause retrieves a limited number of candidates, determined by the _NumberOfCandidates_ parameter. - * You can explicitly set this value in the query clause, see [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + * You can explicitly set this value in the query clause, see [query parameters](#the-dynamic-query-parameters). * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key (default is 16). * **The final result set** is computed by applying the logical operators (and, or) between these independently retrieved sets. diff --git a/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx b/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx index 49733ade25..a1e1fc71b6 100644 --- a/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx +++ b/docs/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx @@ -9,23 +9,23 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to run a vector search using a static-index, see [vector search using a static-index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx). * In this article: - * [What is a vector search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#what-is-a-vector-search) - * [Dynamic vector search - query overview](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---query-overview) - * [Creating embeddings for the auto-index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#creating-embeddings-for-the-auto-index) - * [Retrieving results](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#retrieving-results) - * [The dynamic query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) - * [Corax auto-indexes](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) - * [Dynamic vector search - querying TEXT](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - * [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text) - * [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks) - * [Dynamic vector search - querying NUMERICAL content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content) - * [Dynamic vector search - querying for similar documents](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents) - * [Dynamic vector search - exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) - * [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) - * [Querying vector fields and regular data in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-vector-fields-and-regular-data-in-the-same-query) - * [How filtered vector search works](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#how-filtered-vector-search-works) - * [Combining multiple vector searches in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#combining-multiple-vector-searches-in-the-same-query) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#syntax) + * [What is a vector search](#what-is-a-vector-search) + * [Dynamic vector search - query overview](#dynamic-vector-search---query-overview) + * [Creating embeddings for the auto-index](#creating-embeddings-for-the-auto-index) + * [Retrieving results](#retrieving-results) + * [The dynamic query parameters](#the-dynamic-query-parameters) + * [Corax auto-indexes](#corax-auto-indexes) + * [Dynamic vector search - querying TEXT](#dynamic-vector-search---querying-text) + * [Querying raw text](#querying-raw-text) + * [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks) + * [Dynamic vector search - querying NUMERICAL content](#dynamic-vector-search---querying-numerical-content) + * [Dynamic vector search - querying for similar documents](#dynamic-vector-search---querying-for-similar-documents) + * [Dynamic vector search - exact search](#dynamic-vector-search---exact-search) + * [Quantization options](#quantization-options) + * [Querying vector fields and regular data in the same query](#querying-vector-fields-and-regular-data-in-the-same-query) + * [How filtered vector search works](#how-filtered-vector-search-works) + * [Combining multiple vector searches in the same query](#combining-multiple-vector-searches-in-the-same-query) + * [Syntax](#syntax) @@ -51,7 +51,7 @@ import CodeBlock from '@theme/CodeBlock'; * Note: Vector search queries cannot be used with [Subscription queries](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query). -* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) to process the query, +* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](#corax-auto-indexes) to process the query, and the results are retrieved from that index. * To make a **dynamic vector search query**: @@ -71,17 +71,17 @@ import CodeBlock from '@theme/CodeBlock'; Embeddings can be created from textual content in your documents by defining [Tasks that generate embeddings](../../../ai-integration/generating-embeddings/overview.mdx). When performing a dynamic vector search query over textual data and explicitly specifying the task, results will be retrieved by comparing your search term against the embeddings previously generated by that task. - A query example is available in: [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks). + A query example is available in: [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks). * **Default embeddings generation**: When querying textual data without specifying a task, RavenDB generates an embedding vector for the specified document field in each document of the queried collection, using the built-in [bge-micro-v2](https://huggingface.co/TaylorAI/bge-micro-v2) sentence-transformer model. - A query example is available in: [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). + A query example is available in: [Querying raw text](#querying-raw-text). * **Creating embeddings from NUMERICAL arrays**: When querying over pre-made numerical arrays that are already in vector format, RavenDB will index them without transformation (unless further quantization is applied). - A query example is available in: [Vector search on numerical content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + A query example is available in: [Vector search on numerical content](#dynamic-vector-search---querying-numerical-content). To avoid index errors, ensure that the dimensionality of these numerical arrays (i.e., their length) is consistent across all your source documents for the field you are querying. @@ -91,7 +91,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Quantizing the embeddings**: The embeddings are quantized based on the parameters specified in the query. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Indexing the embeddings**: RavenDB indexes the embeddings on the server using the [HNSW algorithm](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world). @@ -107,7 +107,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Processing the query**: To ensure consistent comparisons, the **search term** is transformed into an embedding vector using the same method as the document fields. The server will search for the most similar vectors in the indexed vector space, - taking into account all the [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) described below. + taking into account all the [query parameters](#the-dynamic-query-parameters) described below. The documents that correspond to the resulting vectors are then returned to the client. * **Search results**: @@ -127,7 +127,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Target quantization** You can specify the quantization encoding for the embeddings that will be created from source data. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Minimum similarity** You can specify the minimum similarity to use when searching for related vectors. @@ -155,7 +155,7 @@ import CodeBlock from '@theme/CodeBlock'; * _Exact search_: Perform a thorough scan of the vectors to find the actual closest vectors, offering better accuracy but at a higher computational cost. - Learn more in [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search). + Learn more in [Exact search](#dynamic-vector-search---exact-search). @@ -201,7 +201,7 @@ import CodeBlock from '@theme/CodeBlock'; * Since this query does not specify a target quantization format, the generated embedding vectors will be encoded in the default _Single_ format (single-precision floating-point). - Refer to [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) for examples that specify the destination quantization. + Refer to [Quantization options](#quantization-options) for examples that specify the destination quantization. @@ -306,10 +306,10 @@ where vector.search(embedding.text(Name, ai.task('id-for-task-open-ai')), $searc numerical vector searches require your source data to already be in an embedding vector format. * If your raw data is in a _float_ format, you can request further quantization of the embeddings that will be indexed in the auto-index. - See an example of this in: [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + See an example of this in: [Quantization options](#quantization-options). * Raw data that is already formatted as _Int8_ or _Binary_ **cannot** be quantized to lower-form (e.g. Int8 -> Int1). - When storing data in these formats in your documents, you should use [RavenDB’s `VectorQuantizer` methods](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#vectorquantizer). + When storing data in these formats in your documents, you should use [RavenDB’s `VectorQuantizer` methods](#vectorquantizer). #### Sample data: @@ -529,8 +529,8 @@ where vector.search(tags_embedded_as_base_64, $queryVectorBase64) ## Dynamic vector search - querying for similar documents * In the above examples, to find documents with similar content, the query was given an arbitrary input - - either a [raw textual search term](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - or a [numerical query vector](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + either a [raw textual search term](#dynamic-vector-search---querying-text) + or a [numerical query vector](#dynamic-vector-search---querying-numerical-content). * RavenDB also allows you to search for documents whose content is similar to an **existing document**: @@ -836,9 +836,9 @@ RavenDB first evaluates the filter to determine how many documents match and the * The filter match count is **below** the scanning threshold (default: `1024`). Can be customized via the [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) configuration key. - * An [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) is explicitly requested. + * An [Exact search](#dynamic-vector-search---exact-search) is explicitly requested. * The requested _number of candidates_ exceeds half the filter match count. - Learn about the _number of candidates_ param in [The query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + Learn about the _number of candidates_ param in [The query parameters](#the-dynamic-query-parameters). In this mode, an exact search is performed over **only** the documents that match the filter. @@ -946,7 +946,7 @@ or * Each vector search clause is evaluated independently - the search algorithm runs separately for each vector field. * Each clause retrieves a limited number of candidates, determined by the _NumberOfCandidates_ parameter. - * You can explicitly set this value in the query clause, see [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + * You can explicitly set this value in the query clause, see [query parameters](#the-dynamic-query-parameters). * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key (default is 16). * **The final result set** is computed by applying the logical operators (and, or) between these independently retrieved sets. diff --git a/docs/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx b/docs/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx index 1f49f5ceea..34a91dd2df 100644 --- a/docs/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx +++ b/docs/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx @@ -16,28 +16,28 @@ import ContentFrame from "@site/src/components/ContentFrame"; * The vector search feature is only supported by indexes that use the [Corax search engine](../../../indexes/search-engine/corax.mdx). * Vector fields are **not** supported in Map-Reduce indexes. - See [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + See [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) for a workaround that uses two separate indexes. * In this article: - * [Indexing a vector field - Overview](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-a-vector-field---overview) - * [Defining a vector field in a static index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#defining-a-vector-field-in-a-static-index) - * [Parameters defined in the index definition](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-in-the-index-definition) - * [Behavior during indexing](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#behavior-during-indexing) - * [Parameters used at query time](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-used-at-query-time) - * [Behavior when documents are deleted](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#vector-behavior-when-documents-are-deleted) - * [Indexing vector data - TEXT](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) - * [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text) - * [Indexing text-embeddings generated by tasks - from current document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document) - * [Indexing text-embeddings generated by tasks - from related document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-related-document) - * [Indexing vector data - NUMERICAL](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---numerical) - * [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input) - * [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input) - * [Indexing multiple field types](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-multiple-field-types) - * [Querying the static index for similar documents](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#querying-the-static-index-for-similar-documents) - * [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio) - * [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#syntax) + * [Indexing a vector field - Overview](#indexing-a-vector-field---overview) + * [Defining a vector field in a static index](#defining-a-vector-field-in-a-static-index) + * [Parameters defined in the index definition](#parameters-defined-in-the-index-definition) + * [Behavior during indexing](#behavior-during-indexing) + * [Parameters used at query time](#parameters-used-at-query-time) + * [Behavior when documents are deleted](#vector-behavior-when-documents-are-deleted) + * [Indexing vector data - TEXT](#indexing-vector-data---text) + * [Indexing raw text](#indexing-raw-text) + * [Indexing text-embeddings generated by tasks - from current document](#indexing-text-embeddings-generated-by-tasks---from-current-document) + * [Indexing text-embeddings generated by tasks - from related document](#indexing-text-embeddings-generated-by-tasks---from-related-document) + * [Indexing vector data - NUMERICAL](#indexing-vector-data---numerical) + * [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input) + * [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input) + * [Indexing multiple field types](#indexing-multiple-field-types) + * [Querying the static index for similar documents](#querying-the-static-index-for-similar-documents) + * [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio) + * [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) + * [Syntax](#syntax) @@ -54,16 +54,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; use the `LoadVector()` method in your index definition. The embeddings can be loaded either from the document currently being indexed or from a [related document](../../../indexes/indexing-related-documents.mdx#what-are-related-documents). Examples are available in: - [Indexing text-embeddings generated by tasks - from current document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document) - [Indexing text-embeddings generated by tasks - from related document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-related-document) + [Indexing text-embeddings generated by tasks - from current document](#indexing-text-embeddings-generated-by-tasks---from-current-document) + [Indexing text-embeddings generated by tasks - from related document](#indexing-text-embeddings-generated-by-tasks---from-related-document) **`CreateVector()`**: When indexing **your own data** (textual or numerical) that was Not generated by the [Embeddings generation tasks](../../../ai-integration/generating-embeddings/overview.mdx), use the `CreateVector()` method in your index definition. - An example is available in [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). + An example is available in [Indexing raw text](#indexing-raw-text). * **From the Studio**: - See [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio). + See [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio). The **source data types** that can be used for vector search are detailed in [Data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx). @@ -189,7 +189,7 @@ In addition, you can apply any of the 'order by' methods to your query, as expla ### Indexing raw text The index in this example indexes data from raw text. -For an index that indexes pre-made text-embeddings see [this example below](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document). +For an index that indexes pre-made text-embeddings see [this example below](#indexing-text-embeddings-generated-by-tasks---from-current-document). The following index defines a **vector field** named `VectorfromText`. It indexes embeddings generated from the raw textual data in the `Name` field of all _Product_ documents. @@ -694,7 +694,7 @@ where exact(vector.search(VectorFromTextEmbeddings, $p0, 0.75, 20)) ### Indexing text-embeddings generated by tasks - from related document -The [previous example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document) +The [previous example](#indexing-text-embeddings-generated-by-tasks---from-current-document) indexed pre-made embeddings that were generated from the **document currently being indexed**. However, you can also index pre-made embeddings that were generated from a **related document**. @@ -973,7 +973,7 @@ where vector.search(CategoryVectorFromTextEmbeddings, $searchTerm, 0.75, 20) * **Query using a numerical embedding (direct vector)**: You provide a numerical array as the search term, and RavenDB compares it directly against the indexed embeddings. - See [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input). + See [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input). * **Query using a text input**: You provide a text string as the search term and specify an existing [Embedding generation task](../../../ai-integration/generating-embeddings/overview.mdx) that will convert this text into a vector embedding. @@ -986,7 +986,7 @@ where vector.search(CategoryVectorFromTextEmbeddings, $searchTerm, 0.75, 20) This hybrid approach allows you to index custom embeddings (e.g., externally generated image vectors) while still benefiting from RavenDB’s ability to perform semantic text search, as long as the same model was used for both. - See [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input). + See [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input). * The examples in this section use the [sample data provided in the dynamic query article](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#sample-data). @@ -1964,7 +1964,7 @@ or vector.search(VectorFromText, $searchTerm2, 0.8) * Similar to [querying for similar documents using a dynamic query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents), you can **query a static-index for similar documents** by specifying a document ID in the vector search. -* The following example queries the static-index defined in [this example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) above. +* The following example queries the static-index defined in [this example](#indexing-vector-data---text) above. The document for which we want to find similar documents is specified by the document ID passed to the `ForDocument` method. * RavenDB retrieves the embedding that was indexed for the queried field in the specified document and uses it as the query vector for the similarity comparison. diff --git a/docs/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx b/docs/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx index 74131482f0..3d67801fe0 100644 --- a/docs/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx +++ b/docs/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx @@ -16,26 +16,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; * The vector search feature is only supported by indexes that use the [Corax search engine](../../../indexes/search-engine/corax.mdx). * Vector fields are **not** supported in Map-Reduce indexes. - See [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + See [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) for a workaround that uses two separate indexes. * In this article: - * [Indexing a vector field - Overview](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-a-vector-field---overview) - * [Defining a vector field in a static index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#defining-a-vector-field-in-a-static-index) - * [Parameters defined in the index definition](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-in-the-index-definition) - * [Behavior during indexing](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#behavior-during-indexing) - * [Parameters used at query time](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-used-at-query-time) - * [Behavior when documents are deleted](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#vector-behavior-when-documents-are-deleted) - * [Indexing vector data - TEXT](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) - * [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text) - * [Indexing pre-made text-embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks) - * [Indexing vector data - NUMERICAL](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---numerical) - * [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input) - * [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input) - * [Indexing multiple field types](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-multiple-field-types) - * [Querying the static index for similar documents](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#querying-the-static-index-for-similar-documents) - * [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio) - * [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + * [Indexing a vector field - Overview](#indexing-a-vector-field---overview) + * [Defining a vector field in a static index](#defining-a-vector-field-in-a-static-index) + * [Parameters defined in the index definition](#parameters-defined-in-the-index-definition) + * [Behavior during indexing](#behavior-during-indexing) + * [Parameters used at query time](#parameters-used-at-query-time) + * [Behavior when documents are deleted](#vector-behavior-when-documents-are-deleted) + * [Indexing vector data - TEXT](#indexing-vector-data---text) + * [Indexing raw text](#indexing-raw-text) + * [Indexing pre-made text-embeddings generated by tasks](#indexing-pre-made-text-embeddings-generated-by-tasks) + * [Indexing vector data - NUMERICAL](#indexing-vector-data---numerical) + * [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input) + * [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input) + * [Indexing multiple field types](#indexing-multiple-field-types) + * [Querying the static index for similar documents](#querying-the-static-index-for-similar-documents) + * [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio) + * [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) @@ -52,15 +52,15 @@ To define a vector index-field in your static-index definition: **`loadVector()`**: When indexing **pre-made text-embeddings** generated by RavenDB's [Embeddings generation tasks](../../../ai-integration/generating-embeddings/overview.mdx), use the `loadVector()` method in your index definition. - An example is available in [Indexing pre-made text-embeddings](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). + An example is available in [Indexing pre-made text-embeddings](#indexing-pre-made-text-embeddings-generated-by-tasks). **`createVector()`**: When indexing **your own data** (textual or numerical) that was not generated by these tasks, use the `createVector()` method in your index definition. - An example is available in [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). + An example is available in [Indexing raw text](#indexing-raw-text). * **From the Studio**: - See [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio). + See [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio). The **source data types** that can be used for vector search are detailed in [Data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx). @@ -186,7 +186,7 @@ In addition, you can apply any of the 'order by' methods to your query, as expla ### Indexing raw text The index in this example indexes data from raw text. -For an index that indexes pre-made text-embeddings see [this example below](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). +For an index that indexes pre-made text-embeddings see [this example below](#indexing-pre-made-text-embeddings-generated-by-tasks). The following index defines a **vector field** named `vectorfromText`. It indexes embeddings generated from the raw textual data in the `Name` field of all _Product_ documents. @@ -467,7 +467,7 @@ where exact(vector.search(vectorFromTextEmbeddings, $p0, 0.75, 20)) * **Query using a numerical embedding (direct vector)**: You provide a numerical array as the search term, and RavenDB compares it directly against the indexed embeddings. - See [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input). + See [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input). * **Query using a text input**: You provide a text string as the search term and specify an existing [Embedding generation task](../../../ai-integration/generating-embeddings/overview.mdx) that will convert this text into a vector embedding. @@ -480,7 +480,7 @@ where exact(vector.search(vectorFromTextEmbeddings, $p0, 0.75, 20)) This hybrid approach allows you to index custom embeddings (e.g., externally generated image vectors) while still benefiting from RavenDB’s ability to perform semantic text search, as long as the same model was used for both. - See [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input). + See [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input). * The examples in this section use the [sample data provided in the dynamic query article](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#sample-data). @@ -1009,7 +1009,7 @@ or vector.search(vectorFromText, $searchTerm2, 0.8) * Similar to [querying for similar documents using a dynamic query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents), you can **query a static-index for similar documents** by specifying a document ID in the vector search. -* The following example queries the static-index defined in [this example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) above. +* The following example queries the static-index defined in [this example](#indexing-vector-data---text) above. The document for which we want to find similar documents is specified by the document ID passed to the `ForDocument` method. * RavenDB retrieves the embedding that was indexed for the queried field in the specified document and uses it as the query vector for the similarity comparison. diff --git a/docs/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx b/docs/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx index 5d8bc9cee9..29441a8726 100644 --- a/docs/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx +++ b/docs/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx @@ -15,26 +15,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; * The vector search feature is only supported by indexes that use the [Corax search engine](../../../indexes/search-engine/corax.mdx). * Vector fields are **not** supported in Map-Reduce indexes. - See [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + See [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) for a workaround that uses two separate indexes. * In this article: - * [Indexing a vector field - Overview](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-a-vector-field---overview) - * [Defining a vector field in a static index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#defining-a-vector-field-in-a-static-index) - * [Parameters defined in the index definition](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-in-the-index-definition) - * [Behavior during indexing](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#behavior-during-indexing) - * [Parameters used at query time](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-used-at-query-time) - * [Behavior when documents are deleted](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#vector-behavior-when-documents-are-deleted) - * [Indexing vector data - TEXT](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) - * [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text) - * [Indexing pre-made text-embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks) - * [Indexing vector data - NUMERICAL](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---numerical) - * [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input) - * [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input) - * [Indexing multiple field types](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-multiple-field-types) - * [Querying the static index for similar documents](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#querying-the-static-index-for-similar-documents) - * [Configure the vector field in Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-studio) - * [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + * [Indexing a vector field - Overview](#indexing-a-vector-field---overview) + * [Defining a vector field in a static index](#defining-a-vector-field-in-a-static-index) + * [Parameters defined in the index definition](#parameters-defined-in-the-index-definition) + * [Behavior during indexing](#behavior-during-indexing) + * [Parameters used at query time](#parameters-used-at-query-time) + * [Behavior when documents are deleted](#vector-behavior-when-documents-are-deleted) + * [Indexing vector data - TEXT](#indexing-vector-data---text) + * [Indexing raw text](#indexing-raw-text) + * [Indexing pre-made text-embeddings generated by tasks](#indexing-pre-made-text-embeddings-generated-by-tasks) + * [Indexing vector data - NUMERICAL](#indexing-vector-data---numerical) + * [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input) + * [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input) + * [Indexing multiple field types](#indexing-multiple-field-types) + * [Querying the static index for similar documents](#querying-the-static-index-for-similar-documents) + * [Configure the vector field in Studio](#configure-the-vector-field-in-studio) + * [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) @@ -51,15 +51,15 @@ To define a vector index-field in your static-index definition: **`LoadVector()`**: When indexing **pre-made text-embeddings** generated by RavenDB's [Embeddings generation tasks](../../../ai-integration/generating-embeddings/overview.mdx), use the `LoadVector()` method in your index definition. - An example is available in [Indexing pre-made text-embeddings](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). + An example is available in [Indexing pre-made text-embeddings](#indexing-pre-made-text-embeddings-generated-by-tasks). **`CreateVector()`**: When indexing **your own data** (textual or numerical) that was not generated by these tasks, use the `CreateVector()` method in your index definition. - An example is available in [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). + An example is available in [Indexing raw text](#indexing-raw-text). * **From Studio**: - See [Configure the vector field in Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-studio). + See [Configure the vector field in Studio](#configure-the-vector-field-in-studio). The **source data types** that can be used for vector search are detailed in [Data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx). @@ -185,7 +185,7 @@ In addition, you can apply any of the 'order by' methods to your query, as expla ### Indexing raw text The index in this example indexes data from raw text. -For an index that indexes pre-made text-embeddings see [this example below](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). +For an index that indexes pre-made text-embeddings see [this example below](#indexing-pre-made-text-embeddings-generated-by-tasks). The following index defines a **vector field** named `vector_from_text`. It indexes embeddings generated from the raw textual data in the `Name` field of all _Product_ documents. @@ -413,7 +413,7 @@ where exact(vector.search(vector_from_text_embeddings, $p0, 0.75, 20)) * **Query using a numerical embedding (direct vector)**: You provide a numerical array as the search term, and RavenDB compares it directly against the indexed embeddings. - See [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input). + See [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input). * **Query using a text input**: You provide a text string as the search term and specify an existing [Embedding generation task](../../../ai-integration/generating-embeddings/overview.mdx) that will convert this text into a vector embedding. @@ -426,7 +426,7 @@ where exact(vector.search(vector_from_text_embeddings, $p0, 0.75, 20)) This hybrid approach allows you to index custom embeddings (e.g., externally generated image vectors) while still benefiting from RavenDB’s ability to perform semantic text search, as long as the same model was used for both. - See [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input). + See [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input). * The examples in this section use the [sample data provided in the dynamic query article](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#sample-data). @@ -891,7 +891,7 @@ or vector.search(vector_from_text, $searchTerm2, 0.8) * Similar to [querying for similar documents using a dynamic query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents), you can **query a static-index for similar documents** by specifying a document ID in the vector search. -* The following example queries the static-index defined in [this example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) above. +* The following example queries the static-index defined in [this example](#indexing-vector-data---text) above. The document for which we want to find similar documents is specified by the document ID passed to the `forDoc` method. * RavenDB retrieves the embedding that was indexed for the queried field in the specified document and uses it as the query vector for the similarity comparison. diff --git a/docs/ai-integration/vector-search/overview.mdx b/docs/ai-integration/vector-search/overview.mdx index 52a5619172..2fdc91065e 100644 --- a/docs/ai-integration/vector-search/overview.mdx +++ b/docs/ai-integration/vector-search/overview.mdx @@ -26,11 +26,11 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [What is a vector database](../../ai-integration/vector-search/overview.mdx#what-is-a-vector-database) - * [Why choose RavenDB as your vector database](../../ai-integration/vector-search/overview.mdx#why-choose-ravendb-as-your-vector-database) - * [Vector search in RavenDB](../../ai-integration/vector-search/overview.mdx#vector-search-in-ravendb) - * [Vector search using a dynamic query](../../ai-integration/vector-search/overview.mdx#vector-search-using-a-dynamic-query) - * [Vector search using a static-index](../../ai-integration/vector-search/overview.mdx#vector-search-using-a-static-index) + * [What is a vector database](#what-is-a-vector-database) + * [Why choose RavenDB as your vector database](#why-choose-ravendb-as-your-vector-database) + * [Vector search in RavenDB](#vector-search-in-ravendb) + * [Vector search using a dynamic query](#vector-search-using-a-dynamic-query) + * [Vector search using a static-index](#vector-search-using-a-static-index) diff --git a/docs/ai-integration/vector-search/what-affects-vector-search-results.mdx b/docs/ai-integration/vector-search/what-affects-vector-search-results.mdx index 7ed1c3edd0..8f86a660d7 100644 --- a/docs/ai-integration/vector-search/what-affects-vector-search-results.mdx +++ b/docs/ai-integration/vector-search/what-affects-vector-search-results.mdx @@ -28,13 +28,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Several **indexing-time parameters** affect how the vector graph is built, and **query-time parameters** affect how the graph is searched. These settings influence the trade-off between speed and accuracy. -* If full accuracy is required, RavenDB also provides [Exact vector search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search), +* If full accuracy is required, RavenDB also provides [Exact vector search](#using-exact-search), which performs a full scan of all indexed vectors to guarantee the closest matches. * In this article: - * [The approximate nature of HNSW](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#the-approximate-nature-of-hnsw) - * [Indexing-time parameters](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#indexing-time-parameters) - * [Query-time parameters](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#query-time-parameters) - * [Using exact search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search) + * [The approximate nature of HNSW](#the-approximate-nature-of-hnsw) + * [Indexing-time parameters](#indexing-time-parameters) + * [Query-time parameters](#query-time-parameters) + * [Using exact search](#using-exact-search) @@ -46,7 +46,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Top layers are sparse and support fast, broad navigation. The bottom layer is dense and includes all indexed vectors for fine-grained matching. * Each node (vector) is connected only to a limited number of neighbors, selected as the most relevant during indexing (graph build time). - This limitation is controlled by the [Indexing-time parameters](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#indexing-time-parameters) described below. + This limitation is controlled by the [Indexing-time parameters](#indexing-time-parameters) described below. * This structure speeds up search but increases the chance that a relevant document is not reachable - especially if it's poorly connected. @@ -67,12 +67,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The algorithm doesn't exhaustively explore all possible paths, so it can miss the true global nearest neighbors - especially if they are not well-connected in the graph. This design enables HNSW to find relevant results very quickly by focusing only on the most promising paths, making it highly efficient even for large datasets. - * The search is influenced by the [Query-time params](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#query-time-parameters) described below. + * The search is influenced by the [Query-time params](#query-time-parameters) described below. Slight variations in graph structure or search parameters can lead to different results. * While HNSW offers fast search performance at scale and quickly finds points that are likely to be among the nearest neighbors, it does not guarantee exact results - only approximate matches are returned. This behavior is expected in all ANN algorithms, not just HNSW. - If full accuracy is critical, consider using [Exact search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search) instead. + If full accuracy is critical, consider using [Exact search](#using-exact-search) instead. ## Indexing-time parameters @@ -149,7 +149,7 @@ These parameters directly affect how many results are found, how similar they ar it is typically accurate and strongly recommended in most scenarios due to its performance. * **Exact search**: Performs a full comparison against all indexed vectors to guarantee the closest matches. - Learn more in [Using exact search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search) below. + Learn more in [Using exact search](#using-exact-search) below. For all parameters that can be defined at query time, see: Dynamic queries - [The dynamic query parameters](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). diff --git a/docs/backup/configuration.mdx b/docs/backup/configuration.mdx index 1225ee2b09..51cc9b9265 100644 --- a/docs/backup/configuration.mdx +++ b/docs/backup/configuration.mdx @@ -23,15 +23,15 @@ Learn how to apply these keys in the [Configuration Overview](../server/configur * In this article: - * [Backup.TempPath](../backup/configuration.mdx#backuptemppath) - * [Backup.LocalRootPath](../backup/configuration.mdx#backuplocalrootpath) - * [Backup.AllowedDestinations](../backup/configuration.mdx#backupalloweddestinations) - * [Backup.AllowedAwsRegions](../backup/configuration.mdx#backupallowedawsregions) - * [Backup.MaxNumberOfConcurrentBackups](../backup/configuration.mdx#backupmaxnumberofconcurrentbackups) - * [Backup.ConcurrentBackupsDelayInSec](../backup/configuration.mdx#backupconcurrentbackupsdelayinsec) - * [Backup.LowMemoryBackupDelayInMin](../backup/configuration.mdx#backuplowmemorybackupdelayinmin) - * [Backup.MoveToNewResponsibleNodeGracePeriodInMin](../backup/configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../backup/configuration.mdx#servercpucreditsexhaustionbackupdelayinmin) + * [Backup.TempPath](#backuptemppath) + * [Backup.LocalRootPath](#backuplocalrootpath) + * [Backup.AllowedDestinations](#backupalloweddestinations) + * [Backup.AllowedAwsRegions](#backupallowedawsregions) + * [Backup.MaxNumberOfConcurrentBackups](#backupmaxnumberofconcurrentbackups) + * [Backup.ConcurrentBackupsDelayInSec](#backupconcurrentbackupsdelayinsec) + * [Backup.LowMemoryBackupDelayInMin](#backuplowmemorybackupdelayinmin) + * [Backup.MoveToNewResponsibleNodeGracePeriodInMin](#backupmovetonewresponsiblenodegraceperiodinmin) + * [Server.CpuCredits.ExhaustionBackupDelayInMin](#servercpucreditsexhaustionbackupdelayinmin) @@ -143,7 +143,7 @@ Maximum number of concurrent backup tasks. ### Backup.ConcurrentBackupsDelayInSec -Number of seconds to delay the backup when the [concurrent backups limit](../backup/configuration.mdx#backupmaxnumberofconcurrentbackups) is reached. +Number of seconds to delay the backup when the [concurrent backups limit](#backupmaxnumberofconcurrentbackups) is reached. - **Type**: `TimeSetting` - **TimeUnit**: `TimeUnit.Seconds` diff --git a/docs/backup/create/one-time-backup.mdx b/docs/backup/create/one-time-backup.mdx index c7f252d496..b782a7c15d 100644 --- a/docs/backup/create/one-time-backup.mdx +++ b/docs/backup/create/one-time-backup.mdx @@ -25,13 +25,13 @@ However, you can also back up any database on demand, whenever needed. - You can also trigger any **periodic backup task** defined for your database, to create a backup now. * In this article: - * [Running a one-time backup operation using the client API](../../backup/create/one-time-backup.mdx#running-a-one-time-backup-operation-using-the-client-api) - * [Defining and running a one-time backup operation](../../backup/create/one-time-backup.mdx#defining-and-running-a-one-time-backup-operation) - * [Triggering a backup task to run a backup operation immediately](../../backup/create/one-time-backup.mdx#triggering-a-backup-task-to-run-a-backup-operation-immediately) + * [Running a one-time backup operation using the client API](#running-a-one-time-backup-operation-using-the-client-api) + * [Defining and running a one-time backup operation](#defining-and-running-a-one-time-backup-operation) + * [Triggering a backup task to run a backup operation immediately](#triggering-a-backup-task-to-run-a-backup-operation-immediately) - * [Running a one-time backup operation using Studio](../../backup/create/one-time-backup.mdx#running-a-one-time-backup-operation-using-studio) - * [Defining and running a one-time backup operation](../../backup/create/one-time-backup.mdx#defining-and-running-a-one-time-backup-operation-1) - * [Triggering a backup task to run a backup operation immediately](../../backup/create/one-time-backup.mdx#triggering-a-backup-task-to-run-a-backup-operation-immediately-1) + * [Running a one-time backup operation using Studio](#running-a-one-time-backup-operation-using-studio) + * [Defining and running a one-time backup operation](#defining-and-running-a-one-time-backup-operation-1) + * [Triggering a backup task to run a backup operation immediately](#triggering-a-backup-task-to-run-a-backup-operation-immediately-1) @@ -70,7 +70,7 @@ Operation op = #### Setting backup type: -- Set the backup type using the backup configuration [BackupType](../../backup/create/one-time-backup.mdx#classes-and-enums-used-in-the-backup-configuration) _enum_ property. +- Set the backup type using the backup configuration [BackupType](#classes-and-enums-used-in-the-backup-configuration) _enum_ property. You can assign it with `BackupType.Backup` to create logical backups, or with `BackupType.Snapshot` for snapshot images. @@ -117,7 +117,7 @@ Operation op = }; ``` -- [See destinations-related syntax](../../backup/create/one-time-backup.mdx#backup-destinations-classes) +- [See destinations-related syntax](#backup-destinations-classes) --- @@ -155,7 +155,7 @@ Set backup encryption using the backup configuration `BackupEncryptionSettings` }; ``` -* [See `BackupEncryptionSettings` and `EncryptionMode` syntax](../../backup/create/one-time-backup.mdx#classes-and-enums-used-in-the-backup-configuration) +* [See `BackupEncryptionSettings` and `EncryptionMode` syntax](#classes-and-enums-used-in-the-backup-configuration) @@ -539,10 +539,10 @@ To back up a database immediately: ![Define and run backup operation](./assets/one-time-backup_define-config.png) - `A`. [Define basic backup options](../../backup/create/one-time-backup.mdx#a-define-basic-backup-options) - `B`. [Set backup encryption options](../../backup/create/one-time-backup.mdx#b-set-backup-encryption-options) - `C`. [Choose where to store the backup](../../backup/create/one-time-backup.mdx#c-choose-where-to-store-the-backup) - `D`. [Run the backup operation](../../backup/create/one-time-backup.mdx#d-run-the-backup-operation) + `A`. [Define basic backup options](#a-define-basic-backup-options) + `B`. [Set backup encryption options](#b-set-backup-encryption-options) + `C`. [Choose where to store the backup](#c-choose-where-to-store-the-backup) + `D`. [Run the backup operation](#d-run-the-backup-operation) --- @@ -660,7 +660,7 @@ You can select one or more storage locations for the backup, both local and remo ![Local storage settings](./assets/one-time-backup_storage_local.png) -* The **Backup Upload Mode** setting defined [above](../../backup/create/one-time-backup.mdx#a-define-basic-backup-options) determines whether to store the backup locally before sending it to any remote destination. +* The **Backup Upload Mode** setting defined [above](#a-define-basic-backup-options) determines whether to store the backup locally before sending it to any remote destination. diff --git a/docs/backup/create/periodic-tasks/database-backup.mdx b/docs/backup/create/periodic-tasks/database-backup.mdx index edf97614bd..6c4e352dc9 100644 --- a/docs/backup/create/periodic-tasks/database-backup.mdx +++ b/docs/backup/create/periodic-tasks/database-backup.mdx @@ -24,36 +24,36 @@ import ContentFrame from "@site/src/components/ContentFrame"; * See the variety of backup configuration options and settings in: [Backup overview](../../../backup/overview.mdx) - [Configuration syntax](../../../backup/create/periodic-tasks/database-backup.mdx#syntax) + [Configuration syntax](#syntax) * This article explains how to create periodic backup tasks for a **single database**. [Learn to create server-wide periodic backup tasks.](../../../backup/create/periodic-tasks/server-wide-backup.mdx) * In this article: - * [Creating and managing periodic backups using the client API](../../../backup/create/periodic-tasks/database-backup.mdx#creating-and-managing-periodic-backups-using-the-client-api) - * [Creating a backup task](../../../backup/create/periodic-tasks/database-backup.mdx#creating-a-backup-task) - * [Key configuration settings](../../../backup/create/periodic-tasks/database-backup.mdx#key-configuration-settings) - * [Getting backup task status](../../../backup/create/periodic-tasks/database-backup.mdx#getting-backup-task-status) - * [Updating a backup task](../../../backup/create/periodic-tasks/database-backup.mdx#updating-a-backup-task) - * [Deleting a backup task](../../../backup/create/periodic-tasks/database-backup.mdx#deleting-a-backup-task) - * [Managing backup operations](../../../backup/create/periodic-tasks/database-backup.mdx#managing-backup-operations) - * [Triggering an immediate backup operation](../../../backup/create/periodic-tasks/database-backup.mdx#triggering-an-immediate-backup-operation) - * [Delaying a running backup operation](../../../backup/create/periodic-tasks/database-backup.mdx#delaying-a-running-backup-operation) - * [Aborting a running backup operation](../../../backup/create/periodic-tasks/database-backup.mdx#aborting-a-running-backup-operation) - * [Syntax](../../../backup/create/periodic-tasks/database-backup.mdx#syntax) - * [Methods](../../../backup/create/periodic-tasks/database-backup.mdx#methods) - * [Classes](../../../backup/create/periodic-tasks/database-backup.mdx#classes) + * [Creating and managing periodic backups using the client API](#creating-and-managing-periodic-backups-using-the-client-api) + * [Creating a backup task](#creating-a-backup-task) + * [Key configuration settings](#key-configuration-settings) + * [Getting backup task status](#getting-backup-task-status) + * [Updating a backup task](#updating-a-backup-task) + * [Deleting a backup task](#deleting-a-backup-task) + * [Managing backup operations](#managing-backup-operations) + * [Triggering an immediate backup operation](#triggering-an-immediate-backup-operation) + * [Delaying a running backup operation](#delaying-a-running-backup-operation) + * [Aborting a running backup operation](#aborting-a-running-backup-operation) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) - * [Creating and managing periodic backups via Studio](../../../backup/create/periodic-tasks/database-backup.mdx#creating-and-managing-periodic-backups-via-studio) - * [Creating a backup task](../../../backup/create/periodic-tasks/database-backup.mdx#creating-a-backup-task-1) - * [Defining basic task options](../../../backup/create/periodic-tasks/database-backup.mdx#a-defining-basic-task-options) - * [Scheduling full and incremental backups](../../../backup/create/periodic-tasks/database-backup.mdx#b-scheduling-full-and-incremental-backups) - * [Setting backups retention policy](../../../backup/create/periodic-tasks/database-backup.mdx#c-setting-backups-retention-policy) - * [Setting backup encryption options](../../../backup/create/periodic-tasks/database-backup.mdx#d-setting-backup-encryption-options) - * [Choosing where to store the backups](../../../backup/create/periodic-tasks/database-backup.mdx#e-choosing-where-to-store-the-backups) - * [Saving and managing the task](../../../backup/create/periodic-tasks/database-backup.mdx#f-saving-and-managing-the-task) - * [Running a backup operation immediately](../../../backup/create/periodic-tasks/database-backup.mdx#running-a-backup-operation-immediately) - * [Delaying or aborting a running backup operation](../../../backup/create/periodic-tasks/database-backup.mdx#delaying-or-aborting-a-running-backup-operation) + * [Creating and managing periodic backups via Studio](#creating-and-managing-periodic-backups-via-studio) + * [Creating a backup task](#creating-a-backup-task-1) + * [Defining basic task options](#a-defining-basic-task-options) + * [Scheduling full and incremental backups](#b-scheduling-full-and-incremental-backups) + * [Setting backups retention policy](#c-setting-backups-retention-policy) + * [Setting backup encryption options](#d-setting-backup-encryption-options) + * [Choosing where to store the backups](#e-choosing-where-to-store-the-backups) + * [Saving and managing the task](#f-saving-and-managing-the-task) + * [Running a backup operation immediately](#running-a-backup-operation-immediately) + * [Delaying or aborting a running backup operation](#delaying-or-aborting-a-running-backup-operation) @@ -67,11 +67,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; To create a periodic backup task: * Define a **backup configuration** using a `PeriodicBackupConfiguration` instance. The configuration sets the [schedule](../../../backup/overview.mdx#periodic-backup-tasks) for backups creation and specifies other task settings, including: - - The [type](../../../backup/create/periodic-tasks/database-backup.mdx#setting-backup-type) of backups to create (logical backups or snapshot images). - - Backups [scope and schedule](../../../backup/create/periodic-tasks/database-backup.mdx#setting-backups-scope-and-schedule) (schedule full and/or incremental backups). - - Where to [store](../../../backup/create/periodic-tasks/database-backup.mdx#setting-storage-destinations) backups (locally and/or remotely). - - Whether to use a [retention policy](../../../backup/create/periodic-tasks/database-backup.mdx#setting-retention-policy) to delete outdated backups. - - If and how to use [encryption](../../../backup/create/periodic-tasks/database-backup.mdx#setting-encryption). + - The [type](#setting-backup-type) of backups to create (logical backups or snapshot images). + - Backups [scope and schedule](#setting-backups-scope-and-schedule) (schedule full and/or incremental backups). + - Where to [store](#setting-storage-destinations) backups (locally and/or remotely). + - Whether to use a [retention policy](#setting-retention-policy) to delete outdated backups. + - If and how to use [encryption](#setting-encryption). * When the configuration is prepared, pass the instance to `UpdatePeriodicBackupOperation` to create the backup task on the server and schedule the backup routine for the database. @@ -142,7 +142,7 @@ To create a periodic backup task: }; ``` -- [See `BackupType` syntax](../../../backup/create/periodic-tasks/database-backup.mdx#classes-and-enums-used-in-the-backup-configuration) +- [See `BackupType` syntax](#classes-and-enums-used-in-the-backup-configuration) --- @@ -164,7 +164,7 @@ To create a periodic backup task: }; ``` -- [See `FullBackupFrequency` and `IncrementalBackupFrequency` syntax](../../../backup/create/periodic-tasks/database-backup.mdx#backup-configuration-classes) +- [See `FullBackupFrequency` and `IncrementalBackupFrequency` syntax](#backup-configuration-classes) --- @@ -214,7 +214,7 @@ To create a periodic backup task: } ``` -- [See destinations-related syntax](../../../backup/create/periodic-tasks/database-backup.mdx#backup-destinations-classes) +- [See destinations-related syntax](#backup-destinations-classes) --- @@ -241,7 +241,7 @@ To create a periodic backup task: }; ``` -- [See `RetentionPolicy` syntax](../../../backup/create/periodic-tasks/database-backup.mdx#classes-and-enums-used-in-the-backup-configuration) +- [See `RetentionPolicy` syntax](#classes-and-enums-used-in-the-backup-configuration) --- @@ -277,7 +277,7 @@ Set backup encryption using the backup configuration `BackupEncryptionSettings` }; ``` -* [See `BackupEncryptionSettings` and `EncryptionMode` syntax](../../../backup/create/periodic-tasks/database-backup.mdx#classes-and-enums-used-in-the-backup-configuration) +* [See `BackupEncryptionSettings` and `EncryptionMode` syntax](#classes-and-enums-used-in-the-backup-configuration) @@ -287,10 +287,10 @@ Set backup encryption using the backup configuration `BackupEncryptionSettings` To retrieve the status of a backup task after its last run, use `GetPeriodicBackupStatusOperation` with the task ID. - If you don't have the task ID, you can get it using `GetOngoingTaskInfoOperation` with the task name. -- The retrieved status reflects the **most recent completed backup run**, whether it was scheduled or [triggered manually](../../../backup/create/periodic-tasks/database-backup.mdx#triggering-an-immediate-backup-operation). +- The retrieved status reflects the **most recent completed backup run**, whether it was scheduled or [triggered manually](#triggering-an-immediate-backup-operation). - The status includes the number of backups performed by the task, and details about the last backup such as the backup timestamp, duration, destination path, and error information (if any). -[See GetPeriodicBackupStatusOperation syntax](../../../backup/create/periodic-tasks/database-backup.mdx#task-management) +[See GetPeriodicBackupStatusOperation syntax](#task-management) #### Example: ```csharp @@ -559,7 +559,7 @@ await store.Maintenance.SendAsync(new DelayBackupOperation( await store.Commands().ExecuteAsync(new KillOperationCommand(runningOperationId)); ``` -* To abort a backup that was triggered [manually](../../../backup/create/periodic-tasks/database-backup.mdx#triggering-an-immediate-backup-operation) using `StartBackupOperation`: +* To abort a backup that was triggered [manually](#triggering-an-immediate-backup-operation) using `StartBackupOperation`: - Extract the backup operation ID from the result returned by `StartBackupOperation`. - Use the backup operation ID to abort the operation. - Also extract and use the responsible node tag to ensure that the operation is aborted on the correct cluster node. @@ -666,7 +666,7 @@ GetPeriodicBackupStatusOperationResult result = await store.Maintenance.SendAsyn | **IsEncrypted** | `bool` | Whether the backup was encrypted. | | **Error** | `Error` | Error details if the last backup run failed, `null` otherwise.
Contains `Exception` (`string`) and `At` (`DateTime`). | | **LastOperationId** | `long?` | The operation ID of the last backup run. | -| **DelayUntil** | `DateTime?` | If the backup was [delayed](../../../backup/create/periodic-tasks/database-backup.mdx#delaying-a-running-backup-operation), the time at which it will resume. | +| **DelayUntil** | `DateTime?` | If the backup was [delayed](#delaying-a-running-backup-operation), the time at which it will resume. | | **LocalBackup** | `LocalBackup` | Local backup details.
`BackupDirectory` (`string`) contains the local path if local storage was configured as a backup destination, or `null` if local storage was only used as a temporary staging area for remote uploads.
Also contains `FileName` (`string`) and `TempFolderUsed` (`bool`). | | **UploadToS3** | `UploadToS3` | Amazon S3 upload status. `null` if S3 was not configured as a destination. | | **UploadToGlacier** | `UploadToGlacier` | Amazon Glacier upload status. `null` if Glacier was not configured. | @@ -744,7 +744,7 @@ GetShardedPeriodicBackupStatusOperationResult result = await store.Maintenance.S | Return value | | |-----------|-------------| -| `GetShardedPeriodicBackupStatusOperationResult` | Contains `Statuses` (`Dictionary`) — a dictionary mapping each shard number to its backup status.
Each value is a `PeriodicBackupStatus` with the [same properties](../../../backup/create/periodic-tasks/database-backup.mdx#getting-backup-task-status) as the non-sharded result. | +| `GetShardedPeriodicBackupStatusOperationResult` | Contains `Statuses` (`Dictionary`) — a dictionary mapping each shard number to its backup status.
Each value is a `PeriodicBackupStatus` with the [same properties](#getting-backup-task-status) as the non-sharded result. | @@ -1289,12 +1289,12 @@ And then define and save the new task to start the backup schedule. ![Define a backup task](./assets/database-periodic_define-task.png) -`A`. [Defining basic task options](../../../backup/create/periodic-tasks/database-backup.mdx#a-defining-basic-task-options) -`B`. [Scheduling full and incremental backups](../../../backup/create/periodic-tasks/database-backup.mdx#b-scheduling-full-and-incremental-backups) -`C`. [Setting backups retention policy](../../../backup/create/periodic-tasks/database-backup.mdx#c-setting-backups-retention-policy) -`D`. [Setting backup encryption options](../../../backup/create/periodic-tasks/database-backup.mdx#d-setting-backup-encryption-options) -`E`. [Choosing where to store the backups](../../../backup/create/periodic-tasks/database-backup.mdx#e-choosing-where-to-store-the-backups) -`F`. [Saving and managing the task](../../../backup/create/periodic-tasks/database-backup.mdx#f-saving-and-managing-the-task) +`A`. [Defining basic task options](#a-defining-basic-task-options) +`B`. [Scheduling full and incremental backups](#b-scheduling-full-and-incremental-backups) +`C`. [Setting backups retention policy](#c-setting-backups-retention-policy) +`D`. [Setting backup encryption options](#d-setting-backup-encryption-options) +`E`. [Choosing where to store the backups](#e-choosing-where-to-store-the-backups) +`F`. [Saving and managing the task](#f-saving-and-managing-the-task) --- @@ -1456,7 +1456,7 @@ You can select one or more storage locations for your backups, both local and re ![Local storage settings](./assets/database-periodic_storage_local.png) -* The **Backup Upload Mode** setting defined [above](../../../backup/create/periodic-tasks/database-backup.mdx#a-defining-basic-task-options) applies to all remote storage locations, determining whether to store backups locally before transferring them to their destinations. +* The **Backup Upload Mode** setting defined [above](#a-defining-basic-task-options) applies to all remote storage locations, determining whether to store backups locally before transferring them to their destinations. --- diff --git a/docs/backup/create/periodic-tasks/server-wide-backup.mdx b/docs/backup/create/periodic-tasks/server-wide-backup.mdx index f585daf2e2..ad2b566a38 100644 --- a/docs/backup/create/periodic-tasks/server-wide-backup.mdx +++ b/docs/backup/create/periodic-tasks/server-wide-backup.mdx @@ -25,27 +25,27 @@ import ContentFrame from "@site/src/components/ContentFrame"; * In this article: - * [Overview](../../../backup/create/periodic-tasks/server-wide-backup.mdx#overview) - * [Creating and managing server-wide backup tasks using the client API](../../../backup/create/periodic-tasks/server-wide-backup.mdx#creating-and-managing-server-wide-backup-tasks-using-the-client-api) - * [Creating a server-wide backup task](../../../backup/create/periodic-tasks/server-wide-backup.mdx#creating-a-server-wide-backup-task) - * [Getting a derived backup task status](../../../backup/create/periodic-tasks/server-wide-backup.mdx#getting-a-derived-backup-task-status) - * [Updating a server-wide backup task](../../../backup/create/periodic-tasks/server-wide-backup.mdx#updating-a-server-wide-backup-task) - * [Deleting a server-wide backup task](../../../backup/create/periodic-tasks/server-wide-backup.mdx#deleting-a-server-wide-backup-task) - * [Managing backup operations](../../../backup/create/periodic-tasks/server-wide-backup.mdx#managing-backup-operations) - * [Triggering an immediate backup operation](../../../backup/create/periodic-tasks/server-wide-backup.mdx#triggering-an-immediate-backup-operation) - * [Delaying a running backup operation](../../../backup/create/periodic-tasks/server-wide-backup.mdx#delaying-a-running-backup-operation) - * [Aborting a running backup operation](../../../backup/create/periodic-tasks/server-wide-backup.mdx#aborting-a-running-backup-operation) - * [Syntax](../../../backup/create/periodic-tasks/server-wide-backup.mdx#syntax) - * [Methods](../../../backup/create/periodic-tasks/server-wide-backup.mdx#methods) - * [Classes](../../../backup/create/periodic-tasks/server-wide-backup.mdx#classes) - - * [Creating and managing server-wide backup tasks via Studio](../../../backup/create/periodic-tasks/server-wide-backup.mdx#creating-and-managing-server-wide-backup-tasks-via-studio) - * [Creating a server-wide backup task](../../../backup/create/periodic-tasks/server-wide-backup.mdx#creating-a-server-wide-backup-task) - * [Managing server-wide tasks](../../../backup/create/periodic-tasks/server-wide-backup.mdx#managing-server-wide-tasks) - - [Managing the parent server-wide task](../../../backup/create/periodic-tasks/server-wide-backup.mdx#managing-the-parent-server-wide-task) - - [Managing derived database tasks](../../../backup/create/periodic-tasks/server-wide-backup.mdx#managing-derived-database-tasks) - - [Running a backup operation immediately](../../../backup/create/periodic-tasks/server-wide-backup.mdx#running-a-backup-operation-immediately) - - [Delaying or aborting a running backup operation](../../../backup/create/periodic-tasks/server-wide-backup.mdx#delaying-or-aborting-a-running-backup-operation) + * [Overview](#overview) + * [Creating and managing server-wide backup tasks using the client API](#creating-and-managing-server-wide-backup-tasks-using-the-client-api) + * [Creating a server-wide backup task](#creating-a-server-wide-backup-task) + * [Getting a derived backup task status](#getting-a-derived-backup-task-status) + * [Updating a server-wide backup task](#updating-a-server-wide-backup-task) + * [Deleting a server-wide backup task](#deleting-a-server-wide-backup-task) + * [Managing backup operations](#managing-backup-operations) + * [Triggering an immediate backup operation](#triggering-an-immediate-backup-operation) + * [Delaying a running backup operation](#delaying-a-running-backup-operation) + * [Aborting a running backup operation](#aborting-a-running-backup-operation) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) + + * [Creating and managing server-wide backup tasks via Studio](#creating-and-managing-server-wide-backup-tasks-via-studio) + * [Creating a server-wide backup task](#creating-a-server-wide-backup-task) + * [Managing server-wide tasks](#managing-server-wide-tasks) + - [Managing the parent server-wide task](#managing-the-parent-server-wide-task) + - [Managing derived database tasks](#managing-derived-database-tasks) + - [Running a backup operation immediately](#running-a-backup-operation-immediately) + - [Delaying or aborting a running backup operation](#delaying-or-aborting-a-running-backup-operation) @@ -81,7 +81,7 @@ For example: To create a server-wide backup task: * Define a **backup configuration** using a `ServerWideBackupConfiguration` instance. - - `ServerWideBackupConfiguration` inherits from [PeriodicBackupConfiguration](../../../backup/create/periodic-tasks/server-wide-backup.mdx#backup-configuration-classes), which defines all configuration options used by both server-wide and regular database backup tasks. + - `ServerWideBackupConfiguration` inherits from [PeriodicBackupConfiguration](#backup-configuration-classes), which defines all configuration options used by both server-wide and regular database backup tasks. See the [periodic database backup task](../../../backup/create/periodic-tasks/database-backup.mdx) article for guidance about these options. - `ServerWideBackupConfiguration` adds the following server-wide-specific property: - `ExcludedDatabases` - A list of databases to [exclude](../../../backup/overview.mdx#excluding-databases-from-the-backup) from the server-wide backup. @@ -863,7 +863,7 @@ To manage a database backup task derived from a server-wide task: - The **retention period** for stored backups. - **Editing** and **deleting** the task are available only from the [parent server-wide task](../../../backup/create/periodic-tasks/server-wide-backup.mdx#managing-the-parent-server-wide-task). + **Editing** and **deleting** the task are available only from the [parent server-wide task](#managing-the-parent-server-wide-task). --- diff --git a/docs/backup/overview.mdx b/docs/backup/overview.mdx index 67c5a681e0..e68da82e2b 100644 --- a/docs/backup/overview.mdx +++ b/docs/backup/overview.mdx @@ -19,40 +19,40 @@ import ContentFrame from "@site/src/components/ContentFrame"; * RavenDB provides a powerful and diverse backup mechanism that you can use to both secure your data and retain access to it as it was at specific points in time. -* You can create [periodic](../studio/database/tasks/ongoing-tasks/general-info.mdx) backup tasks that generate [full](../backup/overview.mdx#full-backup) or [incremental](../backup/overview.mdx#incremental-backup) backups on a predefined schedule. - Whenever needed, you can also run a [one-time backup](../backup/overview.mdx#one-time-backup-operation) operation. +* You can create [periodic](../studio/database/tasks/ongoing-tasks/general-info.mdx) backup tasks that generate [full](#full-backup) or [incremental](#incremental-backup) backups on a predefined schedule. + Whenever needed, you can also run a [one-time backup](#one-time-backup-operation) operation. -* Backups can be [logical](../backup/overview.mdx#logical-backup) JSON-based dumps of database content, or binary [snapshot](../backup/overview.mdx#snapshot-image) images. +* Backups can be [logical](#logical-backup) JSON-based dumps of database content, or binary [snapshot](#snapshot-image) images. -* Backup files can be [encrypted](../backup/overview.mdx#encryption). +* Backup files can be [encrypted](#encryption). -* To save storage space, backups are [compressed](../backup/overview.mdx#compression), and you can set a [retention policy](../backup/overview.mdx#retention-policy) to automatically delete outdated backup files. +* To save storage space, backups are [compressed](#compression), and you can set a [retention policy](#retention-policy) to automatically delete outdated backup files. * You can create and configure backup tasks using the client API or via Studio. * In this article: - * [Backup recurrence](../backup/overview.mdx#backup-recurrence) - * [Periodic backup tasks](../backup/overview.mdx#periodic-backup-tasks) - * [One-time backup operation](../backup/overview.mdx#one-time-backup-operation) - * [Backup type](../backup/overview.mdx#backup-type) - * [Logical backup](../backup/overview.mdx#logical-backup) - * [Snapshot image](../backup/overview.mdx#snapshot-image) - * [Backup content](../backup/overview.mdx#backup-content) - * [Backup scope](../backup/overview.mdx#backup-scope) - * [Full backup](../backup/overview.mdx#full-backup) - * [Incremental backup](../backup/overview.mdx#incremental-backup) - * [Backup storage](../backup/overview.mdx#backup-storage) - * [Local and remote storage](../backup/overview.mdx#local-and-remote-storage) - * [Overriding storage settings with an external script](../backup/overview.mdx#overriding-storage-settings-with-an-external-script) - * [Naming and folder structure](../backup/overview.mdx#naming-and-folder-structure) - * [Encryption](../backup/overview.mdx#encryption) - * [Compression](../backup/overview.mdx#compression) - * [Retention policy](../backup/overview.mdx#retention-policy) - * [Server-wide backup](../backup/overview.mdx#server-wide-backup) - * [Backup on a sharded database](../backup/overview.mdx#backup-on-a-sharded-database) - * [Monitoring backup tasks](../backup/overview.mdx#monitoring-backup-tasks) - * [Restoring from backup](../backup/overview.mdx#restoring-from-backup) - * [Recommended precautions](../backup/overview.mdx#recommended-precautions) + * [Backup recurrence](#backup-recurrence) + * [Periodic backup tasks](#periodic-backup-tasks) + * [One-time backup operation](#one-time-backup-operation) + * [Backup type](#backup-type) + * [Logical backup](#logical-backup) + * [Snapshot image](#snapshot-image) + * [Backup content](#backup-content) + * [Backup scope](#backup-scope) + * [Full backup](#full-backup) + * [Incremental backup](#incremental-backup) + * [Backup storage](#backup-storage) + * [Local and remote storage](#local-and-remote-storage) + * [Overriding storage settings with an external script](#overriding-storage-settings-with-an-external-script) + * [Naming and folder structure](#naming-and-folder-structure) + * [Encryption](#encryption) + * [Compression](#compression) + * [Retention policy](#retention-policy) + * [Server-wide backup](#server-wide-backup) + * [Backup on a sharded database](#backup-on-a-sharded-database) + * [Monitoring backup tasks](#monitoring-backup-tasks) + * [Restoring from backup](#restoring-from-backup) + * [Recommended precautions](#recommended-precautions) @@ -94,7 +94,7 @@ One-time backups are also useful when you want to create a backup at a specific -You can back up your data in a JSON-based [logical backup](../backup/overview.mdx#logical-backup), that is typically smaller and quicker to transfer, or as a binary [snapshot image](../backup/overview.mdx#snapshot-image), that is typically faster to restore. +You can back up your data in a JSON-based [logical backup](#logical-backup), that is typically smaller and quicker to transfer, or as a binary [snapshot image](#snapshot-image), that is typically faster to restore. | Backup type | Format | Restore speed | Size | | ------ | ------ | --- | --- | | Logical backup | Compressed textual data - JSON | Slower than a snapshot | Smaller than a snapshot | @@ -104,9 +104,9 @@ You can back up your data in a JSON-based [logical backup](../backup/overview.md ### Logical backup -A logical backup is a compressed JSON dump of the database content at a given point in time, including documents, index definitions (but **not** the actual index data), ongoing tasks, and [additional data](../backup/overview.mdx#backup-content). +A logical backup is a compressed JSON dump of the database content at a given point in time, including documents, index definitions (but **not** the actual index data), ongoing tasks, and [additional data](#backup-content). -* Both [full](../backup/overview.mdx#full-backup) and [incremental](../backup/overview.mdx#incremental-backup) backups are stored in a JSON-based format. +* Both [full](#full-backup) and [incremental](#incremental-backup) backups are stored in a JSON-based format. * A full logical backup is typically much smaller than an equivalent snapshot image, but restore time is longer because documents and index definitions need to be inserted into the newly created database. * Following the restore operation, the database is scanned and re-indexed according to the index definitions. This operation can be time-consuming when performed on large datasets. @@ -116,7 +116,7 @@ A logical backup is a compressed JSON dump of the database content at a given po ### Snapshot image -A snapshot is a compressed binary image of the entire database structure at a given point in time, including document data, [journals](../server/storage/storage-engine.mdx#transaction-support), indexes, ongoing tasks, and [additional data](../backup/overview.mdx#backup-content). +A snapshot is a compressed binary image of the entire database structure at a given point in time, including document data, [journals](../server/storage/storage-engine.mdx#transaction-support), indexes, ongoing tasks, and [additional data](#backup-content). @@ -125,7 +125,7 @@ A snapshot is a compressed binary image of the entire database structure at a gi * A snapshot is typically larger than an equivalent logical backup, but restore time is reduced because documents and index definitions do not need to be inserted into the database, and subsequent re-indexing is not required. -* [Incremental](../backup/overview.mdx#incremental-backup) backups following the initial complete snapshot are stored in **JSON format**, similar to logical backups. They do **not** carry index or change vectors data as the full snapshot does. +* [Incremental](#incremental-backup) backups following the initial complete snapshot are stored in **JSON format**, similar to logical backups. They do **not** carry index or change vectors data as the full snapshot does. @@ -139,7 +139,7 @@ Backups contain both database-level and cluster-level content, as detailed below ### Database-level data -| Content | Included in [logical backups](../backup/overview.mdx#logical-backup) | Included in [snapshots](../backup/overview.mdx#snapshot-image) | +| Content | Included in [logical backups](#logical-backup) | Included in [snapshots](#snapshot-image) | |---- | ---- | ---- | | [Documents & Revisions](https://ravendb.net/learn/inside-ravendb-book/reader/4.0/3-document-modeling) | ✔ | ✔ | | [Attachments](../document-extensions/attachments/overview.mdx) | ✔ | ✔ | @@ -154,7 +154,7 @@ Backups contain both database-level and cluster-level content, as detailed below ### Cluster-level data -| Content | Included in [logical backups](../backup/overview.mdx#logical-backup) | Included in [snapshots](../backup/overview.mdx#snapshot-image) | +| Content | Included in [logical backups](#logical-backup) | Included in [snapshots](#snapshot-image) | |---- | ---- | ---- | | [Database Record](../studio/database/settings/database-record.mdx) | ✔ | ✔ | | [Compare-exchange values](../compare-exchange/overview.mdx) | ✔ | ✔ | @@ -171,7 +171,7 @@ Backups contain both database-level and cluster-level content, as detailed below A backup task can create **full** and/or **incremental** backups. - Each time a backup task (full or incremental) is executed, a single new backup file is added. -- Existing backup files are not modified or deleted by the task, unless a [retention policy](../backup/overview.mdx#retention-policy) is set. +- Existing backup files are not modified or deleted by the task, unless a [retention policy](#retention-policy) is set. @@ -179,7 +179,7 @@ A backup task can create **full** and/or **incremental** backups. #### Full logical backup: -A full [logical backup](../backup/overview.mdx#logical-backup) contains the whole database content, except for full indexes and change vectors. +A full [logical backup](#logical-backup) contains the whole database content, except for full indexes and change vectors. - A full backup, containing one compressed file with the entire database content, is always created in a new subfolder in the backup directory. @@ -205,7 +205,7 @@ A full [logical backup](../backup/overview.mdx#logical-backup) contains the whol #### Full snapshot image: -A full [snapshot image](../backup/overview.mdx#snapshot-image) is a duplication of the entire database content. +A full [snapshot image](#snapshot-image) is a duplication of the entire database content. * **Location** When stored locally, a full backup is always created in a new subfolder in the backup directory. @@ -227,7 +227,7 @@ An incremental backup contains only **the changes** made to the database since t When an incremental-backup task is executed: -- If no backup file is found, the task creates a [full backup](../backup/overview.mdx#full-backup) first. Subsequent backups will be incremental. +- If no backup file is found, the task creates a [full backup](#full-backup) first. Subsequent backups will be incremental. - If the database has not changed since the last backup, the backup is skipped - no backup file is produced. @@ -394,7 +394,7 @@ Each incremental-backup file contains only the changes made in the database sinc #### Logical backup encryption: -When creating a [logical backup](../backup/overview.mdx#logical-backup), the following options are available: +When creating a [logical backup](#logical-backup), the following options are available: * If the database the backup is made for is **unencrypted**: - You can create an unencrypted backup. @@ -510,7 +510,7 @@ As multiple databases are backed up, the backups for each database are kept sepa #### Server-wide encryption settings: -- When a derived database task is applied to an **unencrypted** database, it behaves similarly to a [regular database backup task](../backup/overview.mdx#encryption): +- When a derived database task is applied to an **unencrypted** database, it behaves similarly to a [regular database backup task](#encryption): - A **snapshot** will always be **unencrypted**. - A **logical backup** will comply with the configuration settings, and can be either unencrypted or encrypted using a user-provided key. @@ -629,7 +629,7 @@ The backup procedure addresses requirements that simply copying the database fol #### Regularly remove old backup files. -Define a [retention policy](../backup/overview.mdx#retention-policy) to automatically remove outdated files and free up storage space. +Define a [retention policy](#retention-policy) to automatically remove outdated files and free up storage space. When setting the retention period, consider how long backups should be retained to balance storage needs and recovery requirements. diff --git a/docs/backup/restore.mdx b/docs/backup/restore.mdx index f2b99b6277..16b01b13f0 100644 --- a/docs/backup/restore.mdx +++ b/docs/backup/restore.mdx @@ -27,19 +27,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Learn to restore a sharded database.](../sharding/backup-and-restore/restore.mdx) * In this article: - * [Restoring from backup using the client API](../backup/restore.mdx#restoring-from-backup-using-the-client-api) - * [Restoring a database from backup](../backup/restore.mdx#restoring-a-database-from-backup) - * [Key configuration settings](../backup/restore.mdx#key-configuration-settings) - * [Setting restore points](../backup/restore.mdx#lastfilenametorestore---setting-restore-points) - * [Encryption settings](../backup/restore.mdx#encryptionkey--backupencryptionsettings---encryption-settings) - * [Backup location settings](../backup/restore.mdx#restorebackupconfiguration---backup-location-settings) - * [Syntax](../backup/restore.mdx#syntax) - * [Restoring from backup using Studio](../backup/restore.mdx#restoring-from-backup-using-studio) - * [Set restore options](../backup/restore.mdx#set-restore-options) - * [Restoring a database to multiple cluster nodes](../backup/restore.mdx#restoring-a-database-to-multiple-cluster-nodes) - * [Restoring to a single node and replicating to additional nodes](../backup/restore.mdx#restoring-to-a-single-node-and-replicating-to-additional-nodes) - * [Restoring to multiple nodes simultaneously](../backup/restore.mdx#restoring-to-multiple-nodes-simultaneously) - * [Restoring from server-wide backups](../backup/restore.mdx#restoring-from-server-wide-backups) + * [Restoring from backup using the client API](#restoring-from-backup-using-the-client-api) + * [Restoring a database from backup](#restoring-a-database-from-backup) + * [Key configuration settings](#key-configuration-settings) + * [Setting restore points](#lastfilenametorestore---setting-restore-points) + * [Encryption settings](#encryptionkey--backupencryptionsettings---encryption-settings) + * [Backup location settings](#restorebackupconfiguration---backup-location-settings) + * [Syntax](#syntax) + * [Restoring from backup using Studio](#restoring-from-backup-using-studio) + * [Set restore options](#set-restore-options) + * [Restoring a database to multiple cluster nodes](#restoring-a-database-to-multiple-cluster-nodes) + * [Restoring to a single node and replicating to additional nodes](#restoring-to-a-single-node-and-replicating-to-additional-nodes) + * [Restoring to multiple nodes simultaneously](#restoring-to-multiple-nodes-simultaneously) + * [Restoring from server-wide backups](#restoring-from-server-wide-backups) @@ -157,7 +157,7 @@ await store.Maintenance.Server * `BackupEncryptionSettings` Use this property to **decrypt an encrypted backup**. - [See details in the syntax section.](../backup/restore.mdx#additional-restore-classes) + [See details in the syntax section.](#additional-restore-classes) **Example:** @@ -186,7 +186,7 @@ Choose where to restore the backup from by using a restore configuration that ma * `RestoreFromAzureConfiguration` - To restore from Azure Blob Storage. * `RestoreFromGoogleCloudConfiguration` - To restore from Google Cloud Storage. -[See details in the syntax section.](../backup/restore.mdx#restore-configuration-classes) +[See details in the syntax section.](#restore-configuration-classes) @@ -883,7 +883,7 @@ To restore **from a snapshot** into multiple nodes simultaneously and join the d fromNode: "B", timeToWaitForConfirmation: null)); ``` * **Rename** the deleted database's folder on each respective node to match the name of the remaining database. -* On the node you didn't delete the database from, expand the database group (as [shown above](../backup/restore.mdx#using-studio)) to include all the other nodes. +* On the node you didn't delete the database from, expand the database group (as [shown above](#using-studio)) to include all the other nodes. diff --git a/docs/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx b/docs/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx index d5a37e8446..a56e3a5345 100644 --- a/docs/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx +++ b/docs/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx @@ -9,23 +9,23 @@ import ContentFrame from "@site/src/components/ContentFrame"; * `BulkInsert` is useful when inserting a large quantity of data from the client to the server. * It is an optimized time-saving approach with a few - [limitations](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#limitations) + [limitations](#limitations) like the possibility that interruptions will occur during the operation. * In this page: - * [Quick example](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#quick-example) - * [`BulkInsertOperation`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoperation) - * [Methods](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#methods) - * [Limitations](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#limitations) - * [Example](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#example) - * [`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) - * [CompressionLevel](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#compressionlevel) - * [SkipOverwriteIfUnchanged](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#skipoverwriteifunchanged) - * [Track progress with OnProgress](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#track-progress-with-onprogress) - * [Syntax](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#syntax) - * [Method signatures](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#method-signatures) - * [Event signature](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#event-signature) - * [Classes](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#classes) + * [Quick example](#quick-example) + * [`BulkInsertOperation`](#bulkinsertoperation) + * [Methods](#methods) + * [Limitations](#limitations) + * [Example](#example) + * [`BulkInsertOptions`](#bulkinsertoptions) + * [CompressionLevel](#compressionlevel) + * [SkipOverwriteIfUnchanged](#skipoverwriteifunchanged) + * [Track progress with OnProgress](#track-progress-with-onprogress) + * [Syntax](#syntax) + * [Method signatures](#method-signatures) + * [Event signature](#event-signature) + * [Classes](#classes) @@ -48,7 +48,7 @@ using (BulkInsertOperation bulkInsert = store.BulkInsert())
For the full set of `BulkInsert` overloads and their parameters, see the -[Syntax](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#syntax) +[Syntax](#syntax) section at the end of this page. @@ -89,7 +89,7 @@ The following methods can be used when creating a bulk insert. cause some of your data not to persist on the server yet. * If the operation was interrupted and you choose to re-insert the whole dataset in a new operation, you can set - [SkipOverwriteIfUnchanged](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#skipoverwriteifunchanged) + [SkipOverwriteIfUnchanged](#skipoverwriteifunchanged) to `true` so the operation overwrites existing documents only if they changed since the last insertion. * **If you need full transactionality**, using a @@ -223,7 +223,7 @@ so far - subscribe to the `OnProgress` event. The bulk insert delivers a progress snapshot to your handler each time the server reports new progress, with counters such as `DocumentsProcessed`, `BatchCount`, and the ID of the document processed most recently (`LastProcessedId`). -See [Classes](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#classes) +See [Classes](#classes) for the full property list. * Updates arrive asynchronously over the @@ -307,7 +307,7 @@ using (var bulkInsert = store.BulkInsert()) Opens a bulk insert against the given database with a -[`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) +[`BulkInsertOptions`](#bulkinsertoptions) instance to configure compression and overwrite behavior. ```csharp @@ -336,7 +336,7 @@ using (var bulkInsert = store.BulkInsert("Northwind", new BulkInsertOptions | Parameter | Type | Description | |-----------|------|-------------| | **database** | `string` | The name of the database to perform the bulk operation on.
If `null`, the `DocumentStore.Database` is used. | -| **options** | `BulkInsertOptions` | [Options](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) to configure BulkInsert. | +| **options** | `BulkInsertOptions` | [Options](#bulkinsertoptions) to configure BulkInsert. | | **token** | `CancellationToken` | Cancellation token used to halt the worker operation. | | Return value | | @@ -347,7 +347,7 @@ using (var bulkInsert = store.BulkInsert("Northwind", new BulkInsertOptions Opens a bulk insert against the document store's default database with a -[`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) +[`BulkInsertOptions`](#bulkinsertoptions) instance to configure compression and overwrite behavior. ```csharp @@ -374,7 +374,7 @@ using (var bulkInsert = store.BulkInsert(new BulkInsertOptions | Parameter | Type | Description | |-----------|------|-------------| -| **options** | `BulkInsertOptions` | [Options](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) to configure BulkInsert. | +| **options** | `BulkInsertOptions` | [Options](#bulkinsertoptions) to configure BulkInsert. | | **token** | `CancellationToken` | Cancellation token used to halt the worker operation. | | Return value | | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx index e9fe158519..df88cee222 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to counter changes: -- [ForCounter](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounter) -- [ForCounterOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounterofdocument) -- [ForCountersOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcountersofdocument) -- [ForAllCounters](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forallcounters) +- [ForCounter](#forcounter) +- [ForCounterOfDocument](#forcounterofdocument) +- [ForCountersOfDocument](#forcountersofdocument) +- [ForAllCounters](#forallcounters) ## ForCounter @@ -29,7 +29,7 @@ Counter changes can be observed using `ForCounter` method. This will subscribe c | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -74,7 +74,7 @@ Specific counter changes of a given document can be observed using `ForCounterOf | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -118,7 +118,7 @@ Counter changes of a specified document can be observed using `ForCountersOfDocu | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -158,7 +158,7 @@ Changes for all counters can be observed using `ForAllCounters` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -187,7 +187,7 @@ Changes for all counters can be observed using `ForAllCounters` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [CounterChangeTypes](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchangetypes) | Counter change type enum | +| **Type** | [CounterChangeTypes](#counterchangetypes) | Counter change type enum | | **Name** | string | Counter name | | **Value** | long | Counter value after the change | | **DocumentId** | string | Counter document identifier | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx index 87d72bb4df..9bf2858eda 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to counter changes: -- [ForCounter](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounter) -- [ForCounterOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounterofdocument) -- [ForCountersOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcountersofdocument) -- [ForAllCounters](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forallcounters) +- [ForCounter](#forcounter) +- [ForCounterOfDocument](#forcounterofdocument) +- [ForCountersOfDocument](#forcountersofdocument) +- [ForAllCounters](#forallcounters) ## ForCounter @@ -29,7 +29,7 @@ Counter changes can be observed using `forCounter` method. This will subscribe c | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -71,7 +71,7 @@ Specific counter changes of a given document can be observed using `forCounterOf | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -112,7 +112,7 @@ Counter changes of a specified document can be observed using `forCountersOfDocu | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -149,7 +149,7 @@ Changes for all counters can be observed using `forAllCounters` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -175,7 +175,7 @@ Changes for all counters can be observed using `forAllCounters` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [CounterChangeTypes](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchangetypes) | Counter change type enum | +| **Type** | [CounterChangeTypes](#counterchangetypes) | Counter change type enum | | **Name** | String | Counter name | | **Value** | Long | Counter value after the change | | **DocumentId** | String | Counter document identifier | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx index 684d3c9531..52cb7822f0 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [ForDocument](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [ForDocumentsInCollection](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [ForDocumentsStartingWith](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [ForAllDocuments](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [ForDocument](#fordocument) +- [ForDocumentsInCollection](#fordocumentsincollection) +- [ForDocumentsStartingWith](#fordocumentsstartingwith) +- [ForAllDocuments](#foralldocuments) ## ForDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `ForDocument` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | ### Example @@ -78,7 +78,7 @@ IChangesObservable ForDocumentsInCollection(); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with `TEntity` type uses `Conventions.GetCollectionName` to get collection name. @@ -130,7 +130,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -161,7 +161,7 @@ To observe all document changes use `ForAllDocuments` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -181,7 +181,7 @@ To observe all document changes use `ForAllDocuments` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **Type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **Id** | string | Document identifier | | **CollectionName** | string | Document's collection name | | **TypeName** | string | Type name | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx index 2278707899..170562433b 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [forDocument](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [forDocumentsInCollection](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [forDocumentsStartingWith](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [forAllDocuments](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [forDocument](#fordocument) +- [forDocumentsInCollection](#fordocumentsincollection) +- [forDocumentsStartingWith](#fordocumentsstartingwith) +- [forAllDocuments](#foralldocuments) ## forDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `forDocument` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | ### Example @@ -74,7 +74,7 @@ IChangesObservable forDocumentsInCollection(Class clazz); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with `TEntity` type uses `conventions.GetCollectionName` to get collection name. @@ -130,7 +130,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -163,7 +163,7 @@ To observe all document changes use `forAllDocuments` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -185,7 +185,7 @@ To observe all document changes use `forAllDocuments` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **Type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **Id** | String | Document identifier | | **CollectionName** | String | Document's collection name | | **TypeName** | String | Type name | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx index adf60a21e6..c34b2e7e88 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [forDocument()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [forDocumentsInCollection()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [forDocumentsStartingWith()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [forAllDocuments()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [forDocument()](#fordocument) +- [forDocumentsInCollection()](#fordocumentsincollection) +- [forDocumentsStartingWith()](#fordocumentsstartingwith) +- [forAllDocuments()](#foralldocuments) ## forDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `forDocument()` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add listeners for events for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add listeners for events for given document. | ### Example @@ -75,7 +75,7 @@ store.changes().forDocumentsInCollection(clazz); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with entity type uses `conventions.getCollectionNameForType()` to get collection name. @@ -128,7 +128,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -160,7 +160,7 @@ To observe all document changes use `forAllDocuments()` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -180,7 +180,7 @@ To observe all document changes use `forAllDocuments()` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **id** | string | Document identifier | | **collectionName** | string | Document's collection name | | **typeName** | string | Type name | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx index 59857984a7..8943990d0a 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [ForIndex](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [ForAllIndexes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [ForIndex](#forindex) +- [ForAllIndexes](#forallindexes) ## ForIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `ForIndex` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -93,7 +93,7 @@ Index changes for all indexex can be observed using `ForAllIndexes` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -124,7 +124,7 @@ Index changes for all indexex can be observed using `ForAllIndexes` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **Type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **Name** | string | Index name | | **Etag** | long? | Index Etag | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx index 8d02c69f94..f87a9cc20c 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [forIndex](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [forAllIndexes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [forIndex](#forindex) +- [forAllIndexes](#forallindexes) ## forIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `forIndex` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -93,7 +93,7 @@ Index changes for all indexex can be observed using `forAllIndexes` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -126,7 +126,7 @@ Index changes for all indexex can be observed using `forAllIndexes` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **Type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **Name** | String | Index name | | **Etag** | Long | Index Etag | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx index a7076e0764..d8e371da0e 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [forIndex()](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [forAllIndexes()](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [forIndex()](#forindex) +- [forAllIndexes()](#forallindexes) ## forIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `forIndex()` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -91,7 +91,7 @@ Index changes for all indexex can be observed using `forAllIndexes()` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -122,7 +122,7 @@ Index changes for all indexex can be observed using `forAllIndexes()` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **name** | string | Index name | | **etag** | number | Index Etag | diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx index bee95aa63c..7df2e9ed34 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [ForOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperationid) -- [ForAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [ForOperationId](#foroperationid) +- [ForAllOperations](#foralloperations) ## ForOperationId @@ -37,7 +37,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -89,7 +89,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax @@ -120,7 +120,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Name | Type | Description | | ------------- | ------------- | ----- | -| **State** | [OperationState](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationstate) | Operation state | +| **State** | [OperationState](#operationstate) | Operation state | | **OperationId** | long | Operation ID | @@ -131,9 +131,9 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Name | Type | Description | | ------------- | ------------- | ----- | -| **Result** | [IOperationResult](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationresult) | Operation result | +| **Result** | [IOperationResult](#operationresult) | Operation result | | **Progress** | IOperationProgress| Instance of IOperationProgress (json representation of the progress) | -| **Status** | [OperationStatus](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationstatus) | Operation status | +| **Status** | [OperationStatus](#operationstatus) | Operation status | ## OperationResult diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx index 5c10cb9f60..36533ee873 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [forOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperation) -- [forAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [forOperationId](#foroperation) +- [forAllOperations](#foralloperations) ## forOperation @@ -27,7 +27,7 @@ Operation changes for one operation can be observed using the `forOperationId` m | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -53,7 +53,7 @@ Operations changes for all Operations can be observed using the `forAllOperation | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx index ba5c3b0fa8..251ec63b6b 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [forOperationId()](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperation) -- [forAllOperations()](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [forOperationId()](#foroperation) +- [forAllOperations()](#foralloperations) ## forOperation @@ -27,7 +27,7 @@ Operation changes for one operation can be observed using the `forOperationId()` | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -51,7 +51,7 @@ Operations changes for all Operations can be observed using the `forAllOperation | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax diff --git a/docs/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx b/docs/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx index f4349a81fd..f168df060e 100644 --- a/docs/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx +++ b/docs/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Track **all** time series * In this page: - * [ForTimeSeries](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#fortimeseries) - * [ForTimeSeriesOfDocument](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#fortimeseriesofdocument) - * [ForAllTimeSeries](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#foralltimeseries) + * [ForTimeSeries](#fortimeseries) + * [ForTimeSeriesOfDocument](#fortimeseriesofdocument) + * [ForAllTimeSeries](#foralltimeseries) ## ForTimeSeries @@ -40,7 +40,7 @@ using the `ForTimeSeries` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -91,7 +91,7 @@ Use this `ForTimeSeriesOfDocument` overload to track changes in a **specific tim | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -131,7 +131,7 @@ Use this `ForTimeSeriesOfDocument` overload to track changes in **any time serie | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -171,7 +171,7 @@ Subscribe to changes in **all time-series** using the `ForAllTimeSeries` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -200,7 +200,7 @@ Subscribe to changes in **all time-series** using the `ForAllTimeSeries` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [TimeSeriesChangeTypes](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschangetypes) | Time series change type enum | +| **Type** | [TimeSeriesChangeTypes](#timeserieschangetypes) | Time series change type enum | | **Name** | string | Time Series Name | | **DocumentId** | string | Time series Document Identifier | | **CollectionName** | string | Time series document Collection Name | diff --git a/docs/client-api/changes/content/_what-is-changes-api-csharp.mdx b/docs/client-api/changes/content/_what-is-changes-api-csharp.mdx index 240dac83d6..24a4523913 100644 --- a/docs/client-api/changes/content/_what-is-changes-api-csharp.mdx +++ b/docs/client-api/changes/content/_what-is-changes-api-csharp.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [FAQ](../../../client-api/changes/what-is-changes-api.mdx#faq) - * [Changes API and Database Timeout](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-database-timeout) - * [Changes API and Method Overloads](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-method-overloads) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [FAQ](#faq) + * [Changes API and Database Timeout](#changes-api-and-database-timeout) + * [Changes API and Method Overloads](#changes-api-and-method-overloads) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API @@ -107,7 +107,7 @@ To receive notifications regarding server-side events, subscribe using one of th Track changes for a given index (by Index Name) * **For Operation Changes:** - Operation changes can be tracked only [on a specific node](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api). + Operation changes can be tracked only [on a specific node](#accessing-changes-api). - [ForAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) Track changes for all operation - [ForOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperationid) diff --git a/docs/client-api/changes/content/_what-is-changes-api-java.mdx b/docs/client-api/changes/content/_what-is-changes-api-java.mdx index df488dd95d..da3d724912 100644 --- a/docs/client-api/changes/content/_what-is-changes-api-java.mdx +++ b/docs/client-api/changes/content/_what-is-changes-api-java.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [Note](../../../client-api/changes/what-is-changes-api.mdx#note) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [Note](#note) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API diff --git a/docs/client-api/changes/content/_what-is-changes-api-nodejs.mdx b/docs/client-api/changes/content/_what-is-changes-api-nodejs.mdx index 2dc3ced34c..9ed8b354e2 100644 --- a/docs/client-api/changes/content/_what-is-changes-api-nodejs.mdx +++ b/docs/client-api/changes/content/_what-is-changes-api-nodejs.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [FAQ](../../../client-api/changes/what-is-changes-api.mdx#faq) - * [Changes API and Database Timeout](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-database-timeout) - * [Changes API and Method Overloads](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-method-overloads) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [FAQ](#faq) + * [Changes API and Database Timeout](#changes-api-and-database-timeout) + * [Changes API and Method Overloads](#changes-api-and-method-overloads) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API diff --git a/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx b/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx index f3e863f000..d3a6f3d781 100644 --- a/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx +++ b/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx b/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx index c3695729d3..1e50df5d81 100644 --- a/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx +++ b/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx b/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx index b8f38a0eb4..88a3625247 100644 --- a/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx +++ b/docs/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx b/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx index 43295e9d72..65e49fa867 100644 --- a/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx +++ b/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction). * In this page: - * [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples) - * [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands) - * [Syntax](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#syntax) + * [Examples](#examples) + * [Available batch commands](#available-batch-commands) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx b/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx index 03c73468d1..b89367e859 100644 --- a/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx +++ b/docs/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction). * In this page: - * [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples) - * [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands) - * [Syntax](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#syntax) + * [Examples](#examples) + * [Available batch commands](#available-batch-commands) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/content/_overview-csharp.mdx b/docs/client-api/commands/content/_overview-csharp.mdx index 6c14ce14a6..08c9be0d42 100644 --- a/docs/client-api/commands/content/_overview-csharp.mdx +++ b/docs/client-api/commands/content/_overview-csharp.mdx @@ -29,17 +29,17 @@ import CodeBlock from '@theme/CodeBlock'; * Commands are responsible for sending the appropriate request to the server using a `Request Executor`, and parsing the server's response. - * All commands can be executed using either the [Store's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-store) - or the [Session's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-session), + * All commands can be executed using either the [Store's _Request Executor_](#execute-command---using-the-store) + or the [Session's _Request Executor_](#execute-command---using-the-session), regardless of whether the command is session-related or not. * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Execute command - using the Store Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-store-request-executor) - * [Execute command - using the Session Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-session-request-executor) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Execute command - using the Store Request Executor](#execute-command---using-the-store-request-executor) + * [Execute command - using the Session Request Executor](#execute-command---using-the-session-request-executor) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Execute command - using the Store Request Executor diff --git a/docs/client-api/commands/content/_overview-java.mdx b/docs/client-api/commands/content/_overview-java.mdx index 6bd51f3993..729d2eae1f 100644 --- a/docs/client-api/commands/content/_overview-java.mdx +++ b/docs/client-api/commands/content/_overview-java.mdx @@ -35,9 +35,9 @@ import CodeBlock from '@theme/CodeBlock'; * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Examples](../../../client-api/commands/overview.mdx#examples) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Examples](#examples) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/content/_overview-nodejs.mdx b/docs/client-api/commands/content/_overview-nodejs.mdx index 8e2fe72792..fa373316f5 100644 --- a/docs/client-api/commands/content/_overview-nodejs.mdx +++ b/docs/client-api/commands/content/_overview-nodejs.mdx @@ -29,17 +29,17 @@ import CodeBlock from '@theme/CodeBlock'; * Commands are responsible for sending the appropriate request to the server using a `Request Executor`, and parsing the server's response. - * All commands can be executed using either the [Store's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-store) - or the [Session's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-session), + * All commands can be executed using either the [Store's _Request Executor_](#execute-command---using-the-store) + or the [Session's _Request Executor_](#execute-command---using-the-session), regardless of whether the command is session-related or not. * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Execute command - using the Store Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-store-request-executor) - * [Execute command - using the Session Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-session-request-executor) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Execute command - using the Store Request Executor](#execute-command---using-the-store-request-executor) + * [Execute command - using the Session Request Executor](#execute-command---using-the-session-request-executor) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Execute command - using the Store Request Executor diff --git a/docs/client-api/commands/documents/content/_delete-csharp.mdx b/docs/client-api/commands/documents/content/_delete-csharp.mdx index 67720eb954..d8c463593b 100644 --- a/docs/client-api/commands/documents/content/_delete-csharp.mdx +++ b/docs/client-api/commands/documents/content/_delete-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/delete.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/documents/content/_delete-nodejs.mdx b/docs/client-api/commands/documents/content/_delete-nodejs.mdx index 6505dd457d..dd631d5d02 100644 --- a/docs/client-api/commands/documents/content/_delete-nodejs.mdx +++ b/docs/client-api/commands/documents/content/_delete-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/delete.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/documents/content/_delete-php.mdx b/docs/client-api/commands/documents/content/_delete-php.mdx index 7ccc950619..dbc8c6cf39 100644 --- a/docs/client-api/commands/documents/content/_delete-php.mdx +++ b/docs/client-api/commands/documents/content/_delete-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/delete.mdx#example) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/docs/client-api/commands/documents/content/_delete-python.mdx b/docs/client-api/commands/documents/content/_delete-python.mdx index f440c8cf06..795d53ea6f 100644 --- a/docs/client-api/commands/documents/content/_delete-python.mdx +++ b/docs/client-api/commands/documents/content/_delete-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/delete.mdx#example) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/docs/client-api/commands/documents/content/_get-csharp.mdx b/docs/client-api/commands/documents/content/_get-csharp.mdx index 07181a74c3..9437aee2db 100644 --- a/docs/client-api/commands/documents/content/_get-csharp.mdx +++ b/docs/client-api/commands/documents/content/_get-csharp.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../querying/overview.mdx). * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents - by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents---by-id-prefix) - - [Get documents - with includes](../../../../client-api/commands/documents/get.mdx#get-documents---with-includes) - - [Syntax](../../../../client-api/commands/documents/get.mdx#syntax) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get metadata only](#get-metadata-only) + - [Get paged documents](#get-paged-documents) + - [Get documents - by ID prefix](#get-documents---by-id-prefix) + - [Get documents - with includes](#get-documents---with-includes) + - [Syntax](#syntax) ## Get single document diff --git a/docs/client-api/commands/documents/content/_get-java.mdx b/docs/client-api/commands/documents/content/_get-java.mdx index 9740299364..92110c1be6 100644 --- a/docs/client-api/commands/documents/content/_get-java.mdx +++ b/docs/client-api/commands/documents/content/_get-java.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; There are a few methods that allow you to retrieve documents from a database: -- [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) -- [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) -- [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) -- [Get documents by starts with](../../../../client-api/commands/documents/get.mdx#get-by-starts-with) -- [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) +- [Get single document](#get-single-document) +- [Get multiple documents](#get-multiple-documents) +- [Get paged documents](#get-paged-documents) +- [Get documents by starts with](#get-by-starts-with) +- [Get metadata only](#get-metadata-only) ## Get single document diff --git a/docs/client-api/commands/documents/content/_get-nodejs.mdx b/docs/client-api/commands/documents/content/_get-nodejs.mdx index 1cfcddf3b4..de7a3a4385 100644 --- a/docs/client-api/commands/documents/content/_get-nodejs.mdx +++ b/docs/client-api/commands/documents/content/_get-nodejs.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../querying/overview.mdx). * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents - by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents---by-id-prefix) - - [Get documents - with includes](../../../../client-api/commands/documents/get.mdx#get-documents---with-includes) - - [Syntax](../../../../client-api/commands/documents/get.mdx#syntax) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get metadata only](#get-metadata-only) + - [Get paged documents](#get-paged-documents) + - [Get documents - by ID prefix](#get-documents---by-id-prefix) + - [Get documents - with includes](#get-documents---with-includes) + - [Syntax](#syntax) ## Get single document diff --git a/docs/client-api/commands/documents/content/_get-php.mdx b/docs/client-api/commands/documents/content/_get-php.mdx index 35c5509bd3..4e98a2fa47 100644 --- a/docs/client-api/commands/documents/content/_get-php.mdx +++ b/docs/client-api/commands/documents/content/_get-php.mdx @@ -8,10 +8,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetDocumentsCommand` to retrieve documents from the database. * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents-by-id-prefix) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get paged documents](#get-paged-documents) + - [Get documents by ID prefix](#get-documents-by-id-prefix) ## Get single document diff --git a/docs/client-api/commands/documents/content/_get-python.mdx b/docs/client-api/commands/documents/content/_get-python.mdx index 4b7f55b814..f8828fb244 100644 --- a/docs/client-api/commands/documents/content/_get-python.mdx +++ b/docs/client-api/commands/documents/content/_get-python.mdx @@ -8,10 +8,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetDocumentsCommand` to retrieve documents from the database. * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents-by-id-prefix) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get paged documents](#get-paged-documents) + - [Get documents by ID prefix](#get-documents-by-id-prefix) ## Get single document diff --git a/docs/client-api/commands/documents/content/_put-csharp.mdx b/docs/client-api/commands/documents/content/_put-csharp.mdx index 48c6caf464..ee58b22224 100644 --- a/docs/client-api/commands/documents/content/_put-csharp.mdx +++ b/docs/client-api/commands/documents/content/_put-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/put.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/documents/content/_put-nodejs.mdx b/docs/client-api/commands/documents/content/_put-nodejs.mdx index 74edf1c2de..15695f8902 100644 --- a/docs/client-api/commands/documents/content/_put-nodejs.mdx +++ b/docs/client-api/commands/documents/content/_put-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/put.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/commands/documents/content/_put-php.mdx b/docs/client-api/commands/documents/content/_put-php.mdx index f7974c4eca..0d75d87db7 100644 --- a/docs/client-api/commands/documents/content/_put-php.mdx +++ b/docs/client-api/commands/documents/content/_put-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/put.mdx#example) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/docs/client-api/commands/documents/content/_put-python.mdx b/docs/client-api/commands/documents/content/_put-python.mdx index 64cf90a984..3935dd8f61 100644 --- a/docs/client-api/commands/documents/content/_put-python.mdx +++ b/docs/client-api/commands/documents/content/_put-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/put.mdx#example) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/docs/client-api/configuration/content/_conventions-csharp.mdx b/docs/client-api/configuration/content/_conventions-csharp.mdx index f10c3fee19..4b6b5c5ff5 100644 --- a/docs/client-api/configuration/content/_conventions-csharp.mdx +++ b/docs/client-api/configuration/content/_conventions-csharp.mdx @@ -8,59 +8,59 @@ import CodeBlock from '@theme/CodeBlock'; * **Conventions** in RavenDB are customizable settings that users can configure to tailor client behaviors according to their preferences. * In this article: - * [How to set conventions](../../../client-api/configuration/conventions.mdx#how-to-set-conventions) + * [How to set conventions](#how-to-set-conventions) * [Conventions:](../../../client-api/configuration/conventions.mdx#conventions:) - [AddIdFieldToDynamicObjects](../../../client-api/configuration/conventions.mdx#addidfieldtodynamicobjects) - [AggressiveCache.Duration](../../../client-api/configuration/conventions.mdx#aggressivecacheduration) - [AggressiveCache.Mode](../../../client-api/configuration/conventions.mdx#aggressivecachemode) - [AsyncDocumentIdGenerator](../../../client-api/configuration/conventions.mdx#asyncdocumentidgenerator) - [CreateHttpClient](../../../client-api/configuration/conventions.mdx#createhttpclient) - [DisableAtomicDocumentWritesInClusterWideTransaction](../../../client-api/configuration/conventions.mdx#disableatomicdocumentwritesinclusterwidetransaction) - [DisableTcpCompression](../../../client-api/configuration/conventions.mdx#disabletcpcompression) - [DisableTopologyCache](../../../client-api/configuration/conventions.mdx#disabletopologycache) - [DisableTopologyUpdates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) - [DisposeCertificate](../../../client-api/configuration/conventions.mdx#disposecertificate) - [FindClrType](../../../client-api/configuration/conventions.mdx#findclrtype) - [FindClrTypeName](../../../client-api/configuration/conventions.mdx#findclrtypename) - [FindClrTypeNameForDynamic](../../../client-api/configuration/conventions.mdx#findclrtypenamefordynamic) - [FindCollectionName](../../../client-api/configuration/conventions.mdx#findcollectionname) - [FindCollectionNameForDynamic](../../../client-api/configuration/conventions.mdx#findcollectionnamefordynamic) - [FindIdentityProperty](../../../client-api/configuration/conventions.mdx#findidentityproperty) - [FindIdentityPropertyNameFromCollectionName](../../../client-api/configuration/conventions.mdx#findidentitypropertynamefromcollectionname) - [FindProjectedPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findprojectedpropertynameforindex) - [FindPropertyNameForDynamicIndex](../../../client-api/configuration/conventions.mdx#findpropertynamefordynamicindex) - [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) - [FirstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) - [GlobalHttpClientTimeout](../../../client-api/configuration/conventions.mdx#globalhttpclienttimeout) - [HttpClientType](../../../client-api/configuration/conventions.mdx#httpclienttype) - [HttpPooledConnectionIdleTimeout](../../../client-api/configuration/conventions.mdx#httppooledconnectionidletimeout) - [HttpPooledConnectionLifetime](../../../client-api/configuration/conventions.mdx#httppooledconnectionlifetime) - [HttpVersion](../../../client-api/configuration/conventions.mdx#httpversion) - [IdentityPartsSeparator](../../../client-api/configuration/conventions.mdx#identitypartsseparator) - [LoadBalanceBehavior](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [LoadBalancerContextSeed](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [LoadBalancerPerSessionContextSelector](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [MaxHttpCacheSize](../../../client-api/configuration/conventions.mdx#maxhttpcachesize) - [MaxNumberOfRequestsPerSession](../../../client-api/configuration/conventions.mdx#maxnumberofrequestspersession) - [Modify serialization of property name](../../../client-api/configuration/conventions.mdx#modify-serialization-of-property-name) - [OperationStatusFetchMode](../../../client-api/configuration/conventions.mdx#operationstatusfetchmode) - [OptimisticConcurrencyMode](../../../client-api/configuration/conventions.mdx#optimisticconcurrencymode) - [PreserveDocumentPropertiesNotFoundOnModel](../../../client-api/configuration/conventions.mdx#preservedocumentpropertiesnotfoundonmodel) - [ReadBalanceBehavior](../../../client-api/configuration/conventions.mdx#readbalancebehavior) - [RequestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout) - [ResolveTypeFromClrTypeName](../../../client-api/configuration/conventions.mdx#resolvetypefromclrtypename) - [SaveEnumsAsIntegers](../../../client-api/configuration/conventions.mdx#saveenumsasintegers) - [SecondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) - [SendApplicationIdentifier](../../../client-api/configuration/conventions.mdx#sendapplicationidentifier) - [ShouldIgnoreEntityChanges](../../../client-api/configuration/conventions.mdx#shouldignoreentitychanges) - [TopologyCacheLocation](../../../client-api/configuration/conventions.mdx#topologycachelocation) - [TransformTypeCollectionNameToDocumentIdPrefix](../../../client-api/configuration/conventions.mdx#transformtypecollectionnametodocumentidprefix) - [UseHttpCompression](../../../client-api/configuration/conventions.mdx#usehttpcompression) - [UseHttpDecompression](../../../client-api/configuration/conventions.mdx#usehttpdecompression) - [HttpCompressionAlgorithm](../../../client-api/configuration/conventions.mdx#httpcompressionalgorithm) - [WaitForIndexesAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforindexesaftersavechangestimeout) - [WaitForNonStaleResultsTimeout](../../../client-api/configuration/conventions.mdx#waitfornonstaleresultstimeout) - [WaitForReplicationAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforreplicationaftersavechangestimeout) + [AddIdFieldToDynamicObjects](#addidfieldtodynamicobjects) + [AggressiveCache.Duration](#aggressivecacheduration) + [AggressiveCache.Mode](#aggressivecachemode) + [AsyncDocumentIdGenerator](#asyncdocumentidgenerator) + [CreateHttpClient](#createhttpclient) + [DisableAtomicDocumentWritesInClusterWideTransaction](#disableatomicdocumentwritesinclusterwidetransaction) + [DisableTcpCompression](#disabletcpcompression) + [DisableTopologyCache](#disabletopologycache) + [DisableTopologyUpdates](#disabletopologyupdates) + [DisposeCertificate](#disposecertificate) + [FindClrType](#findclrtype) + [FindClrTypeName](#findclrtypename) + [FindClrTypeNameForDynamic](#findclrtypenamefordynamic) + [FindCollectionName](#findcollectionname) + [FindCollectionNameForDynamic](#findcollectionnamefordynamic) + [FindIdentityProperty](#findidentityproperty) + [FindIdentityPropertyNameFromCollectionName](#findidentitypropertynamefromcollectionname) + [FindProjectedPropertyNameForIndex](#findprojectedpropertynameforindex) + [FindPropertyNameForDynamicIndex](#findpropertynamefordynamicindex) + [FindPropertyNameForIndex](#findpropertynameforindex) + [FirstBroadcastAttemptTimeout](#firstbroadcastattempttimeout) + [GlobalHttpClientTimeout](#globalhttpclienttimeout) + [HttpClientType](#httpclienttype) + [HttpPooledConnectionIdleTimeout](#httppooledconnectionidletimeout) + [HttpPooledConnectionLifetime](#httppooledconnectionlifetime) + [HttpVersion](#httpversion) + [IdentityPartsSeparator](#identitypartsseparator) + [LoadBalanceBehavior](#loadbalancebehavior) + [LoadBalancerContextSeed](#loadbalancebehavior) + [LoadBalancerPerSessionContextSelector](#loadbalancebehavior) + [MaxHttpCacheSize](#maxhttpcachesize) + [MaxNumberOfRequestsPerSession](#maxnumberofrequestspersession) + [Modify serialization of property name](#modify-serialization-of-property-name) + [OperationStatusFetchMode](#operationstatusfetchmode) + [OptimisticConcurrencyMode](#optimisticconcurrencymode) + [PreserveDocumentPropertiesNotFoundOnModel](#preservedocumentpropertiesnotfoundonmodel) + [ReadBalanceBehavior](#readbalancebehavior) + [RequestTimeout](#requesttimeout) + [ResolveTypeFromClrTypeName](#resolvetypefromclrtypename) + [SaveEnumsAsIntegers](#saveenumsasintegers) + [SecondBroadcastAttemptTimeout](#secondbroadcastattempttimeout) + [SendApplicationIdentifier](#sendapplicationidentifier) + [ShouldIgnoreEntityChanges](#shouldignoreentitychanges) + [TopologyCacheLocation](#topologycachelocation) + [TransformTypeCollectionNameToDocumentIdPrefix](#transformtypecollectionnametodocumentidprefix) + [UseHttpCompression](#usehttpcompression) + [UseHttpDecompression](#usehttpdecompression) + [HttpCompressionAlgorithm](#httpcompressionalgorithm) + [WaitForIndexesAfterSaveChangesTimeout](#waitforindexesaftersavechangestimeout) + [WaitForNonStaleResultsTimeout](#waitfornonstaleresultstimeout) + [WaitForReplicationAfterSaveChangesTimeout](#waitforreplicationaftersavechangestimeout) ## How to set conventions @@ -193,7 +193,7 @@ public Func> AsyncDocumentIdGenerator \{ get; set; * For example, implementing your own HTTP client can be useful when you'd like your clients to provide the server with tracing info. * If you override the default `CreateHttpClient` convention we advise that you also set the HTTP client type - correctly using the [HttpClientType](../../../client-api/configuration/conventions.mdx#httpclienttype) convention. + correctly using the [HttpClientType](#httpclienttype) convention. @@ -262,7 +262,7 @@ public bool DisableTcpCompression \{ get; set; \} In such a case: * The client will not load the topology from the cache upon failing to connect to a server. - * Even if the client is configured to [receive topology updates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) from the server, + * Even if the client is configured to [receive topology updates](#disabletopologyupdates) from the server, no topology files will be saved on disk, thus preventing the accumulation of these files. * DEFAULT: `false` @@ -490,7 +490,7 @@ public Func FindIdentityPropertyNameFromCollectionName \{ get; s * DEFAULT: `null` When `FindProjectedPropertyNameForIndex` is set to `null` (or returns `null`), - the [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) convention is used instead. + the [FindPropertyNameForIndex](#findpropertynameforindex) convention is used instead. **Example**: Consider the following index, which indexes the nested `School.Id` property from _Student_ documents: @@ -539,7 +539,7 @@ public class School When querying the index and projecting fields from the matching _Student_ documents, if the `FindProjectedPropertyNameForIndex` convention is Not set, -the client will use the [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) convention instead when constructing the RQL sent to the server. +the client will use the [FindPropertyNameForIndex](#findpropertynameforindex) convention instead when constructing the RQL sent to the server. This results in the following RQL query: (Note that while the high-level query uses `.Select(student => student.School.Id)`, @@ -686,7 +686,7 @@ public Func FindPropertyNameForIndex \{ ge * In the first attempt, the request executor will send a single request to the selected node. Learn about the "selected node" in: [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node). -* A [second attempt](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) will be held upon failure. +* A [second attempt](#secondbroadcastattempttimeout) will be held upon failure. * DEFAULT: `5 seconds` @@ -715,9 +715,9 @@ public TimeSpan FirstBroadcastAttemptTimeout \{ get; set; \} This setting does not control how long an idle TCP connection remains open; it limits how long the client waits for an HTTP request to complete. * This value also serves as the maximum allowed timeout for request-executor timeouts, - such as [RequestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout), - [FirstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout), - [SecondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout), and per-request command timeouts. + such as [RequestTimeout](#requesttimeout), + [FirstBroadcastAttemptTimeout](#firstbroadcastattempttimeout), + [SecondBroadcastAttemptTimeout](#secondbroadcastattempttimeout), and per-request command timeouts. Setting any of these to a value greater than `GlobalHttpClientTimeout` will throw an exception. * In client code, set `GlobalHttpClientTimeout` to be greater than or equal to the longest request timeout you plan to use. @@ -750,7 +750,7 @@ public TimeSpan GlobalHttpClientTimeout \{ get; set; \} * RavenDB uses the HTTP type internally to manage its cache. -* If you override the [CreateHttpClient](../../../client-api/configuration/conventions.mdx#createhttpclient) convention to use a non-default HTTP client, +* If you override the [CreateHttpClient](#createhttpclient) convention to use a non-default HTTP client, we advise that you also set `HttpClientType` so it returns the client type you are actually using. @@ -1130,7 +1130,7 @@ public bool SaveEnumsAsIntegers \{ get; set; \} #### SecondBroadcastAttemptTimeout * Use the `SecondBroadcastAttemptTimeout` convention to set the timeout for the second broadcast attempt. -* Upon failure of the [first attempt](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. +* Upon failure of the [first attempt](#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. * DEFAULT: `30 seconds` @@ -1264,7 +1264,7 @@ public bool UseHttpDecompression \{ get; set; \} #### HttpCompressionAlgorithm * Use this convention to set the HTTP compression algorithm - (see [UseHttpDecompression](../../../client-api/configuration/conventions.mdx#usehttpcompression) above). + (see [UseHttpDecompression](#usehttpcompression) above). * DEFAULT: `Zstd` diff --git a/docs/client-api/configuration/content/_conventions-nodejs.mdx b/docs/client-api/configuration/content/_conventions-nodejs.mdx index 9568ff2e09..93eb3ac9ad 100644 --- a/docs/client-api/configuration/content/_conventions-nodejs.mdx +++ b/docs/client-api/configuration/content/_conventions-nodejs.mdx @@ -8,37 +8,37 @@ import CodeBlock from '@theme/CodeBlock'; * **Conventions** in RavenDB are customizable settings that users can configure to tailor client behaviors according to their preferences. * In this article: - * [How to set conventions](../../../client-api/configuration/conventions.mdx#how-to-set-conventions) + * [How to set conventions](#how-to-set-conventions) * [Conventions:](../../../client-api/configuration/conventions.mdx#conventions:) - [customFetch](../../../client-api/configuration/conventions.mdx#customfetch) - [disableAtomicDocumentWritesInClusterWideTransaction](../../../client-api/configuration/conventions.mdx#disableatomicdocumentwritesinclusterwidetransaction) - [disableTopologyUpdates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) - [findCollectionName](../../../client-api/configuration/conventions.mdx#findcollectionname) - [findJsType](../../../client-api/configuration/conventions.mdx#_findjstype) - [findJsTypeName](../../../client-api/configuration/conventions.mdx#_findjstypename) - [firstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) - [identityPartsSeparator](../../../client-api/configuration/conventions.mdx#identitypartsseparator) - [loadBalanceBehavior](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [loadBalancerContextSeed](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [loadBalancerPerSessionContextSelector](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [maxHttpCacheSize](../../../client-api/configuration/conventions.mdx#maxhttpcachesize) - [maxNumberOfRequestsPerSession](../../../client-api/configuration/conventions.mdx#maxnumberofrequestspersession) - [readBalanceBehavior](../../../client-api/configuration/conventions.mdx#readbalancebehavior) - [requestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout) - [secondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) - [sendApplicationIdentifier](../../../client-api/configuration/conventions.mdx#sendapplicationidentifier) - [shouldIgnoreEntityChanges](../../../client-api/configuration/conventions.mdx#shouldignoreentitychanges) - [storeDatesInUtc](../../../client-api/configuration/conventions.mdx#storedatesinutc) - [storeDatesWithTimezoneInfo](../../../client-api/configuration/conventions.mdx#storedateswithtimezoneinfo) - [syncJsonParseLimit](../../../client-api/configuration/conventions.mdx#syncjsonparselimit) - [throwIfQueryPageSizeIsNotSet](../../../client-api/configuration/conventions.mdx#throwifquerypagesizeisnotset) - [transformClassCollectionNameToDocumentIdPrefix](../../../client-api/configuration/conventions.mdx#transformclasscollectionnametodocumentidprefix) - [useCompression](../../../client-api/configuration/conventions.mdx#usecompression) - [useJsonlStreaming](../../../client-api/configuration/conventions.mdx#usejsonlstreaming) - [useOptimisticConcurrency](../../../client-api/configuration/conventions.mdx#useoptimisticconcurrency) - [waitForIndexesAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforindexesaftersavechangestimeout) - [waitForNonStaleResultsTimeout](../../../client-api/configuration/conventions.mdx#waitfornonstaleresultstimeout) - [waitForReplicationAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforreplicationaftersavechangestimeout) + [customFetch](#customfetch) + [disableAtomicDocumentWritesInClusterWideTransaction](#disableatomicdocumentwritesinclusterwidetransaction) + [disableTopologyUpdates](#disabletopologyupdates) + [findCollectionName](#findcollectionname) + [findJsType](#_findjstype) + [findJsTypeName](#_findjstypename) + [firstBroadcastAttemptTimeout](#firstbroadcastattempttimeout) + [identityPartsSeparator](#identitypartsseparator) + [loadBalanceBehavior](#loadbalancebehavior) + [loadBalancerContextSeed](#loadbalancebehavior) + [loadBalancerPerSessionContextSelector](#loadbalancebehavior) + [maxHttpCacheSize](#maxhttpcachesize) + [maxNumberOfRequestsPerSession](#maxnumberofrequestspersession) + [readBalanceBehavior](#readbalancebehavior) + [requestTimeout](#requesttimeout) + [secondBroadcastAttemptTimeout](#secondbroadcastattempttimeout) + [sendApplicationIdentifier](#sendapplicationidentifier) + [shouldIgnoreEntityChanges](#shouldignoreentitychanges) + [storeDatesInUtc](#storedatesinutc) + [storeDatesWithTimezoneInfo](#storedateswithtimezoneinfo) + [syncJsonParseLimit](#syncjsonparselimit) + [throwIfQueryPageSizeIsNotSet](#throwifquerypagesizeisnotset) + [transformClassCollectionNameToDocumentIdPrefix](#transformclasscollectionnametodocumentidprefix) + [useCompression](#usecompression) + [useJsonlStreaming](#usejsonlstreaming) + [useOptimisticConcurrency](#useoptimisticconcurrency) + [waitForIndexesAfterSaveChangesTimeout](#waitforindexesaftersavechangestimeout) + [waitForNonStaleResultsTimeout](#waitfornonstaleresultstimeout) + [waitForReplicationAfterSaveChangesTimeout](#waitforreplicationaftersavechangestimeout) ## How to set conventions @@ -201,7 +201,7 @@ set findJsTypeName(value); * In the first attempt, the request executor will send a single request to the selected node. Learn about the "selected node" in: [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node). -* A [second attempt](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) will be held upon failure. +* A [second attempt](#secondbroadcastattempttimeout) will be held upon failure. * DEFAULT: `5 seconds` @@ -328,7 +328,7 @@ set requestTimeout(value); #### secondBroadcastAttemptTimeout * Use the `secondBroadcastAttemptTimeout` convention to set the timeout for the second broadcast attempt. -* Upon failure of the [first attempt](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. +* Upon failure of the [first attempt](#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. * DEFAULT: `30 seconds` diff --git a/docs/client-api/configuration/content/_deserialization-csharp.mdx b/docs/client-api/configuration/content/_deserialization-csharp.mdx index b2d4586e79..4f5529474d 100644 --- a/docs/client-api/configuration/content/_deserialization-csharp.mdx +++ b/docs/client-api/configuration/content/_deserialization-csharp.mdx @@ -10,11 +10,11 @@ Use the methods described in this page to customize the [conventions](../../../c by which entities are deserialized as they are received by the client. * In this page: - * [CustomizeJsonDeserializer](../../../client-api/configuration/deserialization.mdx#customizejsondeserializer) - * [DeserializeEntityFromBlittable](../../../client-api/configuration/deserialization.mdx#deserializeentityfromblittable) - * [PreserveDocumentPropertiesNotFoundOnModel](../../../client-api/configuration/deserialization.mdx#preservedocumentpropertiesnotfoundonmodel) - * [DefaultRavenSerializationBinder](../../../client-api/configuration/deserialization.mdx#defaultravenserializationbinder) - * [Number Deserialization](../../../client-api/configuration/deserialization.mdx#number-deserialization) + * [CustomizeJsonDeserializer](#customizejsondeserializer) + * [DeserializeEntityFromBlittable](#deserializeentityfromblittable) + * [PreserveDocumentPropertiesNotFoundOnModel](#preservedocumentpropertiesnotfoundonmodel) + * [DefaultRavenSerializationBinder](#defaultravenserializationbinder) + * [Number Deserialization](#number-deserialization) diff --git a/docs/client-api/configuration/content/_serialization-csharp.mdx b/docs/client-api/configuration/content/_serialization-csharp.mdx index 403f79e063..65b415db83 100644 --- a/docs/client-api/configuration/content/_serialization-csharp.mdx +++ b/docs/client-api/configuration/content/_serialization-csharp.mdx @@ -10,11 +10,11 @@ Use the methods described in this page to customize the [conventions](../../../c by which entities are serialized as they are sent by the client to the server. * In this page: - * [Ignoring a property](../../../client-api/configuration/serialization.mdx#ignoring-a-property) - * [CustomizeJsonSerializer](../../../client-api/configuration/serialization.mdx#customizejsonserializer) - * [JsonContractResolver](../../../client-api/configuration/serialization.mdx#jsoncontractresolver) - * [BulkInsert.TrySerializeEntityToJsonStream](../../../client-api/configuration/serialization.mdx#bulkinserttryserializeentitytojsonstream) - * [IgnoreByRefMembers and IgnoreUnsafeMembers](../../../client-api/configuration/serialization.mdx#ignorebyrefmembers-and-ignoreunsafemembers) + * [Ignoring a property](#ignoring-a-property) + * [CustomizeJsonSerializer](#customizejsonserializer) + * [JsonContractResolver](#jsoncontractresolver) + * [BulkInsert.TrySerializeEntityToJsonStream](#bulkinserttryserializeentitytojsonstream) + * [IgnoreByRefMembers and IgnoreUnsafeMembers](#ignorebyrefmembers-and-ignoreunsafemembers) diff --git a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx index 437b1373ff..47a72c7b0e 100644 --- a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx +++ b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx index 77af4c4b60..4da59fc3f5 100644 --- a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx +++ b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `loadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'loadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'loadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx index e6635b4498..fc82d71424 100644 --- a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx +++ b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx index c1220e9dae..d3057df904 100644 --- a/docs/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx +++ b/docs/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx index d740865fb1..046f18627b 100644 --- a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx +++ b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx index b7d516cc38..8f4e2f81eb 100644 --- a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx +++ b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [readBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize readBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set readBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [readBalanceBehavior options](#readbalancebehavior-options) + * [Initialize readBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set readBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `readBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'readBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'readBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx index 67dfe4cc31..886e88a4a6 100644 --- a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx +++ b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx index 51148c9204..c35be01585 100644 --- a/docs/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx +++ b/docs/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/docs/client-api/configuration/load-balance/overview.mdx b/docs/client-api/configuration/load-balance/overview.mdx index 9053bfb06d..047826ba6c 100644 --- a/docs/client-api/configuration/load-balance/overview.mdx +++ b/docs/client-api/configuration/load-balance/overview.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Each instance is a complete replica of the database. * The [database-group-topology](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---view) is the list of nodes that contain those database replicas. - The first node in this list is called the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node). + The first node in this list is called the [preferred node](#the-preferred-node). * The client is kept up-to-date with this topology list. __The client decides which node from this list to access__ when making requests to the RavenDB cluster. @@ -29,10 +29,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [ReadBalanceBehavior](../../../client-api/configuration/load-balance/read-balance-behavior.mdx) - load balancing `Read` requests only * [LoadBalanceBehavior](../../../client-api/configuration/load-balance/load-balance-behavior.mdx) - load balancing `Read & Write` requests * In this page: - * [Keeping the client topology up-to-date](../../../client-api/configuration/load-balance/overview.mdx#keeping-the-client-topology-up-to-date) - * [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node) - * [The preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) - * [Single-node session usage](../../../client-api/configuration/load-balance/overview.mdx#single-node-session-usage) + * [Keeping the client topology up-to-date](#keeping-the-client-topology-up-to-date) + * [Client logic for choosing a node](#client-logic-for-choosing-a-node) + * [The preferred node](#the-preferred-node) + * [Single-node session usage](#single-node-session-usage) ## Keeping the client topology up-to-date @@ -68,7 +68,7 @@ The client uses the following logic (from top to bottom) to determine which node `Read` requests: The client will select a node based on the [read balance options](../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options). `Write` requests: All _Write_ requests will be directed to the preferred node. * Else, use the __preferred node__: - Use the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) for both `Read & Write` requests. + Use the [preferred node](#the-preferred-node) for both `Read & Write` requests. diff --git a/docs/client-api/content/_creating-document-store-csharp.mdx b/docs/client-api/content/_creating-document-store-csharp.mdx index 6c3bfd1fee..691b7d18b2 100644 --- a/docs/client-api/content/_creating-document-store-csharp.mdx +++ b/docs/client-api/content/_creating-document-store-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * **Creating a Document Store** is the _first step_ that a RavenDB client application needs to make when working with RavenDB. * We recommend that your Document Store implement the [Singleton Pattern](https://csharpindepth.com/articles/Singleton) as demonstrated in -the example code [below](../../client-api/creating-document-store.mdx#creating-a-document-store---example). +the example code [below](#creating-a-document-store---example). Creating more than one Document Store may be resource intensive, and one instance is sufficient for most use cases. * In this page: - * [Creating a Document Store - Configuration](../../client-api/creating-document-store.mdx#creating-a-document-store---configuration) - * [Certificate Disposal](../../client-api/creating-document-store.mdx#certificate-disposal) - * [Creating a Document Store - Example](../../client-api/creating-document-store.mdx#creating-a-document-store---example) + * [Creating a Document Store - Configuration](#creating-a-document-store---configuration) + * [Certificate Disposal](#certificate-disposal) + * [Creating a Document Store - Example](#creating-a-document-store---example) ## Creating a Document Store - Configuration diff --git a/docs/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx b/docs/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx index 098d83c96b..95b4621044 100644 --- a/docs/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx +++ b/docs/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx @@ -17,7 +17,7 @@ The Client Certificate is generated by the admin from the [Studio](../../server/ certificate. * Pass your Client Certificate to the Document Store before initialization, as shown in the example code -[below](../../client-api/setting-up-authentication-and-authorization.mdx#example---initializing-document-store-with-a-client-certificate). +[below](#example---initializing-document-store-with-a-client-certificate). The server will use this certificate to authenticate the client when connection is established. diff --git a/docs/client-api/content/_setting-up-default-database-csharp.mdx b/docs/client-api/content/_setting-up-default-database-csharp.mdx index 38f3417c74..aba613c255 100644 --- a/docs/client-api/content/_setting-up-default-database-csharp.mdx +++ b/docs/client-api/content/_setting-up-default-database-csharp.mdx @@ -17,8 +17,8 @@ The default database value itself will Not change. explicitly passed. * In this page: - * [Example - Without a Default Database](../../client-api/setting-up-default-database.mdx#example---without-a-default-database) - * [Example - With a Default Database](../../client-api/setting-up-default-database.mdx#example---with-a-default-database) + * [Example - Without a Default Database](#example---without-a-default-database) + * [Example - With a Default Database](#example---with-a-default-database) ## Example - Without a Default Database diff --git a/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx b/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx index c0683651da..1dc373dca1 100644 --- a/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx +++ b/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers data subscriptions maintenance operations. * In this page: - * [DocumentSubscriptions class](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#documentsubscriptions-class) - * [Delete subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#delete-subscription) - * [Disabling subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disable-subscription) - * [Enable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#enable-subscription) - * [Update subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#update-subscription) - * [Drop Connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#drop-connection) - * [Get subscription state](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscription-state) + * [DocumentSubscriptions class](#documentsubscriptions-class) + * [Delete subscription](#delete-subscription) + * [Disabling subscription](#disable-subscription) + * [Enable subscription](#enable-subscription) + * [Update subscription](#update-subscription) + * [Drop Connection](#drop-connection) + * [Get subscription state](#get-subscription-state) ## DocumentSubscriptions class diff --git a/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx b/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx index 994b10206c..e7cf868a4f 100644 --- a/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx +++ b/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * This page covers data subscriptions maintenance operations: - * [Deleting subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#deleting-subscription) - * [Dropping connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#dropping-connection) - * [Disabling subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disabling-subscription) - * [Updating subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#updating-subscription) - * [Getting subscription status](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#getting-subscription-status) + * [Deleting subscription](#deleting-subscription) + * [Dropping connection](#dropping-connection) + * [Disabling subscription](#disabling-subscription) + * [Updating subscription](#updating-subscription) + * [Getting subscription status](#getting-subscription-status) ## Deleting subscription diff --git a/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx b/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx index 83379c7a73..2238aee053 100644 --- a/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx +++ b/docs/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers data subscriptions maintenance operations. * In this page: - * [Delete subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#delete-subscription) - * [Disable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disable-subscription) - * [Enable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#enable-subscription) - * [Update subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#update-subscription) - * [Drop connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#drop-connection) - * [Get subscriptions](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscriptions) - * [Get subscription state](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscription-state) - * [DocumentSubscriptions class](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#documentsubscriptions-class) + * [Delete subscription](#delete-subscription) + * [Disable subscription](#disable-subscription) + * [Enable subscription](#enable-subscription) + * [Update subscription](#update-subscription) + * [Drop connection](#drop-connection) + * [Get subscriptions](#get-subscriptions) + * [Get subscription state](#get-subscription-state) + * [DocumentSubscriptions class](#documentsubscriptions-class) ## Delete subscription diff --git a/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx b/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx index 25f8ad1e10..69b500b71e 100644 --- a/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx +++ b/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx @@ -15,11 +15,11 @@ import CodeBlock from '@theme/CodeBlock'; See how to create and consume it in the examples below. * In this page: - * [Regular subscription vs Revisions subscription](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#regular-subscription-vs-revisions-subscription) - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple creation and consumption](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption) - * [Filtering revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#filtering-revisions) - * [Projecting fields from revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions) + * [Regular subscription vs Revisions subscription](#regular-subscription-vs-revisions-subscription) + * [Revisions processing order](#revisions-processing-order) + * [Simple creation and consumption](#simple-creation-and-consumption) + * [Filtering revisions](#filtering-revisions) + * [Projecting fields from revisions](#projecting-fields-from-revisions) ## Regular subscription vs Revisions subscription @@ -46,7 +46,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Query access scope**: For each revision, the subscription query running on the server has access to both the currently processed revision and its previous revision. * **Data sent to client**: - By default, unless the subscription query is [projecting specific fields](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions), + By default, unless the subscription query is [projecting specific fields](#projecting-fields-from-revisions), each item in the batch sent to the client contains both the processed revision (`Result.Current`) and its preceding revision (`Result.Previous`). If the document has just been created, the previous revision will be `null`. @@ -285,7 +285,7 @@ Here we define a revisions subscription that will filter the revisions and send Since the revision fields are projected into the `OrderRevenues` class in the subscription definition, each item received in the batch has the format of this projected class instead of the default `Result.Previous` and `Result.Current` fields, -as was demonstrated in the [simple example](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption). +as was demonstrated in the [simple example](#simple-creation-and-consumption). diff --git a/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx b/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx index f0278bbcda..25d891e229 100644 --- a/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx +++ b/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; Both revisions are accessible for filtering and projection. * In this page: - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple declaration and usage](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-declaration-and-usage) - * [Revisions processing and projection](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-and-projection) + * [Revisions processing order](#revisions-processing-order) + * [Simple declaration and usage](#simple-declaration-and-usage) + * [Revisions processing and projection](#revisions-processing-and-projection) ## Revisions processing order diff --git a/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx b/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx index ccb9d4e4bb..f703754297 100644 --- a/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx +++ b/docs/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx @@ -15,11 +15,11 @@ import CodeBlock from '@theme/CodeBlock'; See how to create and consume it in the examples below. * In this page: - * [Regular subscription vs Revisions subscription](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#regular-subscription-vs-revisions-subscription) - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple creation and consumption](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption) - * [Filtering revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#filtering-revisions) - * [Projecting fields from revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions) + * [Regular subscription vs Revisions subscription](#regular-subscription-vs-revisions-subscription) + * [Revisions processing order](#revisions-processing-order) + * [Simple creation and consumption](#simple-creation-and-consumption) + * [Filtering revisions](#filtering-revisions) + * [Projecting fields from revisions](#projecting-fields-from-revisions) ## Regular subscription vs Revisions subscription @@ -248,7 +248,7 @@ Here we define a revisions subscription that will filter the revisions and send Since the revision fields are projected into the `OrderRevenues` class in the subscription definition, each item received in the batch has the format of this projected class instead of the default `result.previous` and `result.current` fields, -as was demonstrated in the [simple example](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption). +as was demonstrated in the [simple example](#simple-creation-and-consumption). diff --git a/docs/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx b/docs/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx index d172cdbad9..de8d8a01d3 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [SubscriptionBatch<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht) - * [SubscriptionBatch<T>.Item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) - * [SubscriptionWorker<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert) + * [Create the subscription worker](#create-the-subscription-worker) + * [SubscriptionWorkerOptions](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [SubscriptionBatch<T>](#subscriptionbatcht) + * [SubscriptionBatch<T>.Item](#subscriptionbatchtitem) + * [SubscriptionWorker<T>](#subscriptionworkert) ## Create the subscription worker @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; A subscription worker can be created using the following `GetSubscriptionWorker` methods available through the `Subscriptions` property of the `DocumentStore`. Note: Simply creating the worker is insufficient; -after creating the worker, you need to [run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) to initiate document processing. +after creating the worker, you need to [run the subscription worker](#run-the-subscription-worker) to initiate document processing. @@ -112,8 +112,8 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../. ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. -To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert). +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +To start processing, you need to call the `Run` method of the [SubscriptionWorker](#subscriptionworkert). The `Run` function takes a delegate, which is your client-side code responsible for processing the received document batches. @@ -144,7 +144,7 @@ Task Run(Func, Task> processDocuments, | Member | Type | Description | |--------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) below. | +| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](#subscriptionbatchtitem) below. | | **NumberOfItemsInBatch** | `int` | Number of items in the batch. | | Method Signature | Return value | Description | @@ -215,7 +215,7 @@ Using it outside this scope may cause unexpected behavior. | **DisposeAsync()** | `Task` | Async version of `Dispose()`. | | **Dispose(bool waitForSubscriptionTask)** | `void` | Aborts the subscription worker, but allows deciding whether to wait for the `Run` function task or not. | | **DisposeAsync(bool waitForSubscriptionTask)** | `Task` | Async version of `DisposeAsync(bool waitForSubscriptionTask)`. | -| **Run (multiple overloads)** | `Task` | Call `Run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| **Run (multiple overloads)** | `Task` | Call `Run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | diff --git a/docs/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx b/docs/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx index 57f4671bf4..a92c10a679 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [SubscriptionBatch<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht) - * [SubscriptionWorker<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert) + * [Create the subscription worker](#create-the-subscription-worker) + * [SubscriptionWorkerOptions](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [SubscriptionBatch<T>](#subscriptionbatcht) + * [SubscriptionWorker<T>](#subscriptionworkert) ## Create the subscription worker @@ -73,8 +73,8 @@ All other parameters are optional and will default to their respective default v ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. -To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert). +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +To start processing, you need to call the `run` method of the [SubscriptionWorker](#subscriptionworkert). The `run` function takes a delegate, which is your client-side code responsible for processing the received document batches. @@ -147,7 +147,7 @@ if T is `ObjectNode`, no deserialization will take place | Method Signature | Return Type | Description | |------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **close()** | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | -| **run (multiple overloads)** | `CompletableFuture` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| **run (multiple overloads)** | `CompletableFuture` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | diff --git a/docs/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx b/docs/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx index 31a3deb17d..0e4ca997ef 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [Subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker-options) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [Subscription batch](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch) - * [Subscription batch item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch-item) - * [Subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker) + * [Create the subscription worker](#create-the-subscription-worker) + * [Subscription worker options](#subscription-worker-options) + * [Run the subscription worker](#run-the-subscription-worker) + * [Subscription batch](#subscription-batch) + * [Subscription batch item](#subscription-batch-item) + * [Subscription worker](#subscription-worker) ## Create the subscription worker @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; A subscription worker can be created using the following `getSubscriptionWorker` methods available through the `subscriptions` property of the `documentStore`. Note: Simply creating the worker is insufficient; -after creating the worker, you need to [run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) to initiate document processing. +after creating the worker, you need to [run the subscription worker](#run-the-subscription-worker) to initiate document processing. @@ -36,11 +36,11 @@ await documentStore.subscriptions.getSubscriptionWorker(options, database); |----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **subscriptionName** | `string` | The name of the subscription to which the worker will connect. | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in DocumentStore will be used. | -| **options** | `object` | [Subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker-options) object that affect how the worker interacts with the subscription. These options do not alter the definition of the subscription itself. | +| **options** | `object` | [Subscription worker options](#subscription-worker-options) object that affect how the worker interacts with the subscription. These options do not alter the definition of the subscription itself. | | Return value | | |----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `SubscriptionWorker` | The [subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker) that has been created.
The worker will start processing documents once you define the worker's `on` method,
which listens to the `batch` event. | +| `SubscriptionWorker` | The [subscription worker](#subscription-worker) that has been created.
The worker will start processing documents once you define the worker's `on` method,
which listens to the `batch` event. | @@ -82,7 +82,7 @@ All other parameters are optional and will default to their respective default v ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. To initiate processing, you need to define an event handler and attach it to the worker's `batch` event listener. This handler contains your client-side code responsible for processing the document batches received from the server. @@ -113,7 +113,7 @@ The subscription batch class contains the following public properties & methods: | Property | Type | Description | |-------------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **items** | `Item[]` | List of items in the batch.
See [subscription batch item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch-item). | +| **items** | `Item[]` | List of items in the batch.
See [subscription batch item](#subscription-batch-item). | | Method | Return type | Description | |-------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx b/docs/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx index 9bca678b40..50ee42f66a 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [`SubscriptionWorkerOptions`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [`SubscriptionBatch[_T]`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch_t) - * [`SubscriptionWorker[_T]`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker_t) + * [Create the subscription worker](#create-the-subscription-worker) + * [`SubscriptionWorkerOptions`](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [`SubscriptionBatch[_T]`](#subscriptionbatch_t) + * [`SubscriptionWorker[_T]`](#subscriptionworker_t) ## Create the subscription worker @@ -82,7 +82,7 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../. ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. To start processing, you need to call the `run` function of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker[_t]). The `run` function receives the client-side code as a function that will process the received document batches. @@ -180,7 +180,7 @@ is not supported. | Method | Return Type | Description | |-------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `close(bool wait_for_subscription_task = True)` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | -| `run` | `Future[None]` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| `run` | `Future[None]` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | ### Events: | Event | Type\Return type | Description | diff --git a/docs/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx b/docs/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx index 65e0901c3f..da087b81b8 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx @@ -6,15 +6,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Worker that processes a blittable object](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-a-blittable-object) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Subscription workers with failover on other nodes](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-workers-with-failover-on-other-nodes) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Worker that processes a blittable object](#worker-that-processes-a-blittable-object) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Subscription workers with failover on other nodes](#subscription-workers-with-failover-on-other-nodes) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/docs/client-api/data-subscriptions/consumption/content/_examples-java.mdx b/docs/client-api/data-subscriptions/consumption/content/_examples-java.mdx index 8466cf34ac..102d7ccae3 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_examples-java.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_examples-java.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * this page: - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Subscription that ends when no documents left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-left) - * [Worker that processes raw objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#sworker-that-processes-raw-objects) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Subscription that ends when no documents left](#subscription-that-ends-when-no-documents-left) + * [Worker that processes raw objects](#sworker-that-processes-raw-objects) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Worker with a specified batch size diff --git a/docs/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx b/docs/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx index e2c5222311..32482747b6 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/docs/client-api/data-subscriptions/consumption/content/_examples-python.mdx b/docs/client-api/data-subscriptions/consumption/content/_examples-python.mdx index f2a6937706..c2ce17e968 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_examples-python.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_examples-python.mdx @@ -6,14 +6,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Subscription workers with failover on other nodes](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-workers-with-failover-on-other-nodes) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Subscription workers with failover on other nodes](#subscription-workers-with-failover-on-other-nodes) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx index 7379c89553..d164ce8d55 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions). * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## SubscriptionWorker lifecycle @@ -55,7 +55,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -179,15 +179,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [concurrent](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [concurrent](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx index ccc4a0db5e..c00a2e325c 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx @@ -10,9 +10,9 @@ A `SubscriptionWorker` object manages the documents processing and the communica We've introduced several ways to create and configure a SubscriptionWorker, starting from just giving a subscription name, and ending with a detailed configuration object - `SubscriptionWorkerOptions`. * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) ## SubscriptionWorker lifecycle @@ -52,7 +52,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). diff --git a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx index 83eafbe3aa..621e624247 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see [subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions). * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## SubscriptionWorker lifecycle @@ -73,7 +73,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -185,15 +185,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [concurrent](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [concurrent](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx index c9f14b40d8..70a0049646 100644 --- a/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx +++ b/docs/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see `SubscriptionWorkerOptions`. * In this page: - * [`subscription_worker` lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscription_worker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [`subscription_worker` lifecycle](#subscription_worker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## `subscription_worker` lifecycle @@ -54,7 +54,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -163,15 +163,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [CONCURRENT](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [CONCURRENT](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [CONCURRENT](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [CONCURRENT](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx b/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx index 7a1ed39051..27fe8fcfea 100644 --- a/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx +++ b/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * Documents that were assigned to workers whose connection has ended unexpectedly, can be reassigned by the server to available workers. - See [connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) below. + See [connection failure](#connection-failure) below. * In this page: - * [Defining concurrent workers](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#defining-concurrent-workers) - * [Dropping a connection](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#dropping-a-connection) - * [Connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) + * [Defining concurrent workers](#defining-concurrent-workers) + * [Dropping a connection](#dropping-a-connection) + * [Connection failure](#connection-failure) ## Defining concurrent workers diff --git a/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx b/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx index 1e0836f58b..34d0e7362c 100644 --- a/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx +++ b/docs/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * Documents that were assigned to workers whose connection has ended unexpectedly, can be reassigned by the server to available workers. - See [connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) below. + See [connection failure](#connection-failure) below. * In this page: - * [Defining concurrent workers](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#defining-concurrent-workers) - * [Dropping a connection](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#dropping-a-connection) - * [Connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) + * [Defining concurrent workers](#defining-concurrent-workers) + * [Dropping a connection](#dropping-a-connection) + * [Connection failure](#connection-failure) ## Defining concurrent workers diff --git a/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx b/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx index 5948b0ed9a..8a59dbf231 100644 --- a/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx +++ b/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) ## Data subscription consumption diff --git a/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx b/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx index 5199e144b2..b0ba14a913 100644 --- a/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx +++ b/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) diff --git a/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx b/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx index d0c082823b..982ac5045a 100644 --- a/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx +++ b/docs/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) diff --git a/docs/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx b/docs/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx index dc05ade4dd..a8bbde626f 100644 --- a/docs/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [Subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options) - * [Subscription query](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query) + * [Create subscription](#create-subscription) + * [Subscription creation options](#subscription-creation-options) + * [Update subscription](#update-subscription) + * [Subscription update options](#subscription-update-options) + * [Subscription query](#subscription-query) ## Create subscription @@ -55,9 +55,9 @@ Task CreateAsync(Expression> predicate = null, | Parameter | Type | Description | |----------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **predicate** | `Expression>` | An optional lambda expression that returns a boolean.
This predicate defines the filter criteria for the subscription documents. | -| **options** | `SubscriptionCreationOptions` | Contains subscription creation options.
See [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) | -| **options** | `SubscriptionCreationOptions` | Contains subscription creation options
(non-generic version).
See [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) | -| **options** | `PredicateSubscriptionCreationOptions ` | Contains subscription creation options
(when passing a predicate).
See [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) | +| **options** | `SubscriptionCreationOptions` | Contains subscription creation options.
See [Subscription creation options](#subscription-creation-options) | +| **options** | `SubscriptionCreationOptions` | Contains subscription creation options
(non-generic version).
See [Subscription creation options](#subscription-creation-options) | +| **options** | `PredicateSubscriptionCreationOptions ` | Contains subscription creation options
(when passing a predicate).
See [Subscription creation options](#subscription-creation-options) | | **database** | `string` | The name of the database where the subscription task will be created. If `null`, the default database configured in the DocumentStore will be used. | | **token** | `CancellationToken` | Cancellation token used in to halt the subscription creation process. | @@ -139,7 +139,7 @@ Options for the **non-generic** version of the subscription creation options obj | **Filter** | `Expression>` | Lambda expression defining the filter logic for the subscription. Will be translated to a JavaScript function. | | **Projection** | `Expression>` | Lambda expression defining the projection that will be sent by the subscription for each matching document. Will be translated to a JavaScript function. | | **Includes** | `Action>` | An action that defines include clauses for the subscription. [Included documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) and/or [included counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) will be part of the batch sent by the subscription. Include methods can be chained. | -| **ChangeVector** | `string` | Allows to define a change vector from which the subscription will start processing.
Learn more [below](../../../../client-api/data-subscriptions/creation/api-overview.mdx#the--property). | +| **ChangeVector** | `string` | Allows to define a change vector from which the subscription will start processing.
Learn more [below](#the--property). | | **Disabled** | `bool` | `true` - task will be disabled.
`false` - task will be enabled. | | **MentorNode** | `string` | Allows to define a node in the cluster that will be responsible to handle the subscription. Useful when you prefer a specific server due to its stronger hardware, closer geographic proximity to clients, or other reasons. | | **PinToMentorNode** | `bool` | `true` - the selected responsible node will be pinned to handle the task.
`false` - Another node will execute the task if the responsible node is down. | @@ -175,7 +175,7 @@ Task UpdateAsync(SubscriptionUpdateOptions options, string database = nu | Parameter | Type | Description | |--------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `SubscriptionUpdateOptions` | The subscription update options object.
See [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) | +| **options** | `SubscriptionUpdateOptions` | The subscription update options object.
See [SubscriptionUpdateOptions](#subscriptionupdateoptions) | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in the DocumentStore will be used. | | **token** | `CancellationToken` | Cancellation token used to halt the update process. | @@ -187,7 +187,7 @@ Task UpdateAsync(SubscriptionUpdateOptions options, string database = nu ## Subscription update options -`SubscriptionUpdateOptions` inherits from [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) +`SubscriptionUpdateOptions` inherits from [SubscriptionCreationOptions](#subscriptioncreationoptions) and adds two additional fields: diff --git a/docs/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx b/docs/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx index 154528cb19..c73019a8bd 100644 --- a/docs/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) - * [Include methods](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [Subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options) - * [Subscribe to revisions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscribe-to-revisions) - * [Subscription RQL](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-rql) + * [Create subscription](#create-subscription) + * [Subscription creation options](#subscription-creation-options) + * [Include methods](#include-methods) + * [Update subscription](#update-subscription) + * [Subscription update options](#subscription-update-options) + * [Subscribe to revisions](#subscribe-to-revisions) + * [Subscription RQL](#subscription-rql) ## Create subscription @@ -35,13 +35,13 @@ create(documentType); | Parameter | Type | Description | |------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options). | +| **options** | `object` | The [subscription creation options](#subscription-creation-options). | | **database** | `string` | The name of the database where the subscription task will be created.
If `null`, the default database configured in the DocumentStore will be used. | | **documentType** | `object` | The class type from which the collection of documents managed by the subscription will be derived. | | Return value | Description | |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Promise` | A Promise that resolves to the **name** of the created data subscription (a `string`).
If the name was provided in the [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options), it will be returned.
Otherwise, a unique name will be generated by server. | +| `Promise` | A Promise that resolves to the **name** of the created data subscription (a `string`).
If the name was provided in the [subscription creation options](#subscription-creation-options), it will be returned.
Otherwise, a unique name will be generated by server. | Examples for creating subscriptions are available [here](../../../../client-api/data-subscriptions/creation/examples.mdx). @@ -70,8 +70,8 @@ Examples for creating subscriptions are available [here](../../../../client-api/ | Member | Type | Description | |---------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **name** | `string` | User defined name for the subscription.
The name must be unique in the database. | -| **query** | `string` | RQL query that defines the subscription. This RQL comes with additional support to JavaScript functions inside the `where` clause and special semantics for subscriptions on documents revisions.
Learn more in [subscription RQL](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-rql). | -| **includes** | `(builder) => void` | A function that accepts a builder object, which allows you to include related documents, counters, and time series in the batch that is sent to the client.
See [Include methods](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods). | +| **query** | `string` | RQL query that defines the subscription. This RQL comes with additional support to JavaScript functions inside the `where` clause and special semantics for subscriptions on documents revisions.
Learn more in [subscription RQL](#subscription-rql). | +| **includes** | `(builder) => void` | A function that accepts a builder object, which allows you to include related documents, counters, and time series in the batch that is sent to the client.
See [Include methods](#include-methods). | | **changeVector** | `string` | Allows to define a change vector from which the subscription will start processing. Useful for ad-hoc processes that need to process only recent changes. In such cases, you can set the field to _"LastDocument"_ to start processing from the latest document in the collection. | | **mentorNode** | `string` | Allows to define a specific node in the cluster to handle the subscription. Useful when you prefer a specific server due to its stronger hardware, closer geographic proximity to clients, or other reasons. | | **pinToMentorNode** | `boolean` | `true` - task will only be handled by the specified mentor node.
`false` - When the specified mentor node is down, the cluster selects another node from the Database Group to handle the task.
Learn more in [pinning a task](../../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task). | @@ -163,7 +163,7 @@ update(options, database); | Parameter | Type | Description | |--------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options). | +| **options** | `object` | The [subscription update options](#subscription-update-options). | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in the DocumentStore will be used. | | Return value | Description | @@ -176,7 +176,7 @@ Examples for updating an existing subscription are available [here](../../../../ ## Subscription update options -The subscription update options object extends the [creation options object](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) +The subscription update options object extends the [creation options object](#subscription-creation-options) and adds two additional fields: @@ -221,7 +221,7 @@ createForRevisions(options, database); | Parameter | Type | Description | |--------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options). | +| **options** | `object` | The [subscription creation options](#subscription-creation-options). | | **database** | `string` | The name of the database where the subscription task will be created.
If `null`, the default database configured in the DocumentStore will be used. | When providing raw RQL to the `query` param in the options object, diff --git a/docs/client-api/data-subscriptions/creation/content/_api-overview-python.mdx b/docs/client-api/data-subscriptions/creation/content/_api-overview-python.mdx index 42a4912648..aba6c34a85 100644 --- a/docs/client-api/data-subscriptions/creation/content/_api-overview-python.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_api-overview-python.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) - * [Subscription query](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query) + * [Create subscription](#create-subscription) + * [SubscriptionCreationOptions](#subscriptioncreationoptions) + * [Update subscription](#update-subscription) + * [SubscriptionUpdateOptions](#subscriptionupdateoptions) + * [Subscription query](#subscription-query) ## Create subscription @@ -99,7 +99,7 @@ Modifies an existing data subscription. These methods are accessible at `Documen ## SubscriptionUpdateOptions -Inherits from `SubscriptionCreationOptions` and has all the same fields (see [above](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions)) plus the two additional fields described below: +Inherits from `SubscriptionCreationOptions` and has all the same fields (see [above](#subscriptioncreationoptions)) plus the two additional fields described below: diff --git a/docs/client-api/data-subscriptions/creation/content/_examples-csharp.mdx b/docs/client-api/data-subscriptions/creation/content/_examples-csharp.mdx index 4c71d9684a..1477bd557a 100644 --- a/docs/client-api/data-subscriptions/creation/content/_examples-csharp.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_examples-csharp.mdx @@ -11,16 +11,16 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter documents using regex](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents-using-regex) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Create subscription - subscribe to revisions](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---subscribe-to-revisions) - * [Create subscription - via update](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---via-update) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter documents using regex](#create-subscription---filter-documents-using-regex) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Create subscription - subscribe to revisions](#create-subscription---subscribe-to-revisions) + * [Create subscription - via update](#create-subscription---via-update) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -314,7 +314,7 @@ See how to consume this type of subscription [here](../../../../client-api/data- Include statements can be added to the subscription with `ISubscriptionIncludeBuilder`. This builder is assigned to the `Includes` property in [SubscriptionCreationOptions<T>](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst). -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. To include related documents, use method `IncludeDocuments`. @@ -338,7 +338,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/docs/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx b/docs/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx index ae8a4ac21d..d8c906a8c5 100644 --- a/docs/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx @@ -11,16 +11,16 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter documents using regex](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents-using-regex) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Create subscription - subscribe to revisions](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---subscribe-to-revisions) - * [Create subscription - via update](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---via-update) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter documents using regex](#create-subscription---filter-documents-using-regex) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Create subscription - subscribe to revisions](#create-subscription---subscribe-to-revisions) + * [Create subscription - via update](#create-subscription---via-update) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -239,7 +239,7 @@ const subscriptionName = await documentStore.subscriptions.create({ query }); Include statements can be added to the subscription with a _builder_ object. This builder is assigned to the `includes` property in the _options_ object. -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. See this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods) for all available include methods. @@ -265,7 +265,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/docs/client-api/data-subscriptions/creation/content/_examples-python.mdx b/docs/client-api/data-subscriptions/creation/content/_examples-python.mdx index 637bddc08d..0212418d42 100644 --- a/docs/client-api/data-subscriptions/creation/content/_examples-python.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_examples-python.mdx @@ -11,14 +11,14 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter documents using regex](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents-using-regex) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter documents using regex](#create-subscription---filter-documents-using-regex) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -227,7 +227,7 @@ See how to consume this type of subscription [here](../../../../client-api/data- Include statements can be added to the subscription with `SubscriptionIncludeBuilder`. This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst). -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. To include related documents, use method `include_documents`. @@ -251,7 +251,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx index 1ea774503c..454abc5712 100644 --- a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx index e7e5952443..748af66246 100644 --- a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx index 5aed7ed6c4..edcc70d9df 100644 --- a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx index 7136152ec7..e4b9a9cf28 100644 --- a/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx +++ b/docs/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/docs/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx b/docs/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx index 938d90661f..614dfe4c4d 100644 --- a/docs/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx +++ b/docs/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx @@ -22,15 +22,15 @@ import Panel from "@site/src/components/Panel"; and how to manually generate HiLo-based IDs when needed. * In this article: - * [How the HiLo algorithm works in RavenDB](../../../client-api/document-identifiers/hilo-algorithm.mdx#how-the-hilo-algorithm-works-in-ravendb) - * [Generating unique IDs efficiently](../../../client-api/document-identifiers/hilo-algorithm.mdx#generating-unique-ids-efficiently) - * [Using HiLo documents](../../../client-api/document-identifiers/hilo-algorithm.mdx#using-hilo-documents) - * [Returning HiLo ranges](../../../client-api/document-identifiers/hilo-algorithm.mdx#returning-hilo-ranges) - * [Identity parts separator](../../../client-api/document-identifiers/hilo-algorithm.mdx#identity-parts-separator) - * [Manual HiLo ID generation](../../../client-api/document-identifiers/hilo-algorithm.mdx#manual-hilo-id-generation) - * [Get next ID - number only](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) - * [Get next ID - full document ID](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) - * [Overriding the HiLo algorithm](../../../client-api/document-identifiers/hilo-algorithm.mdx#overriding-the-hilo-algorithm) + * [How the HiLo algorithm works in RavenDB](#how-the-hilo-algorithm-works-in-ravendb) + * [Generating unique IDs efficiently](#generating-unique-ids-efficiently) + * [Using HiLo documents](#using-hilo-documents) + * [Returning HiLo ranges](#returning-hilo-ranges) + * [Identity parts separator](#identity-parts-separator) + * [Manual HiLo ID generation](#manual-hilo-id-generation) + * [Get next ID - number only](#get-next-id---number-only) + * [Get next ID - full document ID](#get-next-id---full-document-id) + * [Overriding the HiLo algorithm](#overriding-the-hilo-algorithm) @@ -188,8 +188,8 @@ using (var session = newStore.OpenSession()) You can ask the default HiLo generator for the next ID value without storing a document first. You can retrieve either the next number from the HiLo range or the next full document ID, and then use that value when storing a document, as explained below: - * [Get next ID - number only](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) - * [Get next ID - full document ID](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) + * [Get next ID - number only](#get-next-id---number-only) + * [Get next ID - full document ID](#get-next-id---full-document-id) --- @@ -372,8 +372,8 @@ using (var session = store.OpenSession()) * Once you configure a custom `AsyncDocumentIdGenerator`: * Your custom ID generation logic is used whenever the session stores a document whose `Id` property is `null`. * The store's default `HiLoIdGenerator` is no longer available. - Calling [GenerateNextIdForAsync](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) or - [GenerateDocumentIdAsync](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) through `store.HiLoIdGenerator` + Calling [GenerateNextIdForAsync](#get-next-id---number-only) or + [GenerateDocumentIdAsync](#get-next-id---full-document-id) through `store.HiLoIdGenerator` will throw an exception. \ No newline at end of file diff --git a/docs/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx b/docs/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx index baeca5b4c6..e4b88b441e 100644 --- a/docs/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx +++ b/docs/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx @@ -17,14 +17,14 @@ import CodeBlock from '@theme/CodeBlock'; by the HiLo algorithm. As described below, this is how the identifier is generated by the session. * In this article: - * [Session Usage](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#session-usage) - * [Autogenerated IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#autogenerated-ids) + * [Session Usage](#session-usage) + * [Autogenerated IDs](#autogenerated-ids) * [Custom / Semantic IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#custom-/-semantic-ids) - * [Server-side generated IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids) - * [Identities](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) - * [Setting Identity IDs Using Commands and Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#setting-identity-ids-using-commands-and-operations) - * [Using Commands](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-commands) - * [Using Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-operations) + * [Server-side generated IDs](#server-side-generated-ids) + * [Identities](#identities) + * [Setting Identity IDs Using Commands and Operations](#setting-identity-ids-using-commands-and-operations) + * [Using Commands](#using-commands) + * [Using Operations](#using-operations) @@ -258,7 +258,7 @@ and might affect performance. By default, document IDs created by the server use `/` to separate their components. This separator can be changed to any other character except `|`, in the [Global Identifier Generation Conventions](../../../client-api/configuration/identifier-generation/global.mdx#identitypartsseparator). -See [Setting Identity IDs Using Commands and Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#setting-identity-ids-using-commands-and-operations) +See [Setting Identity IDs Using Commands and Operations](#setting-identity-ids-using-commands-and-operations) for details. * **Concurrent writes** @@ -349,7 +349,7 @@ session.Advanced.RequestExecutor.Execute(putCommand, session.Advanced.Context); RavenDB ver. 4.2 and higher provides high-level [operations](../../../client-api/operations/what-are-operations.mdx#operations-what-are-the-operations) that you may set IDs with, in addition to the -low-level [commands](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-commands) +low-level [commands](#using-commands) we have described above. There is no operational difference between using operations and commands, since the high-level operations actually execute low-level commands. However, using operations may produce a clearer, more concise code. diff --git a/docs/client-api/faq/backward-compatibility.mdx b/docs/client-api/faq/backward-compatibility.mdx index dd65bd5084..ea06a58a20 100644 --- a/docs/client-api/faq/backward-compatibility.mdx +++ b/docs/client-api/faq/backward-compatibility.mdx @@ -22,13 +22,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; compatible, and advises regarding upgrading. * In this page: - * [Client-Server Compatibility](../../client-api/faq/backward-compatibility.mdx#client-server-compatibility) - * [Compatibility - Up to RavenDB 4.1](../../client-api/faq/backward-compatibility.mdx#compatibility---up-to-ravendb-41) - * [Compatibility - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-42-and-higher) - * [Upgrading](../../client-api/faq/backward-compatibility.mdx#upgrading) - * [Upgrading - Up to RavenDB 4.1](../../client-api/faq/backward-compatibility.mdx#upgrading---up-to-ravendb-41) - * [Upgrading - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#upgrading---ravendb-42-and-higher) - * [Upgrading Order](../../client-api/faq/backward-compatibility.mdx#upgrading-order) + * [Client-Server Compatibility](#client-server-compatibility) + * [Compatibility - Up to RavenDB 4.1](#compatibility---up-to-ravendb-41) + * [Compatibility - RavenDB 4.2 and Higher](#compatibility---ravendb-42-and-higher) + * [Upgrading](#upgrading) + * [Upgrading - Up to RavenDB 4.1](#upgrading---up-to-ravendb-41) + * [Upgrading - RavenDB 4.2 and Higher](#upgrading---ravendb-42-and-higher) + * [Upgrading Order](#upgrading-order) @@ -80,7 +80,7 @@ requires the upgrading of the server and all clients in lockstep. ### Upgrading - RavenDB 4.2 and Higher When RavenDB is upgraded from version 4.2 and higher, e.g. from 4.2 to 5.3, it is recommended - but not mandatory - to upgrade the clients, since they -are [compatible with servers of versions higher than theirs](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-42-and-higher). +are [compatible with servers of versions higher than theirs](#compatibility---ravendb-42-and-higher). ### Upgrading Order To properly upgrade your applications and server, we advise you to upgrade the server first, diff --git a/docs/client-api/faq/transaction-support.mdx b/docs/client-api/faq/transaction-support.mdx index a98da8be18..7b40dd59b2 100644 --- a/docs/client-api/faq/transaction-support.mdx +++ b/docs/client-api/faq/transaction-support.mdx @@ -16,14 +16,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [ACID storage](../../client-api/faq/transaction-support.mdx#acid-storage) - * [What is and what isn't a transaction](../../client-api/faq/transaction-support.mdx#what-is-and-what-isn) - * [Working with transactions in RavenDB ](../../client-api/faq/transaction-support.mdx#working-with-transactions-in-ravendb) - * [Single-node model](../../client-api/faq/transaction-support.mdx#single-node-model) - * [Multi-master model](../../client-api/faq/transaction-support.mdx#multi-master-model) - * [Cluster-wide transactions](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions) - * [ACID for document operations](../../client-api/faq/transaction-support.mdx#acid-for-document-operations) - * [BASE for query operations](../../client-api/faq/transaction-support.mdx#base-for-query-operations) + * [ACID storage](#acid-storage) + * [What is and what isn't a transaction](#what-is-and-what-isn) + * [Working with transactions in RavenDB ](#working-with-transactions-in-ravendb) + * [Single-node model](#single-node-model) + * [Multi-master model](#multi-master-model) + * [Cluster-wide transactions](#cluster-wide-transactions) + * [ACID for document operations](#acid-for-document-operations) + * [BASE for query operations](#base-for-query-operations) ## ACID storage @@ -48,7 +48,7 @@ which guarantees all ACID properties, whether executed on document, index or loc It employs _Serializable_ isolation for write operations and _Snapshot_ isolation for read operations. * RavenDB doesn't support a transaction spanning __multiple__ HTTP requests. Interactive transactions are not implemented by RavenDB - (see [below](../../client-api/faq/transaction-support.mdx#no-support-for-interactive-transactions) for the reasoning behind this decision). + (see [below](#no-support-for-interactive-transactions) for the reasoning behind this decision). RavenDB offers [optimistic concurrency](../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx) feature to achieve similar behavior. * The [Client API Session](../../client-api/session/what-is-a-session-and-how-does-it-work.mdx) is a pure Client API object and does not represent a transaction, @@ -141,7 +141,7 @@ so you can utilize RavenDB for each of your scenarios: When running in a multi-node setup, RavenDB still uses transactions. However, they are single-node transactions. That means that the set of changes that you write in a transaction is committed only to the node you are writing to. It will then asynchronously replicate to the other nodes. -To achieve consistency across the entire cluster please refer to the [Cluster-wide transactions](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions) section below. +To achieve consistency across the entire cluster please refer to the [Cluster-wide transactions](#cluster-wide-transactions) section below. #### Replication conflicts @@ -159,14 +159,14 @@ This behavior was influenced by the [Dynamo paper](https://dl.acm.org/doi/10.114 The assumption is that if you are writing data to the database, you expect it to be persisted. RavenDB will do its utmost to provide that to you, allowing you to write to the database even in the case of partitions or partial failure states. -However, handling replication conflicts is a consideration you have to take into account when using single-node transactions in RavenDB (see below for running a [cluster-wide transaction](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions)). +However, handling replication conflicts is a consideration you have to take into account when using single-node transactions in RavenDB (see below for running a [cluster-wide transaction](#cluster-wide-transactions)). If no conflict resolution script is defined for a collection, then by default RavenDB resolves the conflict using the latest version based on the `@last-modified` property of conflicted versions of the document. That might result in the lost update anomaly. -If you care about avoiding lost updates, you need to ensure you have the conflict resolution script defined accordingly or use a [cluster-wide transaction](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions). +If you care about avoiding lost updates, you need to ensure you have the conflict resolution script defined accordingly or use a [cluster-wide transaction](#cluster-wide-transactions). diff --git a/docs/client-api/faq/what-is-a-collection.mdx b/docs/client-api/faq/what-is-a-collection.mdx index 3c5fccaef6..9c635d2b50 100644 --- a/docs/client-api/faq/what-is-a-collection.mdx +++ b/docs/client-api/faq/what-is-a-collection.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Collections are used throughout many RavenDB features, such as defining indexes, setting revisions, and much more. * In this page: - * [Collection Name Generation](../../client-api/faq/what-is-a-collection.mdx#collection-name-generation) - * [Collection Usages](../../client-api/faq/what-is-a-collection.mdx#collection-usages) + * [Collection Name Generation](#collection-name-generation) + * [Collection Usages](#collection-usages) * For more information see [Documents and Collections](../../studio/database/documents/documents-and-collections.mdx) diff --git a/docs/client-api/how-to/content/_handle-document-relationships-csharp.mdx b/docs/client-api/how-to/content/_handle-document-relationships-csharp.mdx index 27bec2917c..71e4acff0f 100644 --- a/docs/client-api/how-to/content/_handle-document-relationships-csharp.mdx +++ b/docs/client-api/how-to/content/_handle-document-relationships-csharp.mdx @@ -18,14 +18,14 @@ When applied correctly, they can drastically improve performance, reduce network * In this page: - * [Denormalization](../../../client-api/how-to/handle-document-relationships.mdx#denormalization) - * [Includes](../../../client-api/how-to/handle-document-relationships.mdx#includes) - * [One to many includes](../../../client-api/how-to/handle-document-relationships.mdx#one-to-many-includes) - * [Secondary level includes](../../../client-api/how-to/handle-document-relationships.mdx#secondary-level-includes) - * [Dictionary includes](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes) - * [Dictionary includes: complex types](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes-complex-types) - * [Combining approaches](../../../client-api/how-to/handle-document-relationships.mdx#combining-approaches) - * [Summary](../../../client-api/how-to/handle-document-relationships.mdx#summary) + * [Denormalization](#denormalization) + * [Includes](#includes) + * [One to many includes](#one-to-many-includes) + * [Secondary level includes](#secondary-level-includes) + * [Dictionary includes](#dictionary-includes) + * [Dictionary includes: complex types](#dictionary-includes-complex-types) + * [Combining approaches](#combining-approaches) + * [Summary](#summary) ## Denormalization diff --git a/docs/client-api/how-to/content/_handle-document-relationships-nodejs.mdx b/docs/client-api/how-to/content/_handle-document-relationships-nodejs.mdx index e42e50f987..7db4c0c8f0 100644 --- a/docs/client-api/how-to/content/_handle-document-relationships-nodejs.mdx +++ b/docs/client-api/how-to/content/_handle-document-relationships-nodejs.mdx @@ -18,14 +18,14 @@ When applied correctly, they can drastically improve performance, reduce network * In this page: - * [Denormalization](../../../client-api/how-to/handle-document-relationships.mdx#denormalization) - * [Includes](../../../client-api/how-to/handle-document-relationships.mdx#includes) - * [One to many includes](../../../client-api/how-to/handle-document-relationships.mdx#one-to-many-includes) - * [Secondary level includes](../../../client-api/how-to/handle-document-relationships.mdx#secondary-level-includes) - * [Dictionary includes](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes) - * [Dictionary includes: complex types](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes-complex-types) - * [Combining approaches](../../../client-api/how-to/handle-document-relationships.mdx#combining-approaches) - * [Summary](../../../client-api/how-to/handle-document-relationships.mdx#summary) + * [Denormalization](#denormalization) + * [Includes](#includes) + * [One to many includes](#one-to-many-includes) + * [Secondary level includes](#secondary-level-includes) + * [Dictionary includes](#dictionary-includes) + * [Dictionary includes: complex types](#dictionary-includes-complex-types) + * [Combining approaches](#combining-approaches) + * [Summary](#summary) ## Denormalization diff --git a/docs/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx b/docs/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx index 2e3d414e16..e5d629c773 100644 --- a/docs/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx +++ b/docs/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx @@ -22,24 +22,24 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Use convention defaults](../../../client-api/how-to/setup-aggressive-caching.mdx#use-convention-defaults) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Use convention defaults](#use-convention-defaults) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -102,7 +102,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/docs/client-api/how-to/content/_setup-aggressive-caching-java.mdx b/docs/client-api/how-to/content/_setup-aggressive-caching-java.mdx index fa861e4eff..c61de29c45 100644 --- a/docs/client-api/how-to/content/_setup-aggressive-caching-java.mdx +++ b/docs/client-api/how-to/content/_setup-aggressive-caching-java.mdx @@ -22,24 +22,24 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Use convention defaults](../../../client-api/how-to/setup-aggressive-caching.mdx#use-convention-defaults) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Use convention defaults](#use-convention-defaults) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -102,7 +102,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/docs/client-api/how-to/content/_setup-aggressive-caching-python.mdx b/docs/client-api/how-to/content/_setup-aggressive-caching-python.mdx index f0d5593d96..1ee8619ae9 100644 --- a/docs/client-api/how-to/content/_setup-aggressive-caching-python.mdx +++ b/docs/client-api/how-to/content/_setup-aggressive-caching-python.mdx @@ -22,23 +22,23 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -101,7 +101,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/docs/client-api/how-to/integrate-with-excel.mdx b/docs/client-api/how-to/integrate-with-excel.mdx index e36854abbe..de9ba0c413 100644 --- a/docs/client-api/how-to/integrate-with-excel.mdx +++ b/docs/client-api/how-to/integrate-with-excel.mdx @@ -40,7 +40,7 @@ In order to include only specific properties in the CSV output you can use the ` -In some cases it might be cumbersome to use the URL to send the query or the query might be too long. Please see our [dedicated section](../../client-api/how-to/integrate-with-excel.mdx#dealing-with-long-query-urls-in-excel) that deals with that problem. +In some cases it might be cumbersome to use the URL to send the query or the query might be too long. Please see our [dedicated section](#dealing-with-long-query-urls-in-excel) that deals with that problem. diff --git a/docs/client-api/how-to/subscribe-to-store-events.mdx b/docs/client-api/how-to/subscribe-to-store-events.mdx index 5a6afee8b4..4526c34b7e 100644 --- a/docs/client-api/how-to/subscribe-to-store-events.mdx +++ b/docs/client-api/how-to/subscribe-to-store-events.mdx @@ -29,18 +29,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about session events [here](../../client-api/session/how-to/subscribe-to-events.mdx). * In this article: - * [Store events](../../client-api/how-to/subscribe-to-store-events.mdx#store-events) - * [OnBeforeRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onbeforerequest) - * [OnSucceedRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onsucceedrequest) - * [AfterDispose](../../client-api/how-to/subscribe-to-store-events.mdx#afterdispose) - * [BeforeDispose](../../client-api/how-to/subscribe-to-store-events.mdx#beforedispose) - * [RequestExecutorCreated](../../client-api/how-to/subscribe-to-store-events.mdx#requestexecutorcreated) - * [OnSessionCreated](../../client-api/how-to/subscribe-to-store-events.mdx#onsessioncreated) - * [OnFailedRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onfailedrequest) - * [OnTopologyUpdated](../../client-api/how-to/subscribe-to-store-events.mdx#ontopologyupdated) - * [Store/Session events](../../client-api/how-to/subscribe-to-store-events.mdx#storesession-events) - * [Unsubscribing from an event](../../client-api/how-to/subscribe-to-store-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../client-api/how-to/subscribe-to-store-events.mdx#syntax) + * [Store events](#store-events) + * [OnBeforeRequest](#onbeforerequest) + * [OnSucceedRequest](#onsucceedrequest) + * [AfterDispose](#afterdispose) + * [BeforeDispose](#beforedispose) + * [RequestExecutorCreated](#requestexecutorcreated) + * [OnSessionCreated](#onsessioncreated) + * [OnFailedRequest](#onfailedrequest) + * [OnTopologyUpdated](#ontopologyupdated) + * [Store/Session events](#storesession-events) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/docs/client-api/how-to/using-timeonly-and-dateonly.mdx b/docs/client-api/how-to/using-timeonly-and-dateonly.mdx index 3fe4ca8ac9..dd976b7d23 100644 --- a/docs/client-api/how-to/using-timeonly-and-dateonly.mdx +++ b/docs/client-api/how-to/using-timeonly-and-dateonly.mdx @@ -22,16 +22,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can now convert `DateTime` or strings written in date/time formats to .NET's `DateOnly` or `TimeOnly` types without slowing down queries and while leaving your existing data as is. - * Use `AsDateOnly` or `AsTimeOnly` in a static index ([see examples below](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime)) + * Use `AsDateOnly` or `AsTimeOnly` in a static index ([see examples below](#use--or--in-a-static-index-to-convert-strings-or-datetime)) * `AsDateOnly` and `AsTimeOnly` automatically convert strings to ticks for faster querying. * We convert the types in [static indexes](../../indexes/map-indexes.mdx) so that the conversions and calculations are done behind the scenes and the data is ready for fast queries. ([See sample index below.](../../client-api/how-to/using-timeonly-and-dateonly.mdx#convert-and-use-date/timeonly-without-affecting-your-existing-data)) * In this page: - * [About DateOnly and TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#about-dateonly-and-timeonly) + * [About DateOnly and TimeOnly](#about-dateonly-and-timeonly) * [Convert and Use Date/TimeOnly Without Affecting Your Existing Data](../../client-api/how-to/using-timeonly-and-dateonly.mdx#convert-and-use-date/timeonly-without-affecting-your-existing-data) - * [Using already existing DateOnly or TimeOnly fields](../../client-api/how-to/using-timeonly-and-dateonly.mdx#using-already-existing-dateonly-or-timeonly-fields) + * [Using already existing DateOnly or TimeOnly fields](#using-already-existing-dateonly-or-timeonly-fields) @@ -55,7 +55,7 @@ These two new C# types are available from .NET 6.0+ (RavenDB 5.3+). ## Convert and Use Date/TimeOnly Without Affecting Your Existing Data -RavenDB offers conversion of types in static indexes with the methods [AsDateOnly or AsTimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime). +RavenDB offers conversion of types in static indexes with the methods [AsDateOnly or AsTimeOnly](#use--or--in-a-static-index-to-convert-strings-or-datetime). * [Static indexes](../../indexes/indexing-basics.mdx) process new data in the background, including calculations and conversions to DateOnly/TimeOnly values, which can be used as ticks, @@ -79,8 +79,8 @@ though comparing ticks is faster. ### Use `AsDateOnly` or `AsTimeOnly` in a static index to convert strings or DateTime -* [Converting Strings to DateOnly or TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#converting-strings-with-minimal-cost) -* [Converting DateTime to DateOnly or TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#converting--with-minimal-cost) +* [Converting Strings to DateOnly or TimeOnly](#converting-strings-with-minimal-cost) +* [Converting DateTime to DateOnly or TimeOnly](#converting--with-minimal-cost) #### Converting Strings with minimal cost @@ -273,7 +273,7 @@ var result = session **Querying on Ticks** -Strings are automatically converted to ticks with [`AsDateOnly` and `AsTimeOnly`](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime). +Strings are automatically converted to ticks with [`AsDateOnly` and `AsTimeOnly`](#use--or--in-a-static-index-to-convert-strings-or-datetime). diff --git a/docs/client-api/operations/common/content/_delete-by-query-csharp.mdx b/docs/client-api/operations/common/content/_delete-by-query-csharp.mdx index 29e9cc904a..0a0bf057a6 100644 --- a/docs/client-api/operations/common/content/_delete-by-query-csharp.mdx +++ b/docs/client-api/operations/common/content/_delete-by-query-csharp.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/common/content/_delete-by-query-nodejs.mdx b/docs/client-api/operations/common/content/_delete-by-query-nodejs.mdx index c0d7f2417e..f1e32a29b6 100644 --- a/docs/client-api/operations/common/content/_delete-by-query-nodejs.mdx +++ b/docs/client-api/operations/common/content/_delete-by-query-nodejs.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/common/content/_delete-by-query-php.mdx b/docs/client-api/operations/common/content/_delete-by-query-php.mdx index e2c9e2c214..da9793bb61 100644 --- a/docs/client-api/operations/common/content/_delete-by-query-php.mdx +++ b/docs/client-api/operations/common/content/_delete-by-query-php.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/common/content/_delete-by-query-python.mdx b/docs/client-api/operations/common/content/_delete-by-query-python.mdx index c0600d9ff0..40e7891465 100644 --- a/docs/client-api/operations/common/content/_delete-by-query-python.mdx +++ b/docs/client-api/operations/common/content/_delete-by-query-python.mdx @@ -25,8 +25,8 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) diff --git a/docs/client-api/operations/content/_what-are-operations-csharp.mdx b/docs/client-api/operations/content/_what-are-operations-csharp.mdx index d56b70f277..d00ec7d221 100644 --- a/docs/client-api/operations/content/_what-are-operations-csharp.mdx +++ b/docs/client-api/operations/content/_what-are-operations-csharp.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#kill-operation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#kill-operation) ## Why use operations @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `Send` method on the `Operations` property of the DocumentStore. @@ -186,7 +186,7 @@ Task> SendAsync(PatchOperation * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `Send` method on the `Maintenance` property in the DocumentStore. @@ -392,7 +392,7 @@ Task SendAsync(IMaintenanceOperation operation, Use [ForNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `Send` method on the `Maintenance.Server` property in the DocumentStore. diff --git a/docs/client-api/operations/content/_what-are-operations-nodejs.mdx b/docs/client-api/operations/content/_what-are-operations-nodejs.mdx index 279f29c4b8..75bab0d5d0 100644 --- a/docs/client-api/operations/content/_what-are-operations-nodejs.mdx +++ b/docs/client-api/operations/content/_what-are-operations-nodejs.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * __Operation types__: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#killoperation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#killoperation) ## Why use operations @@ -56,7 +56,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * __Background operations__: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property of the DocumentStore. @@ -161,7 +161,7 @@ await send(patchOperation, sessionInfo, resultType); * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -335,7 +335,7 @@ __Send syntax__: Use [forNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property of the DocumentStore. diff --git a/docs/client-api/operations/content/_what-are-operations-php.mdx b/docs/client-api/operations/content/_what-are-operations-php.mdx index 2533a1f1f4..624fbcefc2 100644 --- a/docs/client-api/operations/content/_what-are-operations-php.mdx +++ b/docs/client-api/operations/content/_what-are-operations-php.mdx @@ -14,14 +14,14 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) ## Why use operations @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property in the DocumentStore. @@ -155,7 +155,7 @@ public function send(...$parameters); * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -324,7 +324,7 @@ $status = $indexStats->getStatus(); // will be "Paused" Use [forNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/docs/client-api/operations/content/_what-are-operations-python.mdx b/docs/client-api/operations/content/_what-are-operations-python.mdx index bf8742e5c9..2df63a3728 100644 --- a/docs/client-api/operations/content/_what-are-operations-python.mdx +++ b/docs/client-api/operations/content/_what-are-operations-python.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#kill-operation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#kill-operation) ## Why use operations @@ -58,7 +58,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property of the DocumentStore. @@ -155,7 +155,7 @@ def send_patch_operation_with_entity_class( * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -325,7 +325,7 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper Use [for_node](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx b/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx index e0d0512557..a612588a1d 100644 --- a/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx +++ b/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server-maintenance operations - ForNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server-maintenance operations - ForNode](#server-maintenance-operations---fornode) ## Server maintenance operations - ForNode diff --git a/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx b/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx index 550e850c3e..98a9a1aa1b 100644 --- a/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx +++ b/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server maintenance operations - forNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server maintenance operations - forNode](#server-maintenance-operations---fornode) ## Server maintenance operations - forNode diff --git a/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx b/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx index 5744f29c27..bc63cb591a 100644 --- a/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx +++ b/docs/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server-maintenance operations - ForNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server-maintenance operations - ForNode](#server-maintenance-operations---fornode) ## Server maintenance operations - ForNode diff --git a/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx b/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx index fa4c3296b3..4c4fb8a58c 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx b/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx index c8228847e7..2dceaceb77 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx b/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx index 5bbf13f04f..922167b8ed 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx index 2b86f1ff2f..bca13a0045 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx index a1882b8c92..42a111998d 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx index 606fa07cd5..484c3db08e 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx index 60d1f73c4e..5d4e01225e 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx index ad46e4c334..534dfcb800 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx index 7fdf0fb004..541af8f192 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx index ec9d1548a2..62d64159e0 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx index 40bd2eb343..f30ce85ce8 100644 --- a/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx +++ b/docs/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/docs/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx b/docs/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx index 1dfb694b64..c4d25b09a5 100644 --- a/docs/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx +++ b/docs/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx @@ -8,15 +8,15 @@ import CodeBlock from '@theme/CodeBlock'; * Use the [PutConnectionStringOperation](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#the%c2%a0putconnectionstringoperation%c2%a0method) method to define a connection string in your database. * In this page: - * [Add a RavenDB connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-ravendb-connection-string) - * [Add an SQL connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-sql-connection-string) - * [Add a Snowflake connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-snowflake-connection-string) - * [Add an OLAP connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-olap-connection-string) - * [Add an Elasticsearch connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-elasticsearch-connection-string) - * [Add a Kafka connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-kafka-connection-string) - * [Add a RabbitMQ connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-rabbitmq-connection-string) - * [Add an Azure Queue Storage connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-azure-queue-storage-connection-string) - * [Add an Amazon SQS connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-amazon-sqs-connection-string) + * [Add a RavenDB connection string](#add-a-ravendb-connection-string) + * [Add an SQL connection string](#add-an-sql-connection-string) + * [Add a Snowflake connection string](#add-a-snowflake-connection-string) + * [Add an OLAP connection string](#add-an-olap-connection-string) + * [Add an Elasticsearch connection string](#add-an-elasticsearch-connection-string) + * [Add a Kafka connection string](#add-a-kafka-connection-string) + * [Add a RabbitMQ connection string](#add-a-rabbitmq-connection-string) + * [Add an Azure Queue Storage connection string](#add-an-azure-queue-storage-connection-string) + * [Add an Amazon SQS connection string](#add-an-amazon-sqs-connection-string) * [The PutConnectionStringOperation method](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#the%c2%a0putconnectionstringoperation%c2%a0method) diff --git a/docs/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx b/docs/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx index 95abc1e135..a8b69a3a2a 100644 --- a/docs/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx +++ b/docs/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to create a new connection string, see [Add Connection String Operation](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx). * In this page: - * [Get connection string by name and type](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#get-connection-string-by-name-and-type) - * [Get all connection strings](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#get-all-connnection-strings) - * [Syntax](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#syntax) + * [Get connection string by name and type](#get-connection-string-by-name-and-type) + * [Get all connection strings](#get-all-connnection-strings) + * [Syntax](#syntax) ## Get connection string by name and type diff --git a/docs/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx b/docs/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx index 69eda73d4b..81b24da81a 100644 --- a/docs/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx +++ b/docs/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `RemoveConnectionStringOperation` to remove a connection string definition from the database. * In this page: - * [Remove connection string](../../../../../client-api/operations/maintenance/connection-strings/remove-connection-string.mdx#remove-connecion-string) - * [Syntax](../../../../../client-api/operations/maintenance/connection-strings/remove-connection-string.mdx#syntax) + * [Remove connection string](#remove-connecion-string) + * [Syntax](#syntax) ## Remove connection string diff --git a/docs/client-api/operations/maintenance/content/_get-stats-csharp.mdx b/docs/client-api/operations/maintenance/content/_get-stats-csharp.mdx index 8ef04755cb..36030c57f3 100644 --- a/docs/client-api/operations/maintenance/content/_get-stats-csharp.mdx +++ b/docs/client-api/operations/maintenance/content/_get-stats-csharp.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [ForDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [ForDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) diff --git a/docs/client-api/operations/maintenance/content/_get-stats-java.mdx b/docs/client-api/operations/maintenance/content/_get-stats-java.mdx index 1fae1c14e5..df718630b8 100644 --- a/docs/client-api/operations/maintenance/content/_get-stats-java.mdx +++ b/docs/client-api/operations/maintenance/content/_get-stats-java.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [ForDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [ForDatabase](#get-stats-for-another-database). * In this page: - * [Get collection stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-stats) - * [Get detailed collection stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-stats) - * [Get database stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-stats) - * [Get detailed database stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats) - * [Get stats for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database) + * [Get collection stats](#get-collection-stats) + * [Get detailed collection stats](#get-detailed-collection-stats) + * [Get database stats](#get-database-stats) + * [Get detailed database stats](#get-detailed-database-stats) + * [Get stats for another database](#get-stats-for-another-database) ## Get collection stats diff --git a/docs/client-api/operations/maintenance/content/_get-stats-nodejs.mdx b/docs/client-api/operations/maintenance/content/_get-stats-nodejs.mdx index 0d3dc4753a..097ecccc2e 100644 --- a/docs/client-api/operations/maintenance/content/_get-stats-nodejs.mdx +++ b/docs/client-api/operations/maintenance/content/_get-stats-nodejs.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [forDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [forDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/docs/client-api/operations/maintenance/content/_get-stats-php.mdx b/docs/client-api/operations/maintenance/content/_get-stats-php.mdx index e71b112ca2..8508a669fa 100644 --- a/docs/client-api/operations/maintenance/content/_get-stats-php.mdx +++ b/docs/client-api/operations/maintenance/content/_get-stats-php.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [forDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [forDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/docs/client-api/operations/maintenance/content/_get-stats-python.mdx b/docs/client-api/operations/maintenance/content/_get-stats-python.mdx index 48a81b5992..58863dc624 100644 --- a/docs/client-api/operations/maintenance/content/_get-stats-python.mdx +++ b/docs/client-api/operations/maintenance/content/_get-stats-python.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [for_database](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [for_database](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/docs/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx b/docs/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx index 9738caff5c..10d619e3d3 100644 --- a/docs/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx +++ b/docs/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx @@ -12,16 +12,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Add RavenDB ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-ravendb-etl-task) - * [Add SQL ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-sql-etl-task) - * [Add Snowflake ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-snowflake-etl-task) - * [Add OLAP ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-olap-etl-task) - * [Add Elasticsearch ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-elasticsearch-etl-task) - * [Add Kafka ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-kafka-etl-task) - * [Add RabbitMQ ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-rabbitmq-etl-task) - * [Add Azure Queue Storage ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-azure-queue-storage-etl-task) - * [Add Amazon SQS ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-amazon-sqs-etl-task) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Add RavenDB ETL task](#add-ravendb-etl-task) + * [Add SQL ETL task](#add-sql-etl-task) + * [Add Snowflake ETL task](#add-snowflake-etl-task) + * [Add OLAP ETL task](#add-olap-etl-task) + * [Add Elasticsearch ETL task](#add-elasticsearch-etl-task) + * [Add Kafka ETL task](#add-kafka-etl-task) + * [Add RabbitMQ ETL task](#add-rabbitmq-etl-task) + * [Add Azure Queue Storage ETL task](#add-azure-queue-storage-etl-task) + * [Add Amazon SQS ETL task](#add-amazon-sqs-etl-task) + * [Syntax](#syntax) ## Add RavenDB ETL task diff --git a/docs/client-api/operations/maintenance/etl/content/_add-etl-java.mdx b/docs/client-api/operations/maintenance/etl/content/_add-etl-java.mdx index 3f1d1cd14e..3d1a32b908 100644 --- a/docs/client-api/operations/maintenance/etl/content/_add-etl-java.mdx +++ b/docs/client-api/operations/maintenance/etl/content/_add-etl-java.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to manage ETL tasks from the Studio, see [Ongoing tasks - overview](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx). * In this page: - * [Example - add Raven ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-raven-etl) - * [Example - add SQL ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-sql-etl) - * [Example - add OLAP ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-olap-etl) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Example - add Raven ETL](#example---add-raven-etl) + * [Example - add SQL ETL](#example---add-sql-etl) + * [Example - add OLAP ETL](#example---add-olap-etl) + * [Syntax](#syntax) ## Example - add Raven ETL diff --git a/docs/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx b/docs/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx index 58170dae88..183150f6e8 100644 --- a/docs/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx +++ b/docs/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to manage ETL tasks from the Studio, see [Ongoing tasks - overview](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx). * In this page: - * [Example - add Raven ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-raven-etl) - * [Example - add SQL ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-sql-etl) - * [Example - add OLAP ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-olap-etl) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Example - add Raven ETL](#example---add-raven-etl) + * [Example - add SQL ETL](#example---add-sql-etl) + * [Example - add OLAP ETL](#example---add-olap-etl) + * [Syntax](#syntax) ## Example - add Raven ETL diff --git a/docs/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx b/docs/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx index 09d03d3609..bfac0591d0 100644 --- a/docs/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx @@ -26,8 +26,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/docs/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx b/docs/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx index f7cbc6f2b1..bafbc76300 100644 --- a/docs/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx @@ -23,8 +23,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/docs/client-api/operations/maintenance/identities/content/_get-identities-php.mdx b/docs/client-api/operations/maintenance/identities/content/_get-identities-php.mdx index 6176ada7ab..85f8f0a247 100644 --- a/docs/client-api/operations/maintenance/identities/content/_get-identities-php.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_get-identities-php.mdx @@ -26,8 +26,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/docs/client-api/operations/maintenance/identities/content/_get-identities-python.mdx b/docs/client-api/operations/maintenance/identities/content/_get-identities-python.mdx index 1c54707c75..90875ad0ee 100644 --- a/docs/client-api/operations/maintenance/identities/content/_get-identities-python.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_get-identities-python.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx index a66fb5d3a6..c3fce10f04 100644 --- a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx index ea2d1d1e78..eac448b7a8 100644 --- a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx index c56dd45fa9..8e3bbb6d14 100644 --- a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx index 7b1d4db3c9..cd30e17816 100644 --- a/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx b/docs/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx index d369cc606f..b95b3f0252 100644 --- a/docs/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx b/docs/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx index f677028677..04b1f81bb3 100644 --- a/docs/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx b/docs/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx index cff41d67c5..6a75c48d3a 100644 --- a/docs/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/docs/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx b/docs/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx index 566905305a..101a42c5d5 100644 --- a/docs/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx +++ b/docs/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx index c23fc026f5..f7fe67a74f 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx index a93f84d8e7..ebef111c90 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx index e02fc1e16b..4d6e0c8812 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx index 92fa250e9a..79e0c07a20 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx index f1e376d6a0..f25efd5775 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx index 0426f99d7c..c3fd5f3ff1 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx index 4c93cd2d87..8f593bc293 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx index f429f6bcff..c9ae0351b8 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx index 4e222aee78..24a4bb1ef8 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -143,7 +143,7 @@ public DisableIndexOperation(string indexName, bool clusterWide) ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/docs/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx index 746ab05918..f42084f905 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -109,7 +109,7 @@ await documentStore.maintenance.send(disableIndexOp); ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/docs/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx index 7b891ccebb..d4b46dd567 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -109,7 +109,7 @@ $store->maintenance()->send($disableIndexOp); ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/docs/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx index c511961bc9..034eed0aad 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -110,7 +110,7 @@ store.maintenance.send(disable_index_op) ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/docs/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx index a2775febbb..f5e3044502 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/docs/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx index 621c2e63ec..b3ab68d902 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/docs/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx index 997762dea7..36191a1aed 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/docs/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx index 708d8c7303..8abe1ca66f 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx index 15e958192d..93f3960a59 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx index 194fa2b579..965fc8c3d5 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx index aa00d20fa5..c28a2a89c6 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx index f86695b186..307603df9c 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx index d2baafcaf9..d8529c4350 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx index 671350cba8..c1ff0ddadb 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx index 71fa11aaa3..6c710b24b0 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx index 05a9e103b6..218e602b9e 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) + * [Get index names example](#get-index-names-example) ## Get index names example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx index e86703a4bd..1bdda73349 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx index e87e0b571f..607390c08b 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-php.mdx index f901848ff9..de493677c5 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-index-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-index-python.mdx index c324e3105e..875f311218 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-index-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-index-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx index f05d5abfbf..029edea463 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx index f444d444bb..15e308f289 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx index 56996c3dfb..174f705673 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx index 34c5e18583..312e115833 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx index 9ff827853f..77f349695c 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx index 8435b10c26..9361b1277d 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx index d2fa71d61f..8180d4a934 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/docs/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx index 9f4ee0f571..ce8ad5c817 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx index 974984aede..4f8ebbb266 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx index 04f615feb4..4c1512ba91 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx index 3782d749dc..b8b51ced5b 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx index e75506f9bb..2e52cff22c 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx index 79fdf3d095..0f04730ffe 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx index 05544da750..3e7d69f423 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx index c6a4034ec3..8c8f88937c 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx index fd7ad51212..ddbcaa23c4 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/docs/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx index 32564305aa..5d5e163906 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; will put it back to the **normal** running state on the local node where the action was performed. * In this page: - * [Reset index](../../../../../client-api/operations/maintenance/indexes/reset-index.mdx#reset-index) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/reset-index.mdx#syntax) + * [Reset index](#reset-index) + * [Syntax](#syntax) ## Reset index diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx index f5bb188103..5ff3e542da 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx index 965351ae94..9f8f378b5e 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx index 779b275563..15676966f5 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx index e645f480f2..f7f124bbe6 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx index 7f875b0d11..595f7bd417 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx index 76e601122b..6012fcf834 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx index 0ca03bdf2a..9c1a709b7a 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx index 0cf2d12046..bc7506e7bd 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx index 24595073f8..935fc1204c 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx index f6d9a7b91b..3b32ef6b88 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-index-php.mdx index 14ef2aae9e..b70cb2c25e 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-index-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-index-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-index-python.mdx index 2fe3efecd1..94c86dbd14 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-index-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-index-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx index 3b9784baba..4013b8689d 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx index 64bd9cb18b..a5048570c3 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx index 26f607769e..7a23a6382d 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx index 745ccb26f2..a5f5959c6a 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx index b159519f88..029f8269c0 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx index 60db5fe885..807841aaef 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx index b6986b2db1..b822eda2b2 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx index 680d333d17..0e495c8486 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx index 0980efe6c6..d77178e55e 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx index 99620f9bf5..3e43f11785 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx index 88d0d1d7e0..28887a5003 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx index df4617a7f6..058b46e519 100644 --- a/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx +++ b/docs/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/docs/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx b/docs/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx index 238952e037..2fefe04bad 100644 --- a/docs/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx +++ b/docs/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Ongoing tasks can also be managed via the [Tasks list view](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#ongoing-tasks---view) in the Studio. * In this page: - * [Get ongoing task info](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#get-ongoing-task-info) - * [Delete ongoing task](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#delete-ongoing-task) - * [Toggle ongoing task state](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#toggle-ongoing-task-state) - * [Syntax](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#syntax) + * [Get ongoing task info](#get-ongoing-task-info) + * [Delete ongoing task](#delete-ongoing-task) + * [Toggle ongoing task state](#toggle-ongoing-task-state) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/patching/content/_set-based-csharp.mdx b/docs/client-api/operations/patching/content/_set-based-csharp.mdx index 0ff0844c73..ee8ce1a90e 100644 --- a/docs/client-api/operations/patching/content/_set-based-csharp.mdx +++ b/docs/client-api/operations/patching/content/_set-based-csharp.mdx @@ -13,9 +13,9 @@ This is usually not the case for NoSQL databases where set based operations are The same queries and indexes that are used for data retrieval are used for the set based operations. The syntax defining which documents to work on is exactly the same as you'd specified for those documents to be pulled from the store. In this page: -[Syntax overview](../../../../client-api/operations/patching/set-based.mdx#syntax-overview) -[Examples](../../../../client-api/operations/patching/set-based.mdx#examples) -[Additional notes](../../../../client-api/operations/patching/set-based.mdx#additional-notes) +[Syntax overview](#syntax-overview) +[Examples](#examples) +[Additional notes](#additional-notes) diff --git a/docs/client-api/operations/patching/content/_set-based-java.mdx b/docs/client-api/operations/patching/content/_set-based-java.mdx index ac9cdc38a8..cf9f60c909 100644 --- a/docs/client-api/operations/patching/content/_set-based-java.mdx +++ b/docs/client-api/operations/patching/content/_set-based-java.mdx @@ -13,9 +13,9 @@ This is usually not the case for NoSQL databases where set based operations are The same queries and indexes that are used for data retrieval are used for the set based operations. The syntax defining which documents to work on is exactly the same as you'd specified for those documents to be pulled from the store. In this page: -[Syntax overview](../../../../client-api/operations/patching/set-based.mdx#syntax-overview) -[Examples](../../../../client-api/operations/patching/set-based.mdx#examples) -[Additional notes](../../../../client-api/operations/patching/set-based.mdx#additional-notes) +[Syntax overview](#syntax-overview) +[Examples](#examples) +[Additional notes](#additional-notes) diff --git a/docs/client-api/operations/patching/content/_set-based-nodejs.mdx b/docs/client-api/operations/patching/content/_set-based-nodejs.mdx index ac49a4fe8a..09589d441d 100644 --- a/docs/client-api/operations/patching/content/_set-based-nodejs.mdx +++ b/docs/client-api/operations/patching/content/_set-based-nodejs.mdx @@ -11,21 +11,21 @@ import CodeBlock from '@theme/CodeBlock'; Set-based patching can also be done from the [Studio](../../../../studio/database/documents/patch-view.mdx). * In this page: - * [Overview](../../../../client-api/operations/patching/set-based.mdx#overview) - * [Defining set-based patching](../../../../client-api/operations/patching/set-based.mdx#defining-set-based-patching) - * [Important characteristics](../../../../client-api/operations/patching/set-based.mdx#important-characteristics) - * [Examples](../../../../client-api/operations/patching/set-based.mdx#examples) - * [Update by collection query](../../../../client-api/operations/patching/set-based.mdx#update-by-collection-query) - * [Update by collection query - access metadata](../../../../client-api/operations/patching/set-based.mdx#update-by-collection-query---access-metadata) - * [Update by dynamic query](../../../../client-api/operations/patching/set-based.mdx#update-by-dynamic-query) - * [Update by static index query](../../../../client-api/operations/patching/set-based.mdx#update-by-static-index-query) - * [Update all documents](../../../../client-api/operations/patching/set-based.mdx#update-all-documents) - * [Update by document ID](../../../../client-api/operations/patching/set-based.mdx#update-by-document-id) - * [Update by document ID using parameters](../../../../client-api/operations/patching/set-based.mdx#update-by-document-id-using-parameters) - * [Allow updating stale results](../../../../client-api/operations/patching/set-based.mdx#allow-updating-stale-results) - * [Syntax](../../../../client-api/operations/patching/set-based.mdx#syntax) - * [Send syntax](../../../../client-api/operations/patching/set-based.mdx#send-syntax) - * [PatchByQueryOperation syntax](../../../../client-api/operations/patching/set-based.mdx#syntax) + * [Overview](#overview) + * [Defining set-based patching](#defining-set-based-patching) + * [Important characteristics](#important-characteristics) + * [Examples](#examples) + * [Update by collection query](#update-by-collection-query) + * [Update by collection query - access metadata](#update-by-collection-query---access-metadata) + * [Update by dynamic query](#update-by-dynamic-query) + * [Update by static index query](#update-by-static-index-query) + * [Update all documents](#update-all-documents) + * [Update by document ID](#update-by-document-id) + * [Update by document ID using parameters](#update-by-document-id-using-parameters) + * [Allow updating stale results](#allow-updating-stale-results) + * [Syntax](#syntax) + * [Send syntax](#send-syntax) + * [PatchByQueryOperation syntax](#syntax) ## Overview @@ -83,7 +83,7 @@ update \{ * __Patching stale indexes__: By default, set-based patch operations will only succeed if the index is Not [stale](../../../../indexes/stale-indexes.mdx). For indexes that are frequently updated, you can explicitly allow patching on stale results if needed. - An example can be seen in the [Allow updating stale results](../../../../client-api/operations/patching/set-based.mdx#allow-updating-stale-results) example. + An example can be seen in the [Allow updating stale results](#allow-updating-stale-results) example. * __Manage lengthy patch operations__: The set-based patch operation (`PatchByQueryOperation`) runs in the server background may take a long time to complete. diff --git a/docs/client-api/operations/patching/content/_single-document-csharp.mdx b/docs/client-api/operations/patching/content/_single-document-csharp.mdx index 67bb97bb03..d56751d978 100644 --- a/docs/client-api/operations/patching/content/_single-document-csharp.mdx +++ b/docs/client-api/operations/patching/content/_single-document-csharp.mdx @@ -15,42 +15,42 @@ import CodeBlock from '@theme/CodeBlock'; * The current page covers patch operations on single documents. -* Patching has three possible interfaces: [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api), -[Session API using Defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer), -and [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api). +* Patching has three possible interfaces: [Session API](#session-api), +[Session API using Defer](#session-api-using-defer), +and [Operations API](#operations-api). -* Patching can be done from the [client API](../../../../client-api/operations/patching/single-document.mdx#examples) as well as in the [studio](../../../../studio/database/documents/patch-view.mdx). +* Patching can be done from the [client API](#examples) as well as in the [studio](../../../../studio/database/documents/patch-view.mdx). In this page: -* [API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) - * [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api) - * [Session API using Defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer) - * [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api) - * [List of script methods](../../../../client-api/operations/patching/single-document.mdx#list-of-script-methods) -* [Examples](../../../../client-api/operations/patching/single-document.mdx#examples) - * [Change value of single field](../../../../client-api/operations/patching/single-document.mdx#change-value-of-single-field) - * [Change values of two fields](../../../../client-api/operations/patching/single-document.mdx#change-values-of-two-fields) - * [Increment value](../../../../client-api/operations/patching/single-document.mdx#increment-value) - * [Add or increment](../../../../client-api/operations/patching/single-document.mdx#add-or-increment) - * [Add or patch](../../../../client-api/operations/patching/single-document.mdx#add-or-patch) - * [Add or patch to an existing array](../../../../client-api/operations/patching/single-document.mdx#add-or-patch-to-an-existing-array) - * [Add item to array](../../../../client-api/operations/patching/single-document.mdx#add-item-to-array) - * [Insert item into specific position in array](../../../../client-api/operations/patching/single-document.mdx#insert-item-into-specific-position-in-array) - * [Modify item in specific position in array](../../../../client-api/operations/patching/single-document.mdx#modify-item-in-specific-position-in-array) - * [Remove items from array](../../../../client-api/operations/patching/single-document.mdx#remove-items-from-array) - * [Loading documents in a script](../../../../client-api/operations/patching/single-document.mdx#loading-documents-in-a-script) - * [Remove property](../../../../client-api/operations/patching/single-document.mdx#remove-property) - * [Rename property](../../../../client-api/operations/patching/single-document.mdx#rename-property) - * [Add document](../../../../client-api/operations/patching/single-document.mdx#add-document) - * [Clone document](../../../../client-api/operations/patching/single-document.mdx#clone-document) - * [Increment counter](../../../../client-api/operations/patching/single-document.mdx#increment-counter) - * [Delete counter](../../../../client-api/operations/patching/single-document.mdx#delete-counter) - * [Get counter](../../../../client-api/operations/patching/single-document.mdx#get-counter) - * [Patching using inline string compilation](../../../../client-api/operations/patching/single-document.mdx#patching-using-inline-string-compilation) - * [Generate a random UUID](../../../../client-api/operations/patching/single-document.mdx#generate-a-random-uuid) - * [Store a SHA-256 hash of a field](../../../../client-api/operations/patching/single-document.mdx#store-a-sha-256-hash-of-a-field) - * [Encrypt a field](../../../../client-api/operations/patching/single-document.mdx#encrypt-a-field) +* [API overview](#api-overview) + * [Session API](#session-api) + * [Session API using Defer](#session-api-using-defer) + * [Operations API](#operations-api) + * [List of script methods](#list-of-script-methods) +* [Examples](#examples) + * [Change value of single field](#change-value-of-single-field) + * [Change values of two fields](#change-values-of-two-fields) + * [Increment value](#increment-value) + * [Add or increment](#add-or-increment) + * [Add or patch](#add-or-patch) + * [Add or patch to an existing array](#add-or-patch-to-an-existing-array) + * [Add item to array](#add-item-to-array) + * [Insert item into specific position in array](#insert-item-into-specific-position-in-array) + * [Modify item in specific position in array](#modify-item-in-specific-position-in-array) + * [Remove items from array](#remove-items-from-array) + * [Loading documents in a script](#loading-documents-in-a-script) + * [Remove property](#remove-property) + * [Rename property](#rename-property) + * [Add document](#add-document) + * [Clone document](#clone-document) + * [Increment counter](#increment-counter) + * [Delete counter](#delete-counter) + * [Get counter](#get-counter) + * [Patching using inline string compilation](#patching-using-inline-string-compilation) + * [Generate a random UUID](#generate-a-random-uuid) + * [Store a SHA-256 hash of a field](#store-a-sha-256-hash-of-a-field) + * [Encrypt a field](#encrypt-a-field) diff --git a/docs/client-api/operations/patching/content/_single-document-java.mdx b/docs/client-api/operations/patching/content/_single-document-java.mdx index 564f1bc0d2..b63e9b2134 100644 --- a/docs/client-api/operations/patching/content/_single-document-java.mdx +++ b/docs/client-api/operations/patching/content/_single-document-java.mdx @@ -9,13 +9,13 @@ The whole operation is executed on the server side and is useful as a performanc The current page deals with patch operations on single documents. -Patching has three possible interfaces: [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api), [Session API using defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer), and [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api). +Patching has three possible interfaces: [Session API](#session-api), [Session API using defer](#session-api-using-defer), and [Operations API](#operations-api). Patching can be done from the client as well as in the studio. In this page: -[API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) -[Examples](../../../../client-api/operations/patching/single-document.mdx#examples) +[API overview](#api-overview) +[Examples](#examples) ## API overview diff --git a/docs/client-api/operations/patching/content/_single-document-nodejs.mdx b/docs/client-api/operations/patching/content/_single-document-nodejs.mdx index c939ef8e3f..92dacaa679 100644 --- a/docs/client-api/operations/patching/content/_single-document-nodejs.mdx +++ b/docs/client-api/operations/patching/content/_single-document-nodejs.mdx @@ -19,42 +19,42 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) + * [API overview](#api-overview) - * [Examples](../../../../client-api/operations/patching/single-document.mdx#examples) - * [Modify value of single field](../../../../client-api/operations/patching/single-document.mdx#modify-value-of-single-field) - * [Modify values of two fields](../../../../client-api/operations/patching/single-document.mdx#modify-values-of-two-fields) - * [Increment value](../../../../client-api/operations/patching/single-document.mdx#increment-value) - * [Add or increment](../../../../client-api/operations/patching/single-document.mdx#add-or-increment) - * [Add or patch](../../../../client-api/operations/patching/single-document.mdx#add-or-patch) - * [Add item to array](../../../../client-api/operations/patching/single-document.mdx#add-item-to-array) - * [Add or patch an existing array](../../../../client-api/operations/patching/single-document.mdx#add-or-patch-an-existing-array) - * [Insert item into specific position in array](../../../../client-api/operations/patching/single-document.mdx#insert-item-into-specific-position-in-array) - * [Modify item in specific position in array](../../../../client-api/operations/patching/single-document.mdx#modify-item-in-specific-position-in-array) - * [Remove items from array](../../../../client-api/operations/patching/single-document.mdx#remove-items-from-array) - * [Load documents in a script](../../../../client-api/operations/patching/single-document.mdx#load-documents-in-a-script) - * [Remove property](../../../../client-api/operations/patching/single-document.mdx#remove-property) - * [Rename property](../../../../client-api/operations/patching/single-document.mdx#rename-property) - * [Add document](../../../../client-api/operations/patching/single-document.mdx#add-document) - * [Clone document](../../../../client-api/operations/patching/single-document.mdx#clone-document) - * [Create/Increment counter](../../../../client-api/operations/patching/single-document.mdx#createincrement-counter) - * [Delete counter](../../../../client-api/operations/patching/single-document.mdx#delete-counter) - * [Get counter](../../../../client-api/operations/patching/single-document.mdx#get-counter) - * [Patching using inline string compilation](../../../../client-api/operations/patching/single-document.mdx#patching-using-inline-string-compilation) - * [Generate a random UUID](../../../../client-api/operations/patching/single-document.mdx#generate-a-random-uuid) - * [Store a SHA-256 hash of a field](../../../../client-api/operations/patching/single-document.mdx#store-a-sha-256-hash-of-a-field) - * [Encrypt a field](../../../../client-api/operations/patching/single-document.mdx#encrypt-a-field) + * [Examples](#examples) + * [Modify value of single field](#modify-value-of-single-field) + * [Modify values of two fields](#modify-values-of-two-fields) + * [Increment value](#increment-value) + * [Add or increment](#add-or-increment) + * [Add or patch](#add-or-patch) + * [Add item to array](#add-item-to-array) + * [Add or patch an existing array](#add-or-patch-an-existing-array) + * [Insert item into specific position in array](#insert-item-into-specific-position-in-array) + * [Modify item in specific position in array](#modify-item-in-specific-position-in-array) + * [Remove items from array](#remove-items-from-array) + * [Load documents in a script](#load-documents-in-a-script) + * [Remove property](#remove-property) + * [Rename property](#rename-property) + * [Add document](#add-document) + * [Clone document](#clone-document) + * [Create/Increment counter](#createincrement-counter) + * [Delete counter](#delete-counter) + * [Get counter](#get-counter) + * [Patching using inline string compilation](#patching-using-inline-string-compilation) + * [Generate a random UUID](#generate-a-random-uuid) + * [Store a SHA-256 hash of a field](#store-a-sha-256-hash-of-a-field) + * [Encrypt a field](#encrypt-a-field) - * [Syntax](../../../../client-api/operations/patching/single-document.mdx#syntax) - * [Session API syntax](../../../../client-api/operations/patching/single-document.mdx#session-api-syntax) - * [Session API using defer syntax](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer-syntax) - * [Operations API syntax](../../../../client-api/operations/patching/single-document.mdx#operations-api-syntax) - * [List of script methods syntax](../../../../client-api/operations/patching/single-document.mdx#list-of-script-methods-syntax) + * [Syntax](#syntax) + * [Session API syntax](#session-api-syntax) + * [Session API using defer syntax](#session-api-using-defer-syntax) + * [Operations API syntax](#operations-api-syntax) + * [List of script methods syntax](#list-of-script-methods-syntax) ## API overview -Patching can be performed using either of the following interfaces (detailed syntax is provided [below](../../../../client-api/operations/patching/single-document.mdx#syntax)): +Patching can be performed using either of the following interfaces (detailed syntax is provided [below](#syntax)): * **Session API** * **Session API using defer** @@ -68,7 +68,7 @@ Patching can be performed using either of the following interfaces (detailed syn * Multiple patch methods can be defined on the [session](../../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx) and are sent to the server for execution in a single batch (along with any other modified documents) only when calling [SaveChanges](../../../../client-api/session/saving-changes.mdx). -* This API includes the following patching methods (see examples [below](../../../../client-api/operations/patching/single-document.mdx#examples)): +* This API includes the following patching methods (see examples [below](#examples)): * `patch` * `addOrPatch` * `increment` diff --git a/docs/client-api/operations/patching/json-patch-syntax.mdx b/docs/client-api/operations/patching/json-patch-syntax.mdx index 90014aa2e7..ddb8bfd631 100644 --- a/docs/client-api/operations/patching/json-patch-syntax.mdx +++ b/docs/client-api/operations/patching/json-patch-syntax.mdx @@ -34,16 +34,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Test** whether the patching succeeded * In this page: - * [JSON Patches](../../../client-api/operations/patching/json-patch-syntax.mdx#json-patches) - * [Running JSON Patches](../../../client-api/operations/patching/json-patch-syntax.mdx#running-json-patches) - * [Patch Operations](../../../client-api/operations/patching/json-patch-syntax.mdx#patch-operations) - * [Add Document Property](../../../client-api/operations/patching/json-patch-syntax.mdx#add-operation) - * [Remove Document Property](../../../client-api/operations/patching/json-patch-syntax.mdx#remove-document-property) - * [Replace Document Property Contents](../../../client-api/operations/patching/json-patch-syntax.mdx#replace-document-property-contents) - * [Copy Document Property Contents to Another Property](../../../client-api/operations/patching/json-patch-syntax.mdx#copy-document-property-contents-to-another-property) - * [Move Document Property Contents to Another Property](../../../client-api/operations/patching/json-patch-syntax.mdx#move-document-property-contents-to-another-property) - * [Test Patching Operation](../../../client-api/operations/patching/json-patch-syntax.mdx#test-patching-operation) - * [Additional JSON Patching Options](../../../client-api/operations/patching/json-patch-syntax.mdx#additional-json-patching-options) + * [JSON Patches](#json-patches) + * [Running JSON Patches](#running-json-patches) + * [Patch Operations](#patch-operations) + * [Add Document Property](#add-operation) + * [Remove Document Property](#remove-document-property) + * [Replace Document Property Contents](#replace-document-property-contents) + * [Copy Document Property Contents to Another Property](#copy-document-property-contents-to-another-property) + * [Move Document Property Contents to Another Property](#move-document-property-contents-to-another-property) + * [Test Patching Operation](#test-patching-operation) + * [Additional JSON Patching Options](#additional-json-patching-options) ## JSON Patches diff --git a/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx b/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx index 31d1262405..3eaaf309a3 100644 --- a/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx +++ b/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx b/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx index ff29acf58f..d0aa9032f7 100644 --- a/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx +++ b/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx b/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx index a3c5a9c645..377f371039 100644 --- a/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx +++ b/docs/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx b/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx index fce920222a..d840b4c97c 100644 --- a/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx +++ b/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; the next time it makes a request to the database. * In this page: * [Put client-configuration (server-wide)](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#put-client-configuration-(server-wide)) - * [Syntax](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Put client-configuration (server-wide) diff --git a/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx b/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx index 0e467c833c..6fbc9d9c8a 100644 --- a/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx +++ b/docs/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; the next time it makes a request to the database. * In this page: * [Put client-configuration (server-wide)](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#put-client-configuration-(server-wide)) - * [Syntax](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Put client-configuration (server-wide) diff --git a/docs/client-api/operations/server-wide/content/_add-database-node-csharp.mdx b/docs/client-api/operations/server-wide/content/_add-database-node-csharp.mdx index a276dc7464..4f2e2152e0 100644 --- a/docs/client-api/operations/server-wide/content/_add-database-node-csharp.mdx +++ b/docs/client-api/operations/server-wide/content/_add-database-node-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/docs/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx b/docs/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx index 4f4f3fd485..1283ee43e5 100644 --- a/docs/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx +++ b/docs/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/docs/client-api/operations/server-wide/content/_add-database-node-php.mdx b/docs/client-api/operations/server-wide/content/_add-database-node-php.mdx index 9b73dd3f10..6bb51d67dc 100644 --- a/docs/client-api/operations/server-wide/content/_add-database-node-php.mdx +++ b/docs/client-api/operations/server-wide/content/_add-database-node-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/docs/client-api/operations/server-wide/content/_add-database-node-python.mdx b/docs/client-api/operations/server-wide/content/_add-database-node-python.mdx index e5b058a507..8509fc89c5 100644 --- a/docs/client-api/operations/server-wide/content/_add-database-node-python.mdx +++ b/docs/client-api/operations/server-wide/content/_add-database-node-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/docs/client-api/operations/server-wide/content/_compact-database-csharp.mdx b/docs/client-api/operations/server-wide/content/_compact-database-csharp.mdx index 3671447e6b..37f6254633 100644 --- a/docs/client-api/operations/server-wide/content/_compact-database-csharp.mdx +++ b/docs/client-api/operations/server-wide/content/_compact-database-csharp.mdx @@ -26,14 +26,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/operations/server-wide/content/_compact-database-nodejs.mdx b/docs/client-api/operations/server-wide/content/_compact-database-nodejs.mdx index 60f762a229..b974e885fa 100644 --- a/docs/client-api/operations/server-wide/content/_compact-database-nodejs.mdx +++ b/docs/client-api/operations/server-wide/content/_compact-database-nodejs.mdx @@ -26,14 +26,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/operations/server-wide/content/_compact-database-php.mdx b/docs/client-api/operations/server-wide/content/_compact-database-php.mdx index 1786e738ff..644c21c6c3 100644 --- a/docs/client-api/operations/server-wide/content/_compact-database-php.mdx +++ b/docs/client-api/operations/server-wide/content/_compact-database-php.mdx @@ -25,14 +25,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/docs/client-api/operations/server-wide/content/_compact-database-python.mdx b/docs/client-api/operations/server-wide/content/_compact-database-python.mdx index 5a9abb06b0..51bc805228 100644 --- a/docs/client-api/operations/server-wide/content/_compact-database-python.mdx +++ b/docs/client-api/operations/server-wide/content/_compact-database-python.mdx @@ -25,12 +25,12 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) ## Examples diff --git a/docs/client-api/operations/server-wide/content/_create-database-csharp.mdx b/docs/client-api/operations/server-wide/content/_create-database-csharp.mdx index 114d97252d..c25a160168 100644 --- a/docs/client-api/operations/server-wide/content/_create-database-csharp.mdx +++ b/docs/client-api/operations/server-wide/content/_create-database-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; To learn which operations are allowed at each level, see [Security clearance and permissions](../../../../server/security/authorization/security-clearance-and-permissions.mdx). * In this article: - * [Create new database](../../../../client-api/operations/server-wide/create-database.mdx#create-new-database) - * [Example I - Create non-sharded database](../../../../client-api/operations/server-wide/create-database.mdx#example-i---create-non-sharded-database) - * [Example II - Create sharded database](../../../../client-api/operations/server-wide/create-database.mdx#example-ii---create-sharded-database) - * [Example III - Ensure database does not exist before creating](../../../../client-api/operations/server-wide/create-database.mdx#example-iii---ensure-database-does-not-exist-before-creating) - * [Syntax](../../../../client-api/operations/server-wide/create-database.mdx#syntax) + * [Create new database](#create-new-database) + * [Example I - Create non-sharded database](#example-i---create-non-sharded-database) + * [Example II - Create sharded database](#example-ii---create-sharded-database) + * [Example III - Ensure database does not exist before creating](#example-iii---ensure-database-does-not-exist-before-creating) + * [Syntax](#syntax) ## Create new database @@ -339,9 +339,9 @@ public CreateDatabaseOperation(Action builder | Parameter | Description | |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **databaseRecord** | Instance of `DatabaseRecord` containing database configuration.
See [The Database Record](../../../../client-api/operations/server-wide/create-database.mdx#the-database-record) below. | +| **databaseRecord** | Instance of `DatabaseRecord` containing database configuration.
See [The Database Record](#the-database-record) below. | | **replicationFactor** | Number of nodes the database should be replicated to.

If not specified, the value is taken from `databaseRecord.Topology.ReplicationFactor`,
or defaults to **`1`** if that is not set.

If `Topology` is provided, the `replicationFactor` is ignored. | -| **builder** | Callback used to initialize and fluently configure a new DatabaseRecord.
Receives an `IDatabaseRecordBuilderInitializer` on which you invoke builder methods to construct the record. See [The Database Record Builder](../../../../client-api/operations/server-wide/create-database.mdx#the-database-record-builder) below. | +| **builder** | Callback used to initialize and fluently configure a new DatabaseRecord.
Receives an `IDatabaseRecordBuilderInitializer` on which you invoke builder methods to construct the record. See [The Database Record Builder](#the-database-record-builder) below. | ### The Database Record: The `DatabaseRecord` is a collection of database configurations: diff --git a/docs/client-api/operations/server-wide/content/_create-database-java.mdx b/docs/client-api/operations/server-wide/content/_create-database-java.mdx index bf8bfe26ae..e8e8b52433 100644 --- a/docs/client-api/operations/server-wide/content/_create-database-java.mdx +++ b/docs/client-api/operations/server-wide/content/_create-database-java.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn which operations are allowed at each level, see [Security clearance and permissions](../../../../server/security/authorization/security-clearance-and-permissions.mdx). * In this article: - * [Create new database](../../../../client-api/operations/server-wide/create-database.mdx#create-new-database) - * [Example I - Create database](../../../../client-api/operations/server-wide/create-database.mdx#example-i---create-non-sharded-database) - * [Example II - Ensure database does not exist before creating](../../../../client-api/operations/server-wide/create-database.mdx#example-ii---ensure-database-does-not-exist-before-creating) - * [Syntax](../../../../client-api/operations/server-wide/create-database.mdx#syntax) + * [Create new database](#create-new-database) + * [Example I - Create database](#example-i---create-non-sharded-database) + * [Example II - Ensure database does not exist before creating](#example-ii---ensure-database-does-not-exist-before-creating) + * [Syntax](#syntax) ## Create new database diff --git a/docs/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx b/docs/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx index 38df44762b..73b25abc06 100644 --- a/docs/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx +++ b/docs/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/docs/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx b/docs/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx index 3f44ee5cad..e7f8eb546d 100644 --- a/docs/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx +++ b/docs/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/docs/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx b/docs/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx index 9e2a453d62..f472089b15 100644 --- a/docs/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx +++ b/docs/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/docs/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx b/docs/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx index e9b4630154..8564dc961f 100644 --- a/docs/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx +++ b/docs/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/docs/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx b/docs/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx index c04f00aa79..eca9329f5a 100644 --- a/docs/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx +++ b/docs/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx @@ -12,8 +12,8 @@ import Panel from '@site/src/components/Panel'; * Learn more about RavenDB's logging system in the [Logging](../../../../../server/troubleshooting/logging.mdx) article. * In this article: - * [Get logs configuration](../../../../../client-api/operations/server-wide/logs/get-logs-configuration.mdx#get-logs-configuration) - * [Syntax](../../../../../client-api/operations/server-wide/logs/get-logs-configuration.mdx#syntax) + * [Get logs configuration](#get-logs-configuration) + * [Syntax](#syntax) diff --git a/docs/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx b/docs/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx index 99d3978a65..728b92d588 100644 --- a/docs/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx +++ b/docs/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx @@ -20,10 +20,10 @@ import Panel from '@site/src/components/Panel'; * Learn more about RavenDB's logging system in the [Logging](../../../../../server/troubleshooting/logging.mdx) article. * In this article: - * [Set logs configuration](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#set-logs-configuration) - * [Set Microsoft logs configuration](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#set-microsoft-logs-configuration) - * [Set Admin logs configuration](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#set-admin-logs-configuration) - * [Syntax](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#syntax) + * [Set logs configuration](#set-logs-configuration) + * [Set Microsoft logs configuration](#set-microsoft-logs-configuration) + * [Set Admin logs configuration](#set-admin-logs-configuration) + * [Syntax](#syntax) diff --git a/docs/client-api/rest-api/document-commands/batch-commands.mdx b/docs/client-api/rest-api/document-commands/batch-commands.mdx index f1ead7fd68..8645fcba76 100644 --- a/docs/client-api/rest-api/document-commands/batch-commands.mdx +++ b/docs/client-api/rest-api/document-commands/batch-commands.mdx @@ -18,20 +18,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use this endpoint with the **`POST`** method to send multiple commands in one request: `/databases//bulk_docs` -* The commands are sent as a JSON array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#body). +* The commands are sent as a JSON array in the [request body](#body). * All the commands in the batch will either succeed or fail as a **single transaction**. Changes will not be visible until the entire batch completes. -* [Options](../../../client-api/rest-api/document-commands/batch-commands.mdx#batch-options) can be set to make the server wait +* [Options](#batch-options) can be set to make the server wait for indexing and replication to complete before returning. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/batch-commands.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format) - * [Commands](../../../client-api/rest-api/document-commands/batch-commands.mdx#commands) - * [Response Format](../../../client-api/rest-api/document-commands/batch-commands.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/batch-commands.mdx#more-examples) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Commands](#commands) + * [Response Format](#response-format) + * [More Examples](#more-examples) ## Basic Example @@ -114,7 +114,7 @@ Raven-Server-Version: 4.2.4.42 ## Request Format This is the general format of a cURL request with a batch of commands that _does not_ include a Put Attachment Command -(see the format for batching a Put Attachment Command [below](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command)): +(see the format for batching a Put Attachment Command [below](#put-attachment-command)): @@ -134,7 +134,7 @@ Linebreaks are added for clarity. #### Query String -The query string takes [batch options](../../../client-api/rest-api/document-commands/batch-commands.mdx#batch-options), which +The query string takes [batch options](#batch-options), which can make the server wait for indexing and replication to finish before responding. @@ -143,7 +143,7 @@ can make the server wait for indexing and replication to finish before respondin The header `Content-Type` is required and takes one of two values: * `application/json` - if the batch _does not_ include a Put Attachment Command. -* `multipart/mixed; boundary=` - if the batch [_does_](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command) +* `multipart/mixed; boundary=` - if the batch [_does_](#put-attachment-command) include a Put Attachment Command. The "separator" is an arbitrary string used to demarcate the attachment streams and commands array. @@ -173,12 +173,12 @@ using a backslash: `"` -> `\"`. The following commands can be sent using the batch command: -* [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command) -* [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command) -* [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command) -* [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command) -* [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command) -* [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command) +* [Put Document Command](#put-document-command) +* [Patch Document Command](#patch-document-command) +* [Delete Document Command](#delete-document-command) +* [Delete by Prefix Command](#delete-by-prefix-command) +* [Put Attachment Command](#put-attachment-command) +* [Delete Attachment Command](#delete-attachment-command) ### Batch Options These options, configured in the query string, make the server wait until indexing or replication have completed before responding. If these have not @@ -221,7 +221,7 @@ Linebreaks are added for clarity. Upload a new document or update an existing document. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -251,7 +251,7 @@ Format within the `Commands` array in the [request body](../../../client-api/res Update a document. A [patch](../../../client-api/operations/patching/single-document.mdx) is executed on the server side and does not involve loading the document, avoiding the cost of sending the entire document in a round trip over the network. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -281,8 +281,8 @@ Format within the `Commands` array in the [request body](../../../client-api/res | - | - | - | | **Id** | ID of a document to execute the patch on | Yes | | **ChangeVector** | The document's expected [change vector](../../../server/clustering/replication/change-vector.mdx). If it does not match the server-side change vector a concurrency exception is thrown. | No | -| **Patch** | A script that modifies the specified document. [Details below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-request). | Yes | -| **PatchIfMissing** | An alternative script to be executed if no document with the given ID is found. This will create a new document with the given ID. [Details below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-request). | No | +| **Patch** | A script that modifies the specified document. [Details below](#patch-request). | Yes | +| **PatchIfMissing** | An alternative script to be executed if no document with the given ID is found. This will create a new document with the given ID. [Details below](#patch-request). | No | | **Type** | Set to `PATCH` | Yes | #### Patch Request @@ -298,7 +298,7 @@ wrap strings. Delete a document by its ID. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -320,7 +320,7 @@ Format within the `Commands` array in the [request body](../../../client-api/res Delete all documents whose IDs begin with a certain prefix. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -391,7 +391,7 @@ Command-Type: AttachmentStream Delete an attachment in a certain document. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -442,12 +442,12 @@ Results appear in the same order as the commands in the request body. * Format within the `Results` array in the response body: - * [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command-1) - * [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command-1) - * [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command-1) - * [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command-1) - * [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command-1) - * [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command-1) + * [Put Document Command](#put-document-command-1) + * [Patch Document Command](#patch-document-command-1) + * [Delete Document Command](#delete-document-command-1) + * [Delete by Prefix Command](#delete-by-prefix-command-1) + * [Put Attachment Command](#put-attachment-command-1) + * [Delete Attachment Command](#delete-attachment-command-1) ### Put Document Command @@ -493,7 +493,7 @@ Results appear in the same order as the commands in the request body. | **@change-vector** | The document's change vector after the command was executed. Returns `null` if the command did not result in any changes. | | **@last-modified** | Date and time (UTC) of the most recent modification made to the document. | | **Type** | Same as the `Type` of the command sent - in this case `PATCH`. | -| **PatchStatus** | See [below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patchstatus) | +| **PatchStatus** | See [below](#patchstatus) | | **Debug** | Should always return `null` in the context of batch commands. | #### PatchStatus @@ -601,12 +601,12 @@ Results appear in the same order as the commands in the request body. [About Northwind](../../../start/about-examples.mdx), the database used in our examples. * In this section: - * [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command-2) - * [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command-2) - * [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command-2) - * [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command-2) - * [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command-2) - * [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command-2) + * [Put Document Command](#put-document-command-2) + * [Patch Document Command](#patch-document-command-2) + * [Delete Document Command](#delete-document-command-2) + * [Delete by Prefix Command](#delete-by-prefix-command-2) + * [Put Attachment Command](#put-attachment-command-2) + * [Delete Attachment Command](#delete-attachment-command-2) ### Put Document Command Request: diff --git a/docs/client-api/rest-api/document-commands/delete-document.mdx b/docs/client-api/rest-api/document-commands/delete-document.mdx index 9df47fbfac..d013e9fc31 100644 --- a/docs/client-api/rest-api/document-commands/delete-document.mdx +++ b/docs/client-api/rest-api/document-commands/delete-document.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//docs?id=` * In this page: - * [Example](../../../client-api/rest-api/document-commands/delete-document.mdx#example) - * [Request Format](../../../client-api/rest-api/document-commands/delete-document.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/delete-document.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/docs/client-api/rest-api/document-commands/get-all-documents.mdx b/docs/client-api/rest-api/document-commands/get-all-documents.mdx index 5ec24af7f1..8db55c1169 100644 --- a/docs/client-api/rest-api/document-commands/get-all-documents.mdx +++ b/docs/client-api/rest-api/document-commands/get-all-documents.mdx @@ -21,13 +21,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query parameters can be used to page the results. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-all-documents.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-all-documents.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-all-documents.mdx#response-format) - * [Query Parameter Examples](../../../client-api/rest-api/document-commands/get-all-documents.mdx#query-parameter-examples) - * [start](../../../client-api/rest-api/document-commands/get-all-documents.mdx#start) - * [pageSize](../../../client-api/rest-api/document-commands/get-all-documents.mdx#pagesize) - * [metadataOnly](../../../client-api/rest-api/document-commands/get-all-documents.mdx#metadataonly) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [Query Parameter Examples](#query-parameter-examples) + * [start](#start) + * [pageSize](#pagesize) + * [metadataOnly](#metadataonly) ## Basic Example @@ -190,9 +190,9 @@ Linebreaks are added for clarity. In this section: -* [start](../../../client-api/rest-api/document-commands/get-all-documents.mdx#start) -* [pageSize](../../../client-api/rest-api/document-commands/get-all-documents.mdx#pagesize) -* [metadataOnly](../../../client-api/rest-api/document-commands/get-all-documents.mdx#metadataonly) +* [start](#start) +* [pageSize](#pagesize) +* [metadataOnly](#metadataonly) ### start Skip first 1,057 documents, and retrieve the rest (our version of Northwind contains 1,059 documents). diff --git a/docs/client-api/rest-api/document-commands/get-documents-by-id.mdx b/docs/client-api/rest-api/document-commands/get-documents-by-id.mdx index f92c0cdc05..bcbcedc435 100644 --- a/docs/client-api/rest-api/document-commands/get-documents-by-id.mdx +++ b/docs/client-api/rest-api/document-commands/get-documents-by-id.mdx @@ -22,14 +22,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; [counters](../../../document-extensions/counters/overview.mdx). * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#more-examples) - * [Get Multiple Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-multiple-documents) - * [Get Related Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-related-documents) - * [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-metadata-only) - * [Get Document Counters](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-counters) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) + * [Get Multiple Documents](#get-multiple-documents) + * [Get Related Documents](#get-related-documents) + * [Get Document Metadata Only](#get-document-metadata-only) + * [Get Document Counters](#get-document-counters) ## Basic Example @@ -188,10 +188,10 @@ Linebreaks are added for clarity. In this section: -* [Get Multiple Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-multiple-documents) -* [Get Related Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-related-documents) -* [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-metadata-only) -* [Get Document Counters](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-counters) +* [Get Multiple Documents](#get-multiple-documents) +* [Get Related Documents](#get-related-documents) +* [Get Document Metadata Only](#get-document-metadata-only) +* [Get Document Counters](#get-document-counters) ### Get Multiple Documents Example cURL request: diff --git a/docs/client-api/rest-api/document-commands/get-documents-by-prefix.mdx b/docs/client-api/rest-api/document-commands/get-documents-by-prefix.mdx index 112a132198..def77066c5 100644 --- a/docs/client-api/rest-api/document-commands/get-documents-by-prefix.mdx +++ b/docs/client-api/rest-api/document-commands/get-documents-by-prefix.mdx @@ -21,15 +21,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query parameters can be used to filter and page the results. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#more-examples) - * [Get Using `matches`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using) - * [Get Using `matches` and `exclude`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-usingand) - * [Get Using `startAfter`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using-1) - * [Page Results](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#page-results) - * [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-document-metadata-only) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) + * [Get Using `matches`](#get-using) + * [Get Using `matches` and `exclude`](#get-usingand) + * [Get Using `startAfter`](#get-using-1) + * [Page Results](#page-results) + * [Get Document Metadata Only](#get-document-metadata-only) ## Basic Example @@ -192,11 +192,11 @@ Linebreaks are added for clarity. In this section: -* [Get Using `matches`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using) -* [Get Using `matches` and `exclude`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-usingand) -* [Get Using `startAfter`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using-1) -* [Page Results](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#page-results) -* [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-document-metadata-only) +* [Get Using `matches`](#get-using) +* [Get Using `matches` and `exclude`](#get-usingand) +* [Get Using `startAfter`](#get-using-1) +* [Page Results](#page-results) +* [Get Document Metadata Only](#get-document-metadata-only) ### Get Using `matches` cURL request: diff --git a/docs/client-api/rest-api/document-commands/put-documents.mdx b/docs/client-api/rest-api/document-commands/put-documents.mdx index 00727a6c6a..5f33fb9a70 100644 --- a/docs/client-api/rest-api/document-commands/put-documents.mdx +++ b/docs/client-api/rest-api/document-commands/put-documents.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//docs` * In this page: - * [Examples](../../../client-api/rest-api/document-commands/put-documents.mdx#examples) - * [Request Format](../../../client-api/rest-api/document-commands/put-documents.mdx#request-format) - * [Request Body](../../../client-api/rest-api/document-commands/put-documents.mdx#request-body) - * [Response Format](../../../client-api/rest-api/document-commands/put-documents.mdx#response-format) + * [Examples](#examples) + * [Request Format](#request-format) + * [Request Body](#request-body) + * [Response Format](#response-format) ## Examples diff --git a/docs/client-api/rest-api/queries/delete-by-query.mdx b/docs/client-api/rest-api/queries/delete-by-query.mdx index d0a935bcfe..656be6b5dc 100644 --- a/docs/client-api/rest-api/queries/delete-by-query.mdx +++ b/docs/client-api/rest-api/queries/delete-by-query.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//queries` * In this page: - * [Example](../../../client-api/rest-api/queries/delete-by-query.mdx#example) - * [Request Format](../../../client-api/rest-api/queries/delete-by-query.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/delete-by-query.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/docs/client-api/rest-api/queries/patch-by-query.mdx b/docs/client-api/rest-api/queries/patch-by-query.mdx index 907ae0faa9..a972c350e4 100644 --- a/docs/client-api/rest-api/queries/patch-by-query.mdx +++ b/docs/client-api/rest-api/queries/patch-by-query.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Patching](../../../client-api/operations/patching/set-based.mdx) occurs on the server side. * In this page: - * [Example](../../../client-api/rest-api/queries/patch-by-query.mdx#example) - * [Request Format](../../../client-api/rest-api/queries/patch-by-query.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/patch-by-query.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/docs/client-api/rest-api/queries/query-the-database.mdx b/docs/client-api/rest-api/queries/query-the-database.mdx index 3e48893b7e..f92f913db2 100644 --- a/docs/client-api/rest-api/queries/query-the-database.mdx +++ b/docs/client-api/rest-api/queries/query-the-database.mdx @@ -21,10 +21,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Queries are written in [RQL](../../../querying/rql/what-is-rql.mdx), our user friendly SQL-like query language. * In this page: - * [Basic Example](../../../client-api/rest-api/queries/query-the-database.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/queries/query-the-database.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/query-the-database.mdx#response-format) - * [More Examples](../../../client-api/rest-api/queries/query-the-database.mdx#more-examples) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) ## Basic Example @@ -238,7 +238,7 @@ you will probably need to escape all double quotes within the request body using | **IsStale** | Whether the results are [stale](../../../indexes/stale-indexes.mdx) | | **ResultEtag** | A hash of type `long` representing the results. When making another request identical to this one, this value can be sent in the `If-None-Match` header to check whether the results have been modified since this response. If not, the results will be retrieved from a local cache instead of from the server. | | **NodeTag** | The tag of the Cluster Node that responded to the query. Values are `A` to `Z`. See [Cluster Topology](../../../server/clustering/rachis/cluster-topology.mdx). | -| **Timings** | If [requested](../../../client-api/session/querying/debugging/query-timings.mdx), the duration of the query operation and each of its sub-stages. See the structure of the [`Timings` object](../../../client-api/rest-api/queries/query-the-database.mdx#the--object) and the [timings example](../../../client-api/rest-api/queries/query-the-database.mdx#get-timing-details) below. | +| **Timings** | If [requested](../../../client-api/session/querying/debugging/query-timings.mdx), the duration of the query operation and each of its sub-stages. See the structure of the [`Timings` object](#the--object) and the [timings example](#get-timing-details) below. | #### The `Timings` Object @@ -284,9 +284,9 @@ roughly add up to the duration of the parent stage because `DurationInMs` values In this section: -* [Include Related Documents](../../../client-api/rest-api/queries/query-the-database.mdx#include-related-documents) -* [Page Results](../../../client-api/rest-api/queries/query-the-database.mdx#page-results) -* [Get Timing Details](../../../client-api/rest-api/queries/query-the-database.mdx#get-timing-details) +* [Include Related Documents](#include-related-documents) +* [Page Results](#page-results) +* [Get Timing Details](#get-timing-details) ### Include Related Documents This query tells the server to include a [related document](../../../client-api/how-to/handle-document-relationships.mdx#includes). diff --git a/docs/client-api/rest-api/rest-api-intro.mdx b/docs/client-api/rest-api/rest-api-intro.mdx index bdb96e1446..a821bc16d0 100644 --- a/docs/client-api/rest-api/rest-api-intro.mdx +++ b/docs/client-api/rest-api/rest-api-intro.mdx @@ -25,10 +25,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [REST API Tutorial website](https://www.restapitutorial.com/) * In this page: - * [cURL Basics](../../client-api/rest-api/rest-api-intro.mdx#curl-basics) - * [Document Format and Structure](../../client-api/rest-api/rest-api-intro.mdx#document-format-and-structure) - * [Using cURL With HTTPS](../../client-api/rest-api/rest-api-intro.mdx#using-curl-with-https) - * [Common HTTP Status Codes](../../client-api/rest-api/rest-api-intro.mdx#common-http-status-codes) + * [cURL Basics](#curl-basics) + * [Document Format and Structure](#document-format-and-structure) + * [Using cURL With HTTPS](#using-curl-with-https) + * [Common HTTP Status Codes](#common-http-status-codes) ## cURL Basics diff --git a/docs/client-api/security/content/_deserialization-security-csharp.mdx b/docs/client-api/security/content/_deserialization-security-csharp.mdx index c58238e8be..8f10cb0ce4 100644 --- a/docs/client-api/security/content/_deserialization-security-csharp.mdx +++ b/docs/client-api/security/content/_deserialization-security-csharp.mdx @@ -15,14 +15,14 @@ import ContentFrame from "@site/src/components/ContentFrame"; is forbidden or allowed. * In this article: - * [Securing deserialization](../../../client-api/security/deserialization-security.mdx#securing-deserialization) - * [The deserialization risk](../../../client-api/security/deserialization-security.mdx#the-deserialization-risk) - * [Direct vs. indirect gadget loading](../../../client-api/security/deserialization-security.mdx#direct-vs-indirect-gadget-loading) - * [DefaultRavenSerializationBinder](../../../client-api/security/deserialization-security.mdx#defaultravenserializationbinder) - * [RegisterForbiddenNamespace](../../../client-api/security/deserialization-security.mdx#registerforbiddennamespace) - * [RegisterForbiddenType](../../../client-api/security/deserialization-security.mdx#registerforbiddentype) - * [RegisterSafeType](../../../client-api/security/deserialization-security.mdx#registersafetype) - * [Example](../../../client-api/security/deserialization-security.mdx#example) + * [Securing deserialization](#securing-deserialization) + * [The deserialization risk](#the-deserialization-risk) + * [Direct vs. indirect gadget loading](#direct-vs-indirect-gadget-loading) + * [DefaultRavenSerializationBinder](#defaultravenserializationbinder) + * [RegisterForbiddenNamespace](#registerforbiddennamespace) + * [RegisterForbiddenType](#registerforbiddentype) + * [RegisterSafeType](#registersafetype) + * [Example](#example) @@ -52,7 +52,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; - `System.Xml.XmlDataDocument` - `System.Management.Automation.PSObject` -* Users can [customize](../../../client-api/security/deserialization-security.mdx#defaultravenserializationbinder) +* Users can [customize](#defaultravenserializationbinder) the list of namespaces and types for which deserialization is forbidden or allowed. @@ -115,7 +115,7 @@ trusted types. Create a new `DefaultRavenSerializationBinder` instance, call the registration methods to define your overrides, then configure the instance as a serialization -convention as shown in the [example](../../../client-api/security/deserialization-security.mdx#example). +convention as shown in the [example](#example). diff --git a/docs/client-api/session/cluster-transaction/content/_overview-csharp.mdx b/docs/client-api/session/cluster-transaction/content/_overview-csharp.mdx index 6a8e5b82cb..97d97cd956 100644 --- a/docs/client-api/session/cluster-transaction/content/_overview-csharp.mdx +++ b/docs/client-api/session/cluster-transaction/content/_overview-csharp.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) diff --git a/docs/client-api/session/cluster-transaction/content/_overview-nodejs.mdx b/docs/client-api/session/cluster-transaction/content/_overview-nodejs.mdx index 2c07f03196..ef87b077e9 100644 --- a/docs/client-api/session/cluster-transaction/content/_overview-nodejs.mdx +++ b/docs/client-api/session/cluster-transaction/content/_overview-nodejs.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/docs/client-api/session/cluster-transaction/content/_overview-php.mdx b/docs/client-api/session/cluster-transaction/content/_overview-php.mdx index adeb6704e2..01473e5a43 100644 --- a/docs/client-api/session/cluster-transaction/content/_overview-php.mdx +++ b/docs/client-api/session/cluster-transaction/content/_overview-php.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/docs/client-api/session/cluster-transaction/content/_overview-python.mdx b/docs/client-api/session/cluster-transaction/content/_overview-python.mdx index 67cf8d5cd4..f99f334302 100644 --- a/docs/client-api/session/cluster-transaction/content/_overview-python.mdx +++ b/docs/client-api/session/cluster-transaction/content/_overview-python.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **CLUSTER-WIDE** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/docs/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx b/docs/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx index eedeb68d66..9c1772cfd7 100644 --- a/docs/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx +++ b/docs/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx @@ -14,12 +14,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) - * [Using 'Include' in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-include-in-a-notracking-session-will-throw) - * [Using optimistic concurrency modes in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-optimistic-concurrency-modes-in-a-notracking-session-will-throw) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) + * [Using 'Include' in a NoTracking session will throw](#using-include-in-a-notracking-session-will-throw) + * [Using optimistic concurrency modes in a NoTracking session will throw](#using-optimistic-concurrency-modes-in-a-notracking-session-will-throw) diff --git a/docs/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx b/docs/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx index 0925884aa0..5ecf54f934 100644 --- a/docs/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx +++ b/docs/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) - * [Using 'Include' in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) + * [Using 'Include' in a NoTracking session will throw](#using-) ## Disable tracking changes for a specific entity diff --git a/docs/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx b/docs/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx index c8d3939362..934c521f87 100644 --- a/docs/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx +++ b/docs/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) ## Disable tracking changes for a specific entity diff --git a/docs/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx b/docs/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx index db84155333..71fb1799ae 100644 --- a/docs/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx +++ b/docs/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) ## Disable tracking changes for a specific entity @@ -120,7 +120,7 @@ session.save_changes() * You can further customize and fine-tune which entities will not be tracked by configuring the `should_ignore_entity_changes` convention method on the document store. * This customization rule will apply to all sessions opened for this document store. -* Implement rules under your [ShouldIgnoreEntityChanges](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#syntax) subclass. +* Implement rules under your [ShouldIgnoreEntityChanges](#syntax) subclass. Apply the class's `check` method to control the ignore flow. **Example**: diff --git a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx index 20fd7c0403..c36983d35d 100644 --- a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx +++ b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx @@ -16,7 +16,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Enabling optimistic concurrency ensures RavenDB detects and prevents conflicting updates, preserving data integrity by rejecting changes when a document has been modified by another session. -* RavenDB supports three [modes of optimistic concurrency](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#optimistic-concurrency-modes), +* RavenDB supports three [modes of optimistic concurrency](#optimistic-concurrency-modes), allowing you to choose a level of conflict validation that suits your application. * The optimistic concurrency mode can be configured at different scopes: @@ -27,17 +27,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; --- * In this article: - * [Optimistic concurrency - Overview](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#optimistic-concurrency-overview) - * [Default concurrency behavior with single-node transactions](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#default-concurrency-behavior-with-single-node-transactions) - * [Optimistic concurrency with single-node transactions](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#optimistic-concurrency-with-single-node-transactions) - * [Concurrency control in cluster-wide transactions](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#concurrency-control-in-cluster-wide-transactions) - * [Optimistic concurrency - Modes](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#optimistic-concurrency-modes) - * [Configure globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#configure-globally) - * [Configure per session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#configure-per-session) - * [Disable for specific document (when enabled on the session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-when-enabled-on-session) - * [Enable for specific document (when disabled on the session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-when-disabled-on-session) - * [Constraints](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#constraints) - * [Syntax](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#syntax) + * [Optimistic concurrency - Overview](#optimistic-concurrency-overview) + * [Default concurrency behavior with single-node transactions](#default-concurrency-behavior-with-single-node-transactions) + * [Optimistic concurrency with single-node transactions](#optimistic-concurrency-with-single-node-transactions) + * [Concurrency control in cluster-wide transactions](#concurrency-control-in-cluster-wide-transactions) + * [Optimistic concurrency - Modes](#optimistic-concurrency-modes) + * [Configure globally](#configure-globally) + * [Configure per session](#configure-per-session) + * [Disable for specific document (when enabled on the session)](#disable-for-specific-document-when-enabled-on-session) + * [Enable for specific document (when disabled on the session)](#enable-for-specific-document-when-disabled-on-session) + * [Constraints](#constraints) + * [Syntax](#syntax) @@ -115,7 +115,7 @@ sessions operating with single-node transactions can enable optimistic concurren * **Optimistic concurrency modes**: Optimistic concurrency can be configured to validate only modified documents or both modified and read-only documents. - Learn more in the [Optimistic concurrency modes](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#optimistic-concurrency-modes) section below. + Learn more in the [Optimistic concurrency modes](#optimistic-concurrency-modes) section below. @@ -220,7 +220,7 @@ Use this mode in scenarios where: * Use the [store.Conventions.OptimisticConcurrencyMode](../../../../client-api/configuration/conventions.mdx#optimisticconcurrencymode) convention to set the default optimistic concurrency mode for ALL sessions created under the same document store. -* You can override this setting for individual sessions if needed. See [Configure per session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#configure-per-session) for more details. +* You can override this setting for individual sessions if needed. See [Configure per session](#configure-per-session) for more details. ```csharp @@ -657,9 +657,9 @@ using (IAsyncDocumentSession asyncSession = store.OpenAsyncSession()) -* [Cannot combine _Writes_ and _WritesAndReads_ with _NoTracking_](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#cannot-combinewritesandwritesandreadswithnotracking). -* [Cannot combine _Writes_ and _WritesAndReads_ with _TransactionMode.ClusterWide_](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#cannot-combineewritesandwritesandreadswithtransactionmodeclusterwide). -* [_UseOptimisticConcurrency_ is deprecated](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#useoptimisticconcurrencyis-deprecated). +* [Cannot combine _Writes_ and _WritesAndReads_ with _NoTracking_](#cannot-combinewritesandwritesandreadswithnotracking). +* [Cannot combine _Writes_ and _WritesAndReads_ with _TransactionMode.ClusterWide_](#cannot-combineewritesandwritesandreadswithtransactionmodeclusterwide). +* [_UseOptimisticConcurrency_ is deprecated](#useoptimisticconcurrencyis-deprecated). * _WritesAndReads_ mode is not supported with [Sharding](../../../../sharding/overview.mdx). --- diff --git a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx index 11fd121412..718367eed4 100644 --- a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx +++ b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx index 1d1629bf3e..41acae09a9 100644 --- a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx +++ b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx index 672387bb93..6df246bba5 100644 --- a/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx +++ b/docs/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/docs/client-api/session/content/_loading-entities-csharp.mdx b/docs/client-api/session/content/_loading-entities-csharp.mdx index 3879668c54..9373203131 100644 --- a/docs/client-api/session/content/_loading-entities-csharp.mdx +++ b/docs/client-api/session/content/_loading-entities-csharp.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [Load](../../../client-api/session/loading-entities.mdx#load) - - [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) - - [Stream](../../../client-api/session/loading-entities.mdx#stream) - - [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) + - [Load](#load) + - [Load with Includes](#load-with-includes) + - [Load - multiple entities](#load---multiple-entities) + - [LoadStartingWith](#loadstartingwith) + - [ConditionalLoad](#conditionalload) + - [Stream](#stream) + - [IsLoaded](#isloaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/docs/client-api/session/content/_loading-entities-java.mdx b/docs/client-api/session/content/_loading-entities-java.mdx index 95ebeba1f7..2c8ba5337d 100644 --- a/docs/client-api/session/content/_loading-entities-java.mdx +++ b/docs/client-api/session/content/_loading-entities-java.mdx @@ -9,13 +9,13 @@ There are several methods with many overloads that allow users to download docum from the database and convert them to entities. This article will cover the following methods: -- [Load](../../../client-api/session/loading-entities.mdx#load) -- [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) -- [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) -- [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) -- [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) -- [Stream](../../../client-api/session/loading-entities.mdx#stream) -- [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) +- [Load](#load) +- [Load with Includes](#load-with-includes) +- [Load - multiple entities](#load---multiple-entities) +- [LoadStartingWith](#loadstartingwith) +- [ConditionalLoad](#conditionalload) +- [Stream](#stream) +- [IsLoaded](#isloaded) ## Load diff --git a/docs/client-api/session/content/_loading-entities-nodejs.mdx b/docs/client-api/session/content/_loading-entities-nodejs.mdx index 4165150126..e8b6ae1c1f 100644 --- a/docs/client-api/session/content/_loading-entities-nodejs.mdx +++ b/docs/client-api/session/content/_loading-entities-nodejs.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [Load](../../../client-api/session/loading-entities.mdx#load) - - [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) - - [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) - - [Stream](../../../client-api/session/loading-entities.mdx#stream) + - [Load](#load) + - [Load with Includes](#load-with-includes) + - [Load - multiple entities](#load---multiple-entities) + - [LoadStartingWith](#loadstartingwith) + - [ConditionalLoad](#conditionalload) + - [IsLoaded](#isloaded) + - [Stream](#stream) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/docs/client-api/session/content/_loading-entities-php.mdx b/docs/client-api/session/content/_loading-entities-php.mdx index 2b9604d565..c2bf11f496 100644 --- a/docs/client-api/session/content/_loading-entities-php.mdx +++ b/docs/client-api/session/content/_loading-entities-php.mdx @@ -9,12 +9,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [`load`](../../../client-api/session/loading-entities.mdx#load) - - [`load` with `include`](../../../client-api/session/loading-entities.mdx#load-with-include) - - [`load` - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [`loadStartingWith`](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [`conditionalLoad`](../../../client-api/session/loading-entities.mdx#conditionalload) - - [`isLoaded`](../../../client-api/session/loading-entities.mdx#isloaded) + - [`load`](#load) + - [`load` with `include`](#load-with-include) + - [`load` - multiple entities](#load---multiple-entities) + - [`loadStartingWith`](#loadstartingwith) + - [`conditionalLoad`](#conditionalload) + - [`isLoaded`](#isloaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/docs/client-api/session/content/_loading-entities-python.mdx b/docs/client-api/session/content/_loading-entities-python.mdx index dbdeb6b735..ff86b594da 100644 --- a/docs/client-api/session/content/_loading-entities-python.mdx +++ b/docs/client-api/session/content/_loading-entities-python.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [load](../../../client-api/session/loading-entities.mdx#load) - - [load with includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [load_starting_with](../../../client-api/session/loading-entities.mdx#load_starting_with) - - [load_starting_with_into_stream](../../../client-api/session/loading-entities.mdx#load_starting_with_into_stream) - - [conditional_load](../../../client-api/session/loading-entities.mdx#conditional_load) - - [stream](../../../client-api/session/loading-entities.mdx#stream) - - [is_loaded](../../../client-api/session/loading-entities.mdx#is_loaded) + - [load](#load) + - [load with includes](#load-with-includes) + - [load_starting_with](#load_starting_with) + - [load_starting_with_into_stream](#load_starting_with_into_stream) + - [conditional_load](#conditional_load) + - [stream](#stream) + - [is_loaded](#is_loaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/docs/client-api/session/content/_opening-a-session-csharp.mdx b/docs/client-api/session/content/_opening-a-session-csharp.mdx index 166f5dc1a5..ac803685d0 100644 --- a/docs/client-api/session/content/_opening-a-session-csharp.mdx +++ b/docs/client-api/session/content/_opening-a-session-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; * Be sure to wrap the Session variable with a 'using' statement to ensure proper disposal. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -58,7 +58,7 @@ IAsyncDocumentSession OpenAsyncSession(SessionOptions options); | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `string` | The Session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------------------------|-------------------------------| diff --git a/docs/client-api/session/content/_opening-a-session-nodejs.mdx b/docs/client-api/session/content/_opening-a-session-nodejs.mdx index 7e9558b021..abfdc51aaa 100644 --- a/docs/client-api/session/content/_opening-a-session-nodejs.mdx +++ b/docs/client-api/session/content/_opening-a-session-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Refer to the specific documentation for each method usage. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -38,7 +38,7 @@ openSession(sessionOptions); | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | string | The session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with session configuration options. See details [below](#session-options). | | Return Value | Description | |---------------------|--------------------------------| diff --git a/docs/client-api/session/content/_opening-a-session-php.mdx b/docs/client-api/session/content/_opening-a-session-php.mdx index febd875910..6c39e3fb8d 100644 --- a/docs/client-api/session/content/_opening-a-session-php.mdx +++ b/docs/client-api/session/content/_opening-a-session-php.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; If no database is specified in the options then the [Default Database](../../../client-api/setting-up-default-database.mdx) (stored in the Document Store) is assumed. * Make sure you release allocated session resources using the `close` method or wrapping - the session object in a `try` statement ([see below](../../../client-api/session/opening-a-session.mdx#example-3---releasing-session-resources)). + the session object in a `try` statement ([see below](#example-3---releasing-session-resources)). * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session examples](../../../client-api/session/opening-a-session.mdx#open-session-examples) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session examples](#open-session-examples) ## Syntax @@ -41,7 +41,7 @@ public function openSession(SessionOptions $sessionOptions): DocumentSessionInte | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `string` | The Session will operate on this database,
overriding the default database set in the document store. | -| **options** | `sessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `sessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------|----------------------------| diff --git a/docs/client-api/session/content/_opening-a-session-python.mdx b/docs/client-api/session/content/_opening-a-session-python.mdx index 3ec2cf2384..60da6443be 100644 --- a/docs/client-api/session/content/_opening-a-session-python.mdx +++ b/docs/client-api/session/content/_opening-a-session-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * Be sure to wrap the session variable using a 'with' statement to ensure proper disposal. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -38,7 +38,7 @@ def open_session( | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `str` | The session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------------------------|-------------------------------| diff --git a/docs/client-api/session/content/_updating-entities-csharp.mdx b/docs/client-api/session/content/_updating-entities-csharp.mdx index 2de441898f..404b1b2a4b 100644 --- a/docs/client-api/session/content/_updating-entities-csharp.mdx +++ b/docs/client-api/session/content/_updating-entities-csharp.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/docs/client-api/session/content/_updating-entities-nodejs.mdx b/docs/client-api/session/content/_updating-entities-nodejs.mdx index 7d90552c13..74be9c3a7f 100644 --- a/docs/client-api/session/content/_updating-entities-nodejs.mdx +++ b/docs/client-api/session/content/_updating-entities-nodejs.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/docs/client-api/session/content/_updating-entities-php.mdx b/docs/client-api/session/content/_updating-entities-php.mdx index 6e4a9a0284..2b00843a05 100644 --- a/docs/client-api/session/content/_updating-entities-php.mdx +++ b/docs/client-api/session/content/_updating-entities-php.mdx @@ -20,8 +20,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/docs/client-api/session/content/_updating-entities-python.mdx b/docs/client-api/session/content/_updating-entities-python.mdx index cf4f6347cf..7a42fc7c41 100644 --- a/docs/client-api/session/content/_updating-entities-python.mdx +++ b/docs/client-api/session/content/_updating-entities-python.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx index e22b784a5d..e63eaec75c 100644 --- a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx +++ b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx @@ -11,18 +11,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; is the primary interface your application will interact with. * In this article: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) - * [Reducing server calls (best practices)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-best-practices) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) + * [Reducing server calls (best practices)](#reducing-server-calls-best-practices) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) diff --git a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx index 2274063575..e4d3a6cfd5 100644 --- a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx +++ b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx index 542cee1b06..23798bf728 100644 --- a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx +++ b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx index d129128338..a382607a0c 100644 --- a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx +++ b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx index 0c129d5dec..ab0c69be2a 100644 --- a/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx +++ b/docs/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/docs/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx b/docs/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx index 1d2fdc9a35..14639ac3b6 100644 --- a/docs/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx +++ b/docs/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/docs/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx b/docs/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx index 62554f42ff..c863fb54ed 100644 --- a/docs/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx +++ b/docs/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx @@ -12,8 +12,8 @@ operations. from the server, and does not cause the session to track the document. * In this page: - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) - * [Example](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#example) + * [Syntax](#syntax) + * [Example](#example) ## Syntax diff --git a/docs/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx b/docs/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx index b49bb903ca..12ca96c51c 100644 --- a/docs/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/docs/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx b/docs/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx index 243e5326b6..f08e27c686 100644 --- a/docs/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx +++ b/docs/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document or the attachment to the session, and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/docs/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx b/docs/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx index 001acc290d..b5b57e65f8 100644 --- a/docs/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx +++ b/docs/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document or the attachment to the session, and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/docs/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx b/docs/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx index f33892d369..83617e9a73 100644 --- a/docs/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx +++ b/docs/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/docs/client-api/session/how-to/content/_check-if-document-exists-java.mdx b/docs/client-api/session/how-to/content/_check-if-document-exists-java.mdx index a69c605d03..72044a1f0d 100644 --- a/docs/client-api/session/how-to/content/_check-if-document-exists-java.mdx +++ b/docs/client-api/session/how-to/content/_check-if-document-exists-java.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * This does not [load](../../../../client-api/session/loading-entities.mdx) the document from the server or cause the session to track it. * In this page: - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) - * [Example](../../../../client-api/session/how-to/check-if-document-exists.mdx#example) + * [Syntax](#syntax) + * [Example](#example) ## Syntax diff --git a/docs/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx b/docs/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx index 63ca8a5abf..2684b10001 100644 --- a/docs/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/docs/client-api/session/how-to/content/_check-if-document-exists-php.mdx b/docs/client-api/session/how-to/content/_check-if-document-exists-php.mdx index a5ccc2944b..4bfb1279c7 100644 --- a/docs/client-api/session/how-to/content/_check-if-document-exists-php.mdx +++ b/docs/client-api/session/how-to/content/_check-if-document-exists-php.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document entity to the session, and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/docs/client-api/session/how-to/content/_check-if-document-exists-python.mdx b/docs/client-api/session/how-to/content/_check-if-document-exists-python.mdx index daf2cca619..c0b40978bf 100644 --- a/docs/client-api/session/how-to/content/_check-if-document-exists-python.mdx +++ b/docs/client-api/session/how-to/content/_check-if-document-exists-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document entity to the session, and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx index ecde7a2667..6842390fad 100644 --- a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx +++ b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx index ce1ce8b0b4..9924dfd784 100644 --- a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx index 7d03bc04ae..3d1a89d402 100644 --- a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx +++ b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes on all tracked entities, see [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx index 4e957b7fad..2a68ef132d 100644 --- a/docs/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx +++ b/docs/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes to **all** tracked entities, see [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx index e949c38a74..1a83e39801 100644 --- a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx +++ b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx index 7241697279..453dcd5c91 100644 --- a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx index a75bf55fec..2a0f051e1c 100644 --- a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx +++ b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes on a specific **entity**, see [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx index 9eb9e1ee14..093e3e94ca 100644 --- a/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx +++ b/docs/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes to a specific **entity**, see [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/docs/client-api/session/how-to/content/_clear-a-session-csharp.mdx b/docs/client-api/session/how-to/content/_clear-a-session-csharp.mdx index 2e7ee57764..5924ce12f4 100644 --- a/docs/client-api/session/how-to/content/_clear-a-session-csharp.mdx +++ b/docs/client-api/session/how-to/content/_clear-a-session-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * To remove only a **single entity** from tracking, see [Evict a single entity](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx). * In this article: - * [Clear the session's state](../../../../client-api/session/how-to/clear-a-session.mdx#clear-the-sessions-state) - * [Syntax](../../../../client-api/session/how-to/clear-a-session.mdx#syntax) + * [Clear the session's state](#clear-the-sessions-state) + * [Syntax](#syntax) diff --git a/docs/client-api/session/how-to/content/_clear-a-session-nodejs.mdx b/docs/client-api/session/how-to/content/_clear-a-session-nodejs.mdx index 464c6e53ff..4e587e5706 100644 --- a/docs/client-api/session/how-to/content/_clear-a-session-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_clear-a-session-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * To remove only a **single entity** from tracking, see [Evict a single entity](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx). * In this article: - * [Clear the session's state](../../../../client-api/session/how-to/clear-a-session.mdx#clear-the-sessions-state) - * [Syntax](../../../../client-api/session/how-to/clear-a-session.mdx#syntax) + * [Clear the session's state](#clear-the-sessions-state) + * [Syntax](#syntax) diff --git a/docs/client-api/session/how-to/content/_defer-operations-csharp.mdx b/docs/client-api/session/how-to/content/_defer-operations-csharp.mdx index 9229817f2a..81ef9747f4 100644 --- a/docs/client-api/session/how-to/content/_defer-operations-csharp.mdx +++ b/docs/client-api/session/how-to/content/_defer-operations-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are __executed as part of the session's SaveChanges transaction__. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/docs/client-api/session/how-to/content/_defer-operations-nodejs.mdx b/docs/client-api/session/how-to/content/_defer-operations-nodejs.mdx index 70a1a0963d..bd58180f8a 100644 --- a/docs/client-api/session/how-to/content/_defer-operations-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_defer-operations-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are __executed as part of the session's saveChanges transaction__. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/docs/client-api/session/how-to/content/_defer-operations-php.mdx b/docs/client-api/session/how-to/content/_defer-operations-php.mdx index 70997e97f5..16599c75d7 100644 --- a/docs/client-api/session/how-to/content/_defer-operations-php.mdx +++ b/docs/client-api/session/how-to/content/_defer-operations-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are **executed as part of the session's `saveChanges` transaction**. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/docs/client-api/session/how-to/content/_defer-operations-python.mdx b/docs/client-api/session/how-to/content/_defer-operations-python.mdx index 5810a03d23..2b53557d01 100644 --- a/docs/client-api/session/how-to/content/_defer-operations-python.mdx +++ b/docs/client-api/session/how-to/content/_defer-operations-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are **executed as part of the session's `save_changes` transaction**. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/docs/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx b/docs/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx index 2e18238d01..520620848e 100644 --- a/docs/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx +++ b/docs/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx @@ -17,11 +17,11 @@ import CodeBlock from '@theme/CodeBlock'; To prevent an entity from being tracked, see [DisableTracking](../../../../client-api/session/configuration/how-to-disable-tracking.mdx). * In this article: - * [Evict an entity before saving](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-before-saving) - * [Evict an entity to force reload from server](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-to-force-reload-from-server) - * [Evict an entity from the session's delete queue](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-from-the-sessions-delete-queue) - * [Limitations](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#limitations) - * [Syntax](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#syntax) + * [Evict an entity before saving](#evict-an-entity-before-saving) + * [Evict an entity to force reload from server](#evict-an-entity-to-force-reload-from-server) + * [Evict an entity from the session's delete queue](#evict-an-entity-from-the-sessions-delete-queue) + * [Limitations](#limitations) + * [Syntax](#syntax) diff --git a/docs/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx b/docs/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx index 9e73f3bd99..30f9b4b3b8 100644 --- a/docs/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx @@ -17,11 +17,11 @@ import CodeBlock from '@theme/CodeBlock'; To prevent an entity from being tracked, see [DisableTracking](../../../../client-api/session/configuration/how-to-disable-tracking.mdx). * In this article: - * [Evict an entity before saving](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-before-saving) - * [Evict an entity to force reload from server](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-to-force-reload-from-server) - * [Evict an entity from the session's delete queue](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-from-the-sessions-delete-queue) - * [Limitations](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#limitations) - * [Syntax](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#syntax) + * [Evict an entity before saving](#evict-an-entity-before-saving) + * [Evict an entity to force reload from server](#evict-an-entity-to-force-reload-from-server) + * [Evict an entity from the session's delete queue](#evict-an-entity-from-the-sessions-delete-queue) + * [Limitations](#limitations) + * [Syntax](#syntax) diff --git a/docs/client-api/session/how-to/content/_get-entity-counters-csharp.mdx b/docs/client-api/session/how-to/content/_get-entity-counters-csharp.mdx index 9af6bc0334..3b75188557 100644 --- a/docs/client-api/session/how-to/content/_get-entity-counters-csharp.mdx +++ b/docs/client-api/session/how-to/content/_get-entity-counters-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; The counter names are available for each entity using the `GetCountersFor()` method from the `Advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/docs/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx b/docs/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx index 9738d3119d..70e6455d78 100644 --- a/docs/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; The counter names are available for each entity using the `getCountersFor()` method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/docs/client-api/session/how-to/content/_get-entity-counters-php.mdx b/docs/client-api/session/how-to/content/_get-entity-counters-php.mdx index 9cc3089246..358febe537 100644 --- a/docs/client-api/session/how-to/content/_get-entity-counters-php.mdx +++ b/docs/client-api/session/how-to/content/_get-entity-counters-php.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/docs/client-api/session/how-to/content/_get-entity-counters-python.mdx b/docs/client-api/session/how-to/content/_get-entity-counters-python.mdx index f6466a011f..8d5ce95f97 100644 --- a/docs/client-api/session/how-to/content/_get-entity-counters-python.mdx +++ b/docs/client-api/session/how-to/content/_get-entity-counters-python.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/docs/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx b/docs/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx index 3df1d61e83..34d6d5b7aa 100644 --- a/docs/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx +++ b/docs/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes). * In this page: - * [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx#get-tracked-entities) - * [Syntax](../../../../client-api/session/how-to/get-tracked-entities.mdx#syntax) + * [Get tracked entities](#get-tracked-entities) + * [Syntax](#syntax) ## Get tracked entities diff --git a/docs/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx b/docs/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx index a1441b1309..169e1347c7 100644 --- a/docs/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes). * In this page: - * [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx#get-tracked-entities) - * [Syntax](../../../../client-api/session/how-to/get-tracked-entities.mdx#syntax) + * [Get tracked entities](#get-tracked-entities) + * [Syntax](#syntax) ## Get tracked entities diff --git a/docs/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx b/docs/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx index 753b055695..c672be0a58 100644 --- a/docs/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx +++ b/docs/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/docs/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx b/docs/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx index 2e70534a58..7806e36d92 100644 --- a/docs/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily:](../../../../client-api/session/how-to/perform-operations-lazily.mdx#requests-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadentities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadwithinclude) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadstartingwith) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditionalload) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#runquery) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#getcompareexchange) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#implicit) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#explicit) + * [Requests that can be executed lazily:](#requests-that-can-be-executed-lazily) + * [Load entities](#loadentities) + * [Load entities with include](#loadwithinclude) + * [Load entities starting with](#loadstartingwith) + * [Conditional load](#conditionalload) + * [Run query](#runquery) + * [Get revisions](#getrevisions) + * [Get compare-exchange value](#getcompareexchange) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#implicit) + * [Execute all requests - explicitly](#explicit) ## Operations that can be executed lazily diff --git a/docs/client-api/session/how-to/content/_perform-operations-lazily-php.mdx b/docs/client-api/session/how-to/content/_perform-operations-lazily-php.mdx index b05433dee0..97955a4976 100644 --- a/docs/client-api/session/how-to/content/_perform-operations-lazily-php.mdx +++ b/docs/client-api/session/how-to/content/_perform-operations-lazily-php.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/docs/client-api/session/how-to/content/_perform-operations-lazily-python.mdx b/docs/client-api/session/how-to/content/_perform-operations-lazily-python.mdx index 7e299c1887..bb68bfc531 100644 --- a/docs/client-api/session/how-to/content/_perform-operations-lazily-python.mdx +++ b/docs/client-api/session/how-to/content/_perform-operations-lazily-python.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/docs/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx b/docs/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx index 2dc6c754ed..9fdda9722d 100644 --- a/docs/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx +++ b/docs/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx @@ -19,18 +19,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [OnBeforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforestore) - * [OnBeforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforedelete) - * [OnAfterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#onaftersavechanges) - * [OnBeforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforequery) - * [OnBeforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforeconversiontodocument) - * [OnAfterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#onafterconversiontodocument) - * [OnBeforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforeconversiontoentity) - * [OnAfterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#onafterconversiontoentity) - * [OnSessionDisposing](../../../../client-api/session/how-to/subscribe-to-events.mdx#onsessiondisposing) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [OnBeforeStore](#onbeforestore) + * [OnBeforeDelete](#onbeforedelete) + * [OnAfterSaveChanges](#onaftersavechanges) + * [OnBeforeQuery](#onbeforequery) + * [OnBeforeConversionToDocument](#onbeforeconversiontodocument) + * [OnAfterConversionToDocument](#onafterconversiontodocument) + * [OnBeforeConversionToEntity](#onbeforeconversiontoentity) + * [OnAfterConversionToEntity](#onafterconversiontoentity) + * [OnSessionDisposing](#onsessiondisposing) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/docs/client-api/session/how-to/content/_subscribe-to-events-java.mdx b/docs/client-api/session/how-to/content/_subscribe-to-events-java.mdx index 3f87a301f7..0c96db83fb 100644 --- a/docs/client-api/session/how-to/content/_subscribe-to-events-java.mdx +++ b/docs/client-api/session/how-to/content/_subscribe-to-events-java.mdx @@ -20,17 +20,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [beforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforestore) - * [beforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforedelete) - * [afterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#aftersavechanges) - * [beforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforequery) - * [beforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontodocument) - * [afterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontodocument) - * [beforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontoentity) - * [afterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontoentity) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [beforeStore](#beforestore) + * [beforeDelete](#beforedelete) + * [afterSaveChanges](#aftersavechanges) + * [beforeQuery](#beforequery) + * [beforeConversionToDocument](#beforeconversiontodocument) + * [afterConversionToDocument](#afterconversiontodocument) + * [beforeConversionToEntity](#beforeconversiontoentity) + * [afterConversionToEntity](#afterconversiontoentity) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/docs/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx b/docs/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx index 952ab70fa8..49883a3e6f 100644 --- a/docs/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx +++ b/docs/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx @@ -20,17 +20,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [beforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforestore) - * [beforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforedelete) - * [afterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#aftersavechanges) - * [beforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforequery) - * [beforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontodocument) - * [afterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontodocument) - * [beforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontoentity) - * [afterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontoentity) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [beforeStore](#beforestore) + * [beforeDelete](#beforedelete) + * [afterSaveChanges](#aftersavechanges) + * [beforeQuery](#beforequery) + * [beforeConversionToDocument](#beforeconversiontodocument) + * [afterConversionToDocument](#afterconversiontodocument) + * [beforeConversionToEntity](#beforeconversiontoentity) + * [afterConversionToEntity](#afterconversiontoentity) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/docs/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx b/docs/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx index f2faf6fd5d..16348e4aa3 100644 --- a/docs/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx @@ -7,11 +7,11 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [Count](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) + * [Count](#count) - * [LongCount](../../../../client-api/session/querying/how-to-count-query-results.mdx#longcount) + * [LongCount](#longcount) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [Get number of results from query stats](#get-count-from-query-stats) ## Count diff --git a/docs/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx index 7793fc996c..7e90880b81 100644 --- a/docs/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx @@ -7,9 +7,9 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [Count](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) + * [Count](#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [Get number of results from query stats](#get-count-from-query-stats) ## Count diff --git a/docs/client-api/session/querying/content/_how-to-count-query-results-php.mdx b/docs/client-api/session/querying/content/_how-to-count-query-results-php.mdx index 330d80edfa..59055d3cc6 100644 --- a/docs/client-api/session/querying/content/_how-to-count-query-results-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-count-query-results-php.mdx @@ -7,8 +7,8 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [`Count`](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [`Count`](#count) + * [Get number of results from query stats](#get-count-from-query-stats) ## `Count` diff --git a/docs/client-api/session/querying/content/_how-to-count-query-results-python.mdx b/docs/client-api/session/querying/content/_how-to-count-query-results-python.mdx index 9a77265c1b..be71f3c103 100644 --- a/docs/client-api/session/querying/content/_how-to-count-query-results-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-count-query-results-python.mdx @@ -7,8 +7,8 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [`count`](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [`count`](#count) + * [Get number of results from query stats](#get-count-from-query-stats) ## `count` diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx index f6dd752a57..d2bdc30adb 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-field-java.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-field-java.mdx index 7d396fc851..eb22da8de1 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-field-java.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-field-java.mdx @@ -11,8 +11,8 @@ from the [Document Query](../../../../querying/document-query/what-is-document-q * If a document doesn't contain the specified field, it is excluded from the query results. * In this page: - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) - * [Examples](../../../../client-api/session/querying/how-to-filter-by-field.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx index 984ca5bf62..ee662878cd 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-field-php.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-field-php.mdx index 84bd60c3ad..c6b6de4cc7 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-field-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-field-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-field-python.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-field-python.mdx index 89729711e3..9bddd102f9 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-field-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-field-python.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; Documents that do not contain the specified field will be excluded from the query results. * In this page: - * [Filter by Field Name or Path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name-or-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) - * [Examples](../../../../client-api/session/querying/how-to-filter-by-field.mdx#examples) + * [Filter by Field Name or Path](#filter-by-field-name-or-path) + * [Syntax](#syntax) + * [Examples](#examples) ## Filter by Field Name or Path diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx index 6b863b91a6..b9d361e10c 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx index fc6a6d53c8..fb0e16b88c 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx index d892011093..6a2140d83e 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * There are situations where new fields are added to some documents in a collection over time. * To find documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx index abfcbf31ab..47a4ea9a94 100644 --- a/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/docs/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx b/docs/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx index 806d3cfcc5..d61fb1f6a1 100644 --- a/docs/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx @@ -20,8 +20,8 @@ import Panel from '@site/src/components/Panel'; In such cases, the resulting `QueryStatistics` object will remain with its default values. * In this article: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) diff --git a/docs/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx index d45633a999..31d7888a69 100644 --- a/docs/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/docs/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx b/docs/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx index 655fb415b4..fb36c057dd 100644 --- a/docs/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/docs/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx b/docs/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx index 91f6cb6f9d..aa3a188566 100644 --- a/docs/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx index f6d4baee7e..1b0b38b2d8 100644 --- a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx @@ -25,22 +25,22 @@ import Panel from '@site/src/components/Panel'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this article: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Control null placement when sorting by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#control-null-placement-when-sorting-by-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`Spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialFieldFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteriaFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`OrderByDistance`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`OrderByDistanceDescending`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Control null placement when sorting by distance](#control-null-placement-when-sorting-by-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`Spatial`](#section) + * [`DynamicSpatialFieldFactory`](#section-1) + * [`SpatialCriteriaFactory`](#section-2) + * [`OrderByDistance`](#section-3) + * [`OrderByDistanceDescending`](#section-4) diff --git a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx index 719ede75fb..f17f1bca75 100644 --- a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx +++ b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx @@ -25,22 +25,22 @@ import Panel from '@site/src/components/Panel'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this article: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Control null placement when sorting by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#control-null-placement-when-sorting-by-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialField`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteriaFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`orderByDistance`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`orderByDistanceDescending`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Control null placement when sorting by distance](#control-null-placement-when-sorting-by-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`spatial`](#section) + * [`DynamicSpatialField`](#section-1) + * [`SpatialCriteriaFactory`](#section-2) + * [`orderByDistance`](#section-3) + * [`orderByDistanceDescending`](#section-4) diff --git a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx index 57bffea515..9f5c03238e 100644 --- a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx @@ -24,17 +24,17 @@ import Panel from '@site/src/components/Panel'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this article: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance desc](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Control null placement when sorting by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#control-null-placement-when-sorting-by-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance desc](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Control null placement when sorting by distance](#control-null-placement-when-sorting-by-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) diff --git a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx index 018180f091..8a975b7998 100644 --- a/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx @@ -25,22 +25,22 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Control null placement when sorting by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#control-null-placement-when-sorting-by-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialField`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteria`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`order_by_distance`, `order_by_distance_wkt`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`order_by_distance_descending`, `order_by_distance_descending_wkt`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Control null placement when sorting by distance](#control-null-placement-when-sorting-by-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`spatial`](#section) + * [`DynamicSpatialField`](#section-1) + * [`SpatialCriteria`](#section-2) + * [`order_by_distance`, `order_by_distance_wkt`](#section-3) + * [`order_by_distance_descending`, `order_by_distance_descending_wkt`](#section-4) diff --git a/docs/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx b/docs/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx index d7ed44ad12..9965776c7c 100644 --- a/docs/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; creating auto map-reduce indexes. * In This Page: - * [Group By a Single Field](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-a-single-field) - * [Group By Multiple Fields](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-multiple-fields) - * [Select Composite GroupBy Key](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#select-composite-groupby-key) - * [Group By Array](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-array) - * [By Array Values](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-values) - * [By Array Content](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-content) - * [Sorting](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#sorting) - * [By Count](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-count) - * [By Sum](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-sum) + * [Group By a Single Field](#group-by-a-single-field) + * [Group By Multiple Fields](#group-by-multiple-fields) + * [Select Composite GroupBy Key](#select-composite-groupby-key) + * [Group By Array](#group-by-array) + * [By Array Values](#by-array-values) + * [By Array Content](#by-array-content) + * [Sorting](#sorting) + * [By Count](#by-count) + * [By Sum](#by-sum) ## Group By a Single Field diff --git a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx index d09504cfcb..69ae2b3ed7 100644 --- a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx index 12c83d4003..585bfb893f 100644 --- a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx index 05e564c598..2b1e083c32 100644 --- a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx @@ -16,11 +16,11 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more about queries in this [query overview](../../../../querying/overview.mdx). * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy Aggregation](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-aggregation) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy Aggregation](#lazy-aggregation) + * [Syntax](#syntax) ## Lazy query diff --git a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx index d88061c808..f2105f62ee 100644 --- a/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/docs/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx b/docs/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx index 8bd8b19717..483a9ec131 100644 --- a/docs/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; For projecting results when querying a **static-index** see [project index query results](../../../../indexes/querying/projections.mdx). * In this article: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) - * [Select](../../../../client-api/session/querying/how-to-project-query-results.mdx#select) - * [ProjectInto](../../../../client-api/session/querying/how-to-project-query-results.mdx#projectinto) - * [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Projections overview](#projections-overview) + * [Projection Methods](#projection-methods) + * [Select](#select) + * [ProjectInto](#projectinto) + * [SelectFields](#selectfields) + * [Single projection per query](#single-projection-per-query) @@ -68,11 +68,11 @@ import CodeBlock from '@theme/CodeBlock'; but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. * Only a single projection request can be made per Query (and DocumentQuery). - Learn more in [single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query). + Learn more in [single projection per query](#single-projection-per-query). **The cost of projections**: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/docs/client-api/session/querying/content/_how-to-project-query-results-java.mdx b/docs/client-api/session/querying/content/_how-to-project-query-results-java.mdx index 2438925907..80350d8411 100644 --- a/docs/client-api/session/querying/content/_how-to-project-query-results-java.mdx +++ b/docs/client-api/session/querying/content/_how-to-project-query-results-java.mdx @@ -6,8 +6,8 @@ import CodeBlock from '@theme/CodeBlock'; Instead of pulling full documents in query results you can just grab some pieces of data from documents. You can also transform the projected results. The projections are defined with the usage of: -- [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) -- [OfType](../../../../client-api/session/querying/how-to-project-query-results.mdx#oftype---simple-projection) +- [SelectFields](#selectfields) +- [OfType](#oftype---simple-projection) ## SelectFields diff --git a/docs/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx index c0d4cd6821..0c26c8b60c 100644 --- a/docs/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; For projecting results when querying a **static-index** see [project index query results](../../../../indexes/querying/projections.mdx). * In this article: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) - * [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) - * [Projecting nested object types](../../../../client-api/session/querying/how-to-project-query-results.mdx#projecting-nested-object-types) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) - * [Syntax](../../../../client-api/session/querying/how-to-project-query-results.mdx#syntax) + * [Projections overview](#projections-overview) + * [SelectFields](#selectfields) + * [Projecting nested object types](#projecting-nested-object-types) + * [Single projection per query](#single-projection-per-query) + * [Syntax](#syntax) @@ -32,7 +32,7 @@ import CodeBlock from '@theme/CodeBlock'; * The query can load [related documents](../../../../indexes/indexing-related-documents.mdx#what-are-related-documents) and have their data merged into the projection results. -* Content from inner objects and arrays can be projected in addition to [projecting the nested object types](../../../../client-api/session/querying/how-to-project-query-results.mdx#projecting-nested-object-types). +* Content from inner objects and arrays can be projected in addition to [projecting the nested object types](#projecting-nested-object-types). * An alias name can be given to the projected fields, and any calculations can be applied within the projection. @@ -73,7 +73,7 @@ import CodeBlock from '@theme/CodeBlock'; **The cost of projections**: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example-v---projection-with-calculations) + However, you can perform any [calculations](#example-v---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/docs/client-api/session/querying/content/_how-to-project-query-results-php.mdx b/docs/client-api/session/querying/content/_how-to-project-query-results-php.mdx index 433242d4a9..6198deedb9 100644 --- a/docs/client-api/session/querying/content/_how-to-project-query-results-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-project-query-results-php.mdx @@ -13,13 +13,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) + * [Projections overview](#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) + * [Projection Methods](#projection-methods) * [`select`, `selectFields`](../../../../client-api/session/querying/how-to-project-query-results.mdx#select,-selectfields) - * [`ofType`](../../../../client-api/session/querying/how-to-project-query-results.mdx#oftype) + * [`ofType`](#oftype) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -73,12 +73,12 @@ import CodeBlock from '@theme/CodeBlock'; * Within the projection you can only filter what data will be returned from the matching documents, but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. -* Only a [single projection request](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) can be made per query. +* Only a [single projection request](#single-projection-per-query) can be made per query. ### The cost of projections: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/docs/client-api/session/querying/content/_how-to-project-query-results-python.mdx b/docs/client-api/session/querying/content/_how-to-project-query-results-python.mdx index 6cf008121f..96f4fd6a62 100644 --- a/docs/client-api/session/querying/content/_how-to-project-query-results-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-project-query-results-python.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) + * [Projections overview](#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) - * [select_fields_query_data](../../../../client-api/session/querying/how-to-project-query-results.mdx#select_fields_query_data) - * [raw_query with `select`](../../../../client-api/session/querying/how-to-project-query-results.mdx#raw_query-with-select) - * [select_fields](../../../../client-api/session/querying/how-to-project-query-results.mdx#select_fields) + * [Projection Methods](#projection-methods) + * [select_fields_query_data](#select_fields_query_data) + * [raw_query with `select`](#raw_query-with-select) + * [select_fields](#select_fields) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -75,12 +75,12 @@ import CodeBlock from '@theme/CodeBlock'; but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. * Only a single projection request can be made per query. - Learn more in [single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query). + Learn more in [single projection per query](#single-projection-per-query). ### The cost of projections: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) * inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx index 376c694350..8931e68c19 100644 --- a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx +++ b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -85,7 +85,7 @@ List products = session * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx index 7e4d4478d1..3a8cf094e0 100644 --- a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx +++ b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -85,7 +85,7 @@ const products = await session * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx index d57e71dcb4..5b844d314a 100644 --- a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx +++ b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for a single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -87,7 +87,7 @@ public function suggestUsing(null|SuggestionBase|Closure $suggestionOrBuilder): * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx index 1fda5df34c..3eaee4dcda 100644 --- a/docs/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx +++ b/docs/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -82,7 +82,7 @@ products = list(session.query(object_type=Product).where_equals("name", "chaig") * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/docs/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx b/docs/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx index 9484d1f7f8..638aaae841 100644 --- a/docs/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx +++ b/docs/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; For including explanations when querying a **static-index** see [Include explanations in index query](../../../../../indexes/querying/include-explanations.mdx). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/docs/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx b/docs/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx index 447e16bcb1..2d78c3f2e2 100644 --- a/docs/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx +++ b/docs/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; For including explanations when querying a **static-index** see [Include explanations in index query](../../../../../indexes/querying/include-explanations.mdx). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/docs/client-api/session/querying/debugging/content/_include-explanations-php.mdx b/docs/client-api/session/querying/debugging/content/_include-explanations-php.mdx index daff9e9b1e..713f6bca0a 100644 --- a/docs/client-api/session/querying/debugging/content/_include-explanations-php.mdx +++ b/docs/client-api/session/querying/debugging/content/_include-explanations-php.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/docs/client-api/session/querying/debugging/content/_include-explanations-python.mdx b/docs/client-api/session/querying/debugging/content/_include-explanations-python.mdx index a3b762d879..4b186907fe 100644 --- a/docs/client-api/session/querying/debugging/content/_include-explanations-python.mdx +++ b/docs/client-api/session/querying/debugging/content/_include-explanations-python.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/docs/client-api/session/querying/debugging/content/_query-timings-csharp.mdx b/docs/client-api/session/querying/debugging/content/_query-timings-csharp.mdx index a694912f6d..836844b4c6 100644 --- a/docs/client-api/session/querying/debugging/content/_query-timings-csharp.mdx +++ b/docs/client-api/session/querying/debugging/content/_query-timings-csharp.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/docs/client-api/session/querying/debugging/content/_query-timings-java.mdx b/docs/client-api/session/querying/debugging/content/_query-timings-java.mdx index e9a3379dad..c9fe49a387 100644 --- a/docs/client-api/session/querying/debugging/content/_query-timings-java.mdx +++ b/docs/client-api/session/querying/debugging/content/_query-timings-java.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/docs/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx b/docs/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx index d74ca7eaa3..27c4b04cd7 100644 --- a/docs/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx +++ b/docs/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/docs/client-api/session/querying/debugging/content/_query-timings-php.mdx b/docs/client-api/session/querying/debugging/content/_query-timings-php.mdx index 149d462ffe..e0a8e1b47a 100644 --- a/docs/client-api/session/querying/debugging/content/_query-timings-php.mdx +++ b/docs/client-api/session/querying/debugging/content/_query-timings-php.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/docs/client-api/session/querying/debugging/content/_query-timings-python.mdx b/docs/client-api/session/querying/debugging/content/_query-timings-python.mdx index ff9f34b627..cc4de89b34 100644 --- a/docs/client-api/session/querying/debugging/content/_query-timings-python.mdx +++ b/docs/client-api/session/querying/debugging/content/_query-timings-python.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/docs/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx b/docs/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx index 8adc0fc4d9..aec5a21dd9 100644 --- a/docs/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/docs/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx index f78176c12e..05230b26e8 100644 --- a/docs/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/docs/client-api/session/querying/text-search/content/_boost-search-results-php.mdx b/docs/client-api/session/querying/text-search/content/_boost-search-results-php.mdx index 8ef3797257..b12c3a7639 100644 --- a/docs/client-api/session/querying/text-search/content/_boost-search-results-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_boost-search-results-php.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/docs/client-api/session/querying/text-search/content/_boost-search-results-python.mdx b/docs/client-api/session/querying/text-search/content/_boost-search-results-python.mdx index 3c3ea9b4c5..3998ac07df 100644 --- a/docs/client-api/session/querying/text-search/content/_boost-search-results-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_boost-search-results-python.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/docs/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx b/docs/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx index 9f327739a3..96638a2ef4 100644 --- a/docs/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [EndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#endswith) + * [EndsWith](#endswith) * [EndsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#endswith-(case-sensitive)) - * [Negate EndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-endswith) + * [Negate EndsWith](#negate-endswith) ## EndsWith diff --git a/docs/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx index a78d599e5a..3dc15b046b 100644 --- a/docs/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx @@ -15,10 +15,10 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [whereEndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#whereendswith) + * [whereEndsWith](#whereendswith) * [whereEndsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#whereendswith-(case-sensitive)) - * [Negate whereEndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-whereendswith) - * [Syntax](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#syntax) + * [Negate whereEndsWith](#negate-whereendswith) + * [Syntax](#syntax) ## whereEndsWith diff --git a/docs/client-api/session/querying/text-search/content/_ends-with-query-php.mdx b/docs/client-api/session/querying/text-search/content/_ends-with-query-php.mdx index e35bde40b7..2102b52f58 100644 --- a/docs/client-api/session/querying/text-search/content/_ends-with-query-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_ends-with-query-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with) + * [where_ends_with](#where_ends_with) * [where_ends_with (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with-(case-sensitive)) - * [Negate where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-where_ends_with) + * [Negate where_ends_with](#negate-where_ends_with) ## where_ends_with diff --git a/docs/client-api/session/querying/text-search/content/_ends-with-query-python.mdx b/docs/client-api/session/querying/text-search/content/_ends-with-query-python.mdx index 5680751ecc..57a0295800 100644 --- a/docs/client-api/session/querying/text-search/content/_ends-with-query-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_ends-with-query-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with) + * [where_ends_with](#where_ends_with) * [where_ends_with (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with-(case-sensitive)) - * [Negate where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-where_ends_with) + * [Negate where_ends_with](#negate-where_ends_with) ## where_ends_with diff --git a/docs/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx b/docs/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx index 7871aaa8cc..9e0a32f0b7 100644 --- a/docs/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; using the [default exact analyzer](../../../../../indexes/using-analyzers.mdx#ravendb) where the casing of the original text is not changed. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/docs/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx index 488a5ae35e..711fd8a101 100644 --- a/docs/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; using the [default exact analyzer](../../../../../indexes/using-analyzers.mdx#ravendb) where the casing of the original text is not changed. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/docs/client-api/session/querying/text-search/content/_exact-match-query-php.mdx b/docs/client-api/session/querying/text-search/content/_exact-match-query-php.mdx index 1d57417b2e..fec318b8c1 100644 --- a/docs/client-api/session/querying/text-search/content/_exact-match-query-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_exact-match-query-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; where the casing of the original text is unchanged. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/docs/client-api/session/querying/text-search/content/_exact-match-query-python.mdx b/docs/client-api/session/querying/text-search/content/_exact-match-query-python.mdx index 65260c6a8a..a4a01b0705 100644 --- a/docs/client-api/session/querying/text-search/content/_exact-match-query-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_exact-match-query-python.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; where the casing of the original text is unchanged. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/docs/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx b/docs/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx index e3c25970b9..0b76a5ac12 100644 --- a/docs/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -122,7 +122,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -239,7 +239,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search options](#search-operators). diff --git a/docs/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx index c317270ab0..39b18738a2 100644 --- a/docs/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx @@ -28,12 +28,12 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term diff --git a/docs/client-api/session/querying/text-search/content/_full-text-search-php.mdx b/docs/client-api/session/querying/text-search/content/_full-text-search-php.mdx index c85527e162..ae9cee2b7b 100644 --- a/docs/client-api/session/querying/text-search/content/_full-text-search-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_full-text-search-php.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -108,7 +108,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -198,7 +198,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). diff --git a/docs/client-api/session/querying/text-search/content/_full-text-search-python.mdx b/docs/client-api/session/querying/text-search/content/_full-text-search-python.mdx index 41573e93ed..32717798e6 100644 --- a/docs/client-api/session/querying/text-search/content/_full-text-search-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_full-text-search-python.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -90,7 +90,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -131,7 +131,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search options](#search-operators). diff --git a/docs/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx b/docs/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx index 6f3db7aee8..15f8b1488d 100644 --- a/docs/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; * Note: this is a Lucene feature, available only for Lucene-based indexes. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/docs/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx index 7e8a8d3765..54a1f68bdd 100644 --- a/docs/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/docs/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx b/docs/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx index 8e7ecb9d34..5a47583645 100644 --- a/docs/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Note: this is a Lucene feature, available only for Lucene-based indexes. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/docs/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx b/docs/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx index b7a0d4fce7..731332b3c4 100644 --- a/docs/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * Note: this is a Lucene feature, available only for Lucene-based indexes. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/docs/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx b/docs/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx index 1d52ef49d8..3ada57bdad 100644 --- a/docs/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -168,7 +168,7 @@ string fragmentsHtml = builder.AppendLine("").ToString(); - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/docs/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx index 3c56a7354d..016238ca5b 100644 --- a/docs/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a __dynamic-query__. For highlighting search results when querying a __static-index__ see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -131,7 +131,7 @@ fragmentsHtml += ""; - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be __customized__ to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/docs/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx b/docs/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx index 954c3d56c7..d1fc04d268 100644 --- a/docs/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -134,7 +134,7 @@ $fragmentsHtml = $builder; - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/docs/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx b/docs/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx index 2e5f2a340f..0916806b4d 100644 --- a/docs/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -132,7 +132,7 @@ fragments_html = builder.append(f"\{os.linesep\}") - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/docs/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx b/docs/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx index 5fe28df901..f06c7eeba7 100644 --- a/docs/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx @@ -13,10 +13,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Proximity` method when running a **full-text search** by the [Search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/docs/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx index a1880d69c7..241c80d8a3 100644 --- a/docs/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a __full-text search__ by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/docs/client-api/session/querying/text-search/content/_proximity-search-php.mdx b/docs/client-api/session/querying/text-search/content/_proximity-search-php.mdx index b8aae434d8..9411af649f 100644 --- a/docs/client-api/session/querying/text-search/content/_proximity-search-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_proximity-search-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a **full-text search** by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/docs/client-api/session/querying/text-search/content/_proximity-search-python.mdx b/docs/client-api/session/querying/text-search/content/_proximity-search-python.mdx index fe1f59aa8f..e65b9ba21b 100644 --- a/docs/client-api/session/querying/text-search/content/_proximity-search-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_proximity-search-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a **full-text search** by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/docs/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx b/docs/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx index c5a42d9cb5..e2eeb1cacc 100644 --- a/docs/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx +++ b/docs/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/docs/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx b/docs/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx index 32bff0e775..88c3a5606e 100644 --- a/docs/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx +++ b/docs/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx @@ -10,10 +10,10 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [whereStartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#wherestartswith) + * [whereStartsWith](#wherestartswith) * [whereStartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#wherestartswith-(case-sensitive)) - * [Negate whereStartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-wherestartswith) - * [Syntax](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#syntax) + * [Negate whereStartsWith](#negate-wherestartswith) + * [Syntax](#syntax) ## whereStartsWith diff --git a/docs/client-api/session/querying/text-search/content/_starts-with-query-php.mdx b/docs/client-api/session/querying/text-search/content/_starts-with-query-php.mdx index b6eb7fb103..3e9eff6bb4 100644 --- a/docs/client-api/session/querying/text-search/content/_starts-with-query-php.mdx +++ b/docs/client-api/session/querying/text-search/content/_starts-with-query-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/docs/client-api/session/querying/text-search/content/_starts-with-query-python.mdx b/docs/client-api/session/querying/text-search/content/_starts-with-query-python.mdx index d8b9ad2d9e..f3f257a8f0 100644 --- a/docs/client-api/session/querying/text-search/content/_starts-with-query-python.mdx +++ b/docs/client-api/session/querying/text-search/content/_starts-with-query-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/docs/client-api/smuggler/content/_what-is-smuggler-csharp.mdx b/docs/client-api/smuggler/content/_what-is-smuggler-csharp.mdx index 4bdf46a8fc..eff1ee8bd7 100644 --- a/docs/client-api/smuggler/content/_what-is-smuggler-csharp.mdx +++ b/docs/client-api/smuggler/content/_what-is-smuggler-csharp.mdx @@ -44,7 +44,7 @@ Task ExportAsync( | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `string` | Path to a file where exported data will be written | | **token** | `CancellationToken` | Token used to cancel the operation | @@ -64,7 +64,7 @@ Task ExportAsync( | **IncludeArtificial** | `bool` | Should artificial documents be exported.
Default: `false` | | **IncludeArchived** | `bool` | Should archived documents be exported.
Default: `true` | | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes.
Default: `false` | -| **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **MaxStepsForTransformScript** | `int` | Maximum number of steps that the transform script can process before failing.
Default: **10000** | ### Example @@ -111,7 +111,7 @@ Task ImportAsync( | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `Stream` | Stream with data to import | | **fromFile** | `string` | Path to a file from which data will be imported | | **token** | `CancellationToken` | Token used to cancel the operation | @@ -131,7 +131,7 @@ Task ImportAsync( | **IncludeArtificial** | `bool` | Should artificial documents be imported.
Default: `false` | | **IncludeArchived** | `bool` | Should archived documents be imported.
Default: `true` | | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes.
Default: `false` | -| **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](#transformscript). | | **MaxStepsForTransformScript** | `int` | Maximum number of steps that the transform script can process before failing.
Default: **10000** | ### Example diff --git a/docs/client-api/smuggler/content/_what-is-smuggler-java.mdx b/docs/client-api/smuggler/content/_what-is-smuggler-java.mdx index dd4f20fd0c..4aa61924d9 100644 --- a/docs/client-api/smuggler/content/_what-is-smuggler-java.mdx +++ b/docs/client-api/smuggler/content/_what-is-smuggler-java.mdx @@ -37,7 +37,7 @@ public Operation exportAsync(DatabaseSmugglerExportOptions options, DatabaseSmug | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `String` | Path to a file where exported data will be written | @@ -54,7 +54,7 @@ public Operation exportAsync(DatabaseSmugglerExportOptions options, DatabaseSmug | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be exported from database record. Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications` | | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | ### Example @@ -83,7 +83,7 @@ public Operation importAsync(DatabaseSmugglerImportOptions options, InputStream | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `InputStream` | Stream with data to import | | **fromFile** | `String` | Path to a file from which data will be imported | @@ -100,7 +100,7 @@ public Operation importAsync(DatabaseSmugglerImportOptions options, InputStream | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be imported. Default: `CLIENT`, `CONFLICT_SOLVER_CONFIG`, `EXPIRATION`, `EXTERNAL_REPLICATIONS`, `PERIODIC_BACKUPS`, `RAVEN_CONNECTION_STRINGS`, `RAVEN_ETLS`, `REVISIONS`, `SQL_CONNECTION_STRINGS`, `SORTERS`, `SQL_ETLS`, `HUB_PULL_REPLICATIONS`, `SINK_PULL_REPLICATIONS` | | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | diff --git a/docs/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx b/docs/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx index ca9f9b333d..23e3b30d17 100644 --- a/docs/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx +++ b/docs/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx @@ -38,7 +38,7 @@ const operation = await store.smuggler.export(options, toFile); | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `string` | Path to a file where exported data will be written | @@ -56,7 +56,7 @@ const operation = await store.smuggler.export(options, toFile); | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | **includeArtificial** | `boolean` | ? | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | **skipRevisionCreation** | `boolean` | skip revision creation | | **encryptionKey** | `string` | Encryption key used for restore | @@ -92,7 +92,7 @@ const operation = await store.smuggler.import(options, stream); | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `Stream` | Stream with data to import | | **fromFile** | `string` | Path to a file from which data will be imported | @@ -109,7 +109,7 @@ const operation = await store.smuggler.import(options, stream); | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | **includeArtificial** | `boolean` | ? | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | **skipRevisionCreation** | `boolean` | skip revision creation | | **encryptionKey** | `string` | Encryption key used for restore | diff --git a/docs/compare-exchange/configuration.mdx b/docs/compare-exchange/configuration.mdx index e6d5df7572..8e67670a50 100644 --- a/docs/compare-exchange/configuration.mdx +++ b/docs/compare-exchange/configuration.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; see the [Configuration Overview](../server/configuration/configuration-options.mdx) article. * The following configuration options are available for compare-exchange: - * [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../compare-exchange/configuration.mdx#clustercompareexchangeexpireddeletefrequencyinsec) - * [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../compare-exchange/configuration.mdx#clustercompareexchangetombstonescleanupintervalinmin) - * [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../compare-exchange/configuration.mdx#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) - * [Cluster.DisableAtomicDocumentWrites](../compare-exchange/configuration.mdx#clusterdisableatomicdocumentwrites) + * [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](#clustercompareexchangeexpireddeletefrequencyinsec) + * [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](#clustercompareexchangetombstonescleanupintervalinmin) + * [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) + * [Cluster.DisableAtomicDocumentWrites](#clusterdisableatomicdocumentwrites) diff --git a/docs/compare-exchange/content/_atomic-guards-csharp.mdx b/docs/compare-exchange/content/_atomic-guards-csharp.mdx index a6c061c27b..1144b26437 100644 --- a/docs/compare-exchange/content/_atomic-guards-csharp.mdx +++ b/docs/compare-exchange/content/_atomic-guards-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-creation-and-update) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/docs/compare-exchange/content/_atomic-guards-nodejs.mdx b/docs/compare-exchange/content/_atomic-guards-nodejs.mdx index 3db6100f76..c88ebd6048 100644 --- a/docs/compare-exchange/content/_atomic-guards-nodejs.mdx +++ b/docs/compare-exchange/content/_atomic-guards-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/docs/compare-exchange/content/_atomic-guards-php.mdx b/docs/compare-exchange/content/_atomic-guards-php.mdx index 8403cad8dd..1e3f46a47e 100644 --- a/docs/compare-exchange/content/_atomic-guards-php.mdx +++ b/docs/compare-exchange/content/_atomic-guards-php.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/docs/compare-exchange/content/_atomic-guards-python.mdx b/docs/compare-exchange/content/_atomic-guards-python.mdx index 32f32643c3..ac51059677 100644 --- a/docs/compare-exchange/content/_atomic-guards-python.mdx +++ b/docs/compare-exchange/content/_atomic-guards-python.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx b/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx index 659f717473..1200979f41 100644 --- a/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx +++ b/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more about dynamic queries in the [Query overview](../../querying/overview.mdx). * In this article: - * [Projecting compare-exchange values in query results](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#projecting-compare-exchange-values-in-query-results) - * [Filtering by compare-exchange value](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#filtering-by-compare-exchange-value) - * [Example 1 - Filtering when the compare-exchange value is a string](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-1---filtering-when-the-compare-exchange-value-is-a-string) - * [Example 2 - Filtering when the compare-exchange value is an object](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object) - * [Syntax](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#syntax) + * [Projecting compare-exchange values in query results](#projecting-compare-exchange-values-in-query-results) + * [Filtering by compare-exchange value](#filtering-by-compare-exchange-value) + * [Example 1 - Filtering when the compare-exchange value is a string](#example-1---filtering-when-the-compare-exchange-value-is-a-string) + * [Example 2 - Filtering when the compare-exchange value is an object](#example-2---filtering-when-the-compare-exchange-value-is-an-object) + * [Syntax](#syntax) @@ -178,7 +178,7 @@ select { When filtering with `RavenQuery.CmpXchg` inside the `Where` predicate (as shown in this example), the compare-exchange value must be a _string_. If your compare-exchange value is of another type, you can still filter the results - - see the [next example](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object). + see the [next example](#example-2---filtering-when-the-compare-exchange-value-is-an-object). * Since this query uses filtering, RavenDB will automatically create an auto-index to serve it. In this case, the auto-index `Auto/Users/ByEmail` will be created. diff --git a/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx b/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx index 5b5c89490e..5d4350a391 100644 --- a/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx +++ b/docs/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more about dynamic queries in the [Query overview](../../querying/overview.mdx). * In this article: - * [Projecting compare-exchange values in query results](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#projecting-compare-exchange-values-in-query-results) - * [Filtering by compare-exchange value](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#filtering-by-compare-exchange-value) - * [Example 1 - Filtering when the compare-exchange value is a string](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-1---filtering-when-the-compare-exchange-value-is-a-string) - * [Example 2 - Filtering when the compare-exchange value is an object](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object) - * [Syntax](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#syntax) + * [Projecting compare-exchange values in query results](#projecting-compare-exchange-values-in-query-results) + * [Filtering by compare-exchange value](#filtering-by-compare-exchange-value) + * [Example 1 - Filtering when the compare-exchange value is a string](#example-1---filtering-when-the-compare-exchange-value-is-a-string) + * [Example 2 - Filtering when the compare-exchange value is an object](#example-2---filtering-when-the-compare-exchange-value-is-an-object) + * [Syntax](#syntax) @@ -98,7 +98,7 @@ select { When filtering with `cmpxchg` inside the `where` predicate (as shown in this example), the compare-exchange value must be a _string_. If your compare-exchange value is of another type, you can still filter the results - - see the [next example](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object). + see the [next example](#example-2---filtering-when-the-compare-exchange-value-is-an-object). * Since this query uses filtering, RavenDB will automatically create an auto-index to serve it. In this case, the auto-index `Auto/Users/ByEmail` will be created. diff --git a/docs/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx b/docs/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx index 7fb85c1b5d..e392c6c092 100644 --- a/docs/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx +++ b/docs/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx @@ -25,9 +25,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Add expiration date using the **Client API**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-client-api) - * [Add expiration date using the **Studio**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-studio) - * [Syntax](../../compare-exchange/cmpxchg-expiration.mdx#syntax) + * [Add expiration date using the **Client API**](#add-expiration-date-using-the-client-api) + * [Add expiration date using the **Studio**](#add-expiration-date-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx b/docs/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx index 19d2a3edaa..a47d6753d2 100644 --- a/docs/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx +++ b/docs/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx @@ -25,9 +25,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Add expiration date using the **Client API**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-client-api) - * [Add expiration date using the **Studio**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-studio) - * [Syntax](../../compare-exchange/cmpxchg-expiration.mdx#syntax) + * [Add expiration date using the **Client API**](#add-expiration-date-using-the-client-api) + * [Add expiration date using the **Studio**](#add-expiration-date-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_create-cmpxchg-items-csharp.mdx b/docs/compare-exchange/content/_create-cmpxchg-items-csharp.mdx index 961ac7662c..bb2236cba5 100644 --- a/docs/compare-exchange/content/_create-cmpxchg-items-csharp.mdx +++ b/docs/compare-exchange/content/_create-cmpxchg-items-csharp.mdx @@ -20,17 +20,17 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Ex.1 - Create compare-exchange item - with string value](../../compare-exchange/create-cmpxchg-items.mdx#ex1---create-compare-exchange-item---with-string-value) - * [Ex.2 - Create compare-exchange item - with custom object value](../../compare-exchange/create-cmpxchg-items.mdx#ex2---create-compare-exchange-item---with-custom-object-value) - * [Ex.3 - Create compare-exchange item - with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex3---create-compare-exchange-item---with-metadata) - * [Ex.4 - Create multiple items](../../compare-exchange/create-cmpxchg-items.mdx#ex4---create-multiple-items) - * [Create item using a **store operation**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-store-operation) - * [Ex.5 - Create compare-exchange item - with string value](../../compare-exchange/create-cmpxchg-items.mdx#ex5---create-compare-exchange-item---with-string-value) - * [Ex.6 - Create compare-exchange item - with custom object value](../../compare-exchange/create-cmpxchg-items.mdx#ex6---create-compare-exchange-item---with-custom-object-value) - * [Ex.7 - Create compare-exchange item - with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex7---create-compare-exchange-item---with-metadata) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Ex.1 - Create compare-exchange item - with string value](#ex1---create-compare-exchange-item---with-string-value) + * [Ex.2 - Create compare-exchange item - with custom object value](#ex2---create-compare-exchange-item---with-custom-object-value) + * [Ex.3 - Create compare-exchange item - with metadata](#ex3---create-compare-exchange-item---with-metadata) + * [Ex.4 - Create multiple items](#ex4---create-multiple-items) + * [Create item using a **store operation**](#create-item-using-a-store-operation) + * [Ex.5 - Create compare-exchange item - with string value](#ex5---create-compare-exchange-item---with-string-value) + * [Ex.6 - Create compare-exchange item - with custom object value](#ex6---create-compare-exchange-item---with-custom-object-value) + * [Ex.7 - Create compare-exchange item - with metadata](#ex7---create-compare-exchange-item---with-metadata) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_create-cmpxchg-items-java.mdx b/docs/compare-exchange/content/_create-cmpxchg-items-java.mdx index ab4e00012d..305b797c34 100644 --- a/docs/compare-exchange/content/_create-cmpxchg-items-java.mdx +++ b/docs/compare-exchange/content/_create-cmpxchg-items-java.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **store operation**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-store-operation) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **store operation**](#create-item-using-a-store-operation) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx b/docs/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx index df539128f9..91aa83ce04 100644 --- a/docs/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx +++ b/docs/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx @@ -20,15 +20,15 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange items](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Ex.1 - Create new compare-exchange item](../../compare-exchange/create-cmpxchg-items.mdx#ex1---create-new-compare-exchange-item) - * [Ex.2 - Create new compare-exchange item with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex2---create-new-compare-exchange-item-with-metadata) - * [Ex.3 - Create multiple items](../../compare-exchange/create-cmpxchg-items.mdx#ex3---create-multiple-items) - * [Create item using a **store operation**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-store-operation) - * [Ex.4 - Create new compare-exchange item](../../compare-exchange/create-cmpxchg-items.mdx#ex4---create-new-compare-exchange-item) - * [Ex.5 - Create new compare-exchange item with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex5---create-new-compare-exchange-item-with-metadata) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Ex.1 - Create new compare-exchange item](#ex1---create-new-compare-exchange-item) + * [Ex.2 - Create new compare-exchange item with metadata](#ex2---create-new-compare-exchange-item-with-metadata) + * [Ex.3 - Create multiple items](#ex3---create-multiple-items) + * [Create item using a **store operation**](#create-item-using-a-store-operation) + * [Ex.4 - Create new compare-exchange item](#ex4---create-new-compare-exchange-item) + * [Ex.5 - Create new compare-exchange item with metadata](#ex5---create-new-compare-exchange-item-with-metadata) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_create-cmpxchg-items-php.mdx b/docs/compare-exchange/content/_create-cmpxchg-items-php.mdx index 95b9d42e26..a910a3a516 100644 --- a/docs/compare-exchange/content/_create-cmpxchg-items-php.mdx +++ b/docs/compare-exchange/content/_create-cmpxchg-items-php.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_create-cmpxchg-items-python.mdx b/docs/compare-exchange/content/_create-cmpxchg-items-python.mdx index edca63e5c0..2950996855 100644 --- a/docs/compare-exchange/content/_create-cmpxchg-items-python.mdx +++ b/docs/compare-exchange/content/_create-cmpxchg-items-python.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx b/docs/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx index 5a30cdd7b3..c00830ae26 100644 --- a/docs/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx +++ b/docs/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx @@ -32,13 +32,13 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete multiple items](../../compare-exchange/delete-cmpxchg-items.mdx#delete-multiple-items) - * [Delete compare-exchange item using a **store operation**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-store-operation) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete multiple items](#delete-multiple-items) + * [Delete compare-exchange item using a **store operation**](#delete-compare-exchange-item-using-a-store-operation) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_delete-cmpxchg-items-java.mdx b/docs/compare-exchange/content/_delete-cmpxchg-items-java.mdx index 8ee2af06d3..2879418b96 100644 --- a/docs/compare-exchange/content/_delete-cmpxchg-items-java.mdx +++ b/docs/compare-exchange/content/_delete-cmpxchg-items-java.mdx @@ -32,9 +32,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **store operation**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-store-operation) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **store operation**](#delete-compare-exchange-item-using-a-store-operation) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx b/docs/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx index a9872a1a84..e5b22cd1d7 100644 --- a/docs/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx +++ b/docs/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx @@ -32,13 +32,13 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete multiple items](../../compare-exchange/delete-cmpxchg-items.mdx#delete-multiple-items) - * [Delete compare-exchange item using a **store operation**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-store-operation) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete multiple items](#delete-multiple-items) + * [Delete compare-exchange item using a **store operation**](#delete-compare-exchange-item-using-a-store-operation) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_delete-cmpxchg-items-php.mdx b/docs/compare-exchange/content/_delete-cmpxchg-items-php.mdx index c9eb4d051b..cb7b439d91 100644 --- a/docs/compare-exchange/content/_delete-cmpxchg-items-php.mdx +++ b/docs/compare-exchange/content/_delete-cmpxchg-items-php.mdx @@ -32,11 +32,11 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_delete-cmpxchg-items-python.mdx b/docs/compare-exchange/content/_delete-cmpxchg-items-python.mdx index d53084fc3e..25fbb6f73d 100644 --- a/docs/compare-exchange/content/_delete-cmpxchg-items-python.mdx +++ b/docs/compare-exchange/content/_delete-cmpxchg-items-python.mdx @@ -32,11 +32,11 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-item-csharp.mdx b/docs/compare-exchange/content/_get-cmpxchg-item-csharp.mdx index fc94406a35..f2fda3165f 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-item-csharp.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-item-csharp.mdx @@ -16,14 +16,14 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item) - * [Get compare-exchange item lazily](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-lazily) - * [Retrieved compare-exchange items are tracked by the session](../../compare-exchange/get-cmpxchg-item.mdx#retrieved-compare-exchange-items-are-tracked-by-the-session) - * [Get item using a **store operation**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-store-operation) - * [Get compare-exchange item that has a number value and metadata](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-number-value-and-metadata) - * [Get compare-exchange item that has a custom object value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-custom-object-value) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Get compare-exchange item](#get-compare-exchange-item) + * [Get compare-exchange item lazily](#get-compare-exchange-item-lazily) + * [Retrieved compare-exchange items are tracked by the session](#retrieved-compare-exchange-items-are-tracked-by-the-session) + * [Get item using a **store operation**](#get-item-using-a-store-operation) + * [Get compare-exchange item that has a number value and metadata](#get-compare-exchange-item-that-has-a-number-value-and-metadata) + * [Get compare-exchange item that has a custom object value](#get-compare-exchange-item-that-has-a-custom-object-value) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-item-java.mdx b/docs/compare-exchange/content/_get-cmpxchg-item-java.mdx index 580b3a9f03..bf98a4a09a 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-item-java.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-item-java.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **store operation**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-store-operation) - * [Get compare-exchange item that has a number value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-number-value) - * [Get compare-exchange item that has a custom object value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-custom-object-value) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **store operation**](#get-item-using-a-store-operation) + * [Get compare-exchange item that has a number value](#get-compare-exchange-item-that-has-a-number-value) + * [Get compare-exchange item that has a custom object value](#get-compare-exchange-item-that-has-a-custom-object-value) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx b/docs/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx index 16b9e2ae06..4a3c54f253 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx @@ -16,14 +16,14 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item) - * [Get compare-exchange item lazily](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-lazily) - * [Retrieved compare-exchange items are tracked by the session](../../compare-exchange/get-cmpxchg-item.mdx#retrieved-compare-exchange-items-are-tracked-by-the-session) - * [Get item using a **store operation**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-store-operation) - * [Get compare-exchange item that has a number value and metadata](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-number-value-and-metadata) - * [Get compare-exchange item that has a custom object value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-custom-object-value) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Get compare-exchange item](#get-compare-exchange-item) + * [Get compare-exchange item lazily](#get-compare-exchange-item-lazily) + * [Retrieved compare-exchange items are tracked by the session](#retrieved-compare-exchange-items-are-tracked-by-the-session) + * [Get item using a **store operation**](#get-item-using-a-store-operation) + * [Get compare-exchange item that has a number value and metadata](#get-compare-exchange-item-that-has-a-number-value-and-metadata) + * [Get compare-exchange item that has a custom object value](#get-compare-exchange-item-that-has-a-custom-object-value) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-item-php.mdx b/docs/compare-exchange/content/_get-cmpxchg-item-php.mdx index 3578ff877b..2e65f42c38 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-item-php.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-item-php.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-item-python.mdx b/docs/compare-exchange/content/_get-cmpxchg-item-python.mdx index f4eed07d31..d6ea42c998 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-item-python.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-item-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-items-csharp.mdx b/docs/compare-exchange/content/_get-cmpxchg-items-csharp.mdx index 6630a7562a..845b46eb03 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-items-csharp.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-items-csharp.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Create sample compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx#create-sample-compare-exchange-items) - * [Get compare-exchange items by list of keys](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-list-of-keys) - * [Get compare-exchange items by prefix](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-prefix) - * [Get compare-exchange items count](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-count) - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Get compare-exchange items by list of keys](#get-compare-exchange-items-by-list-of-keys) + * [Get compare-exchange items by prefix](#get-compare-exchange-items-by-prefix) + * [Get compare-exchange items count](#get-compare-exchange-items-count) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-items-java.mdx b/docs/compare-exchange/content/_get-cmpxchg-items-java.mdx index f0ca9283ca..751b91e0e3 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-items-java.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-items-java.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Get compare-exchange items by list of keys](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-list-of-keys) - * [Get compare-exchange items by prefix](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-prefix) - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Get compare-exchange items by list of keys](#get-compare-exchange-items-by-list-of-keys) + * [Get compare-exchange items by prefix](#get-compare-exchange-items-by-prefix) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx b/docs/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx index dc7d3c484d..e7d41716da 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Create sample compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx#create-sample-compare-exchange-items) - * [Get compare-exchange items by list of keys](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-list-of-keys) - * [Get compare-exchange items by prefix](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-prefix) - * [Get compare-exchange items count](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-count) - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Get compare-exchange items by list of keys](#get-compare-exchange-items-by-list-of-keys) + * [Get compare-exchange items by prefix](#get-compare-exchange-items-by-prefix) + * [Get compare-exchange items count](#get-compare-exchange-items-count) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-items-php.mdx b/docs/compare-exchange/content/_get-cmpxchg-items-php.mdx index 7054a49319..16eb3ad106 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-items-php.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-items-php.mdx @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_get-cmpxchg-items-python.mdx b/docs/compare-exchange/content/_get-cmpxchg-items-python.mdx index 13c6ea60f6..43838787eb 100644 --- a/docs/compare-exchange/content/_get-cmpxchg-items-python.mdx +++ b/docs/compare-exchange/content/_get-cmpxchg-items-python.mdx @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_include-compare-exchange-items-csharp.mdx b/docs/compare-exchange/content/_include-compare-exchange-items-csharp.mdx index 24ea8c5374..fead32c4f3 100644 --- a/docs/compare-exchange/content/_include-compare-exchange-items-csharp.mdx +++ b/docs/compare-exchange/content/_include-compare-exchange-items-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; which means their values can be accessed later in the same session without making additional requests to the server. * In this page: - * [Sample data](../../compare-exchange/include-cmpxchg-items.mdx#sample-data) - * [Include compare-exchange items when loading](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-loading) - * [Include compare-exchange items when querying](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-querying) - * [Syntax](../../compare-exchange/include-cmpxchg-items.mdx#syntax) + * [Sample data](#sample-data) + * [Include compare-exchange items when loading](#include-compare-exchange-items-when-loading) + * [Include compare-exchange items when querying](#include-compare-exchange-items-when-querying) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx b/docs/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx index e789bc741b..a794e151c6 100644 --- a/docs/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx +++ b/docs/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; which means their values can be accessed later in the same session without making additional requests to the server. * In this page: - * [Sample data](../../compare-exchange/include-cmpxchg-items.mdx#sample-data) - * [Include compare-exchange items when loading](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-loading) - * [Include compare-exchange items when querying](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-querying) - * [Syntax](../../compare-exchange/include-cmpxchg-items.mdx#syntax) + * [Sample data](#sample-data) + * [Include compare-exchange items when loading](#include-compare-exchange-items-when-loading) + * [Include compare-exchange items when querying](#include-compare-exchange-items-when-querying) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx b/docs/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx index 5187eaa1c4..3b25e9641b 100644 --- a/docs/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx +++ b/docs/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx @@ -13,11 +13,11 @@ import CodeBlock from '@theme/CodeBlock'; or when documents in the indexed collection(s) are modified. * In this article: - * [Create sample compare-exchange items](../../compare-exchange/indexing-cmpxchg-values.mdx#create-sample-compare-exchange-items) - * [Index compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#index-compare-exchange-values) - * [Query the index](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index) - * [Query the index and project compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index-and-project-compare-exchange-values) - * [Syntax](../../compare-exchange/indexing-cmpxchg-values.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Index compare-exchange values](#index-compare-exchange-values) + * [Query the index](#query-the-index) + * [Query the index and project compare-exchange values](#query-the-index-and-project-compare-exchange-values) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_indexing-compare-exchange-values-java.mdx b/docs/compare-exchange/content/_indexing-compare-exchange-values-java.mdx index f18848462a..c1b0c3b1ca 100644 --- a/docs/compare-exchange/content/_indexing-compare-exchange-values-java.mdx +++ b/docs/compare-exchange/content/_indexing-compare-exchange-values-java.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; or when documents in the indexed collection(s) are modified. * In this page: - * [How to use](../../compare-exchange/indexing-cmpxchg-values.mdx#how-to-use) - * [Examples](../../compare-exchange/indexing-cmpxchg-values.mdx#examples) - * [Querying the Index](../../compare-exchange/indexing-cmpxchg-values.mdx#querying-the-index) + * [How to use](#how-to-use) + * [Examples](#examples) + * [Querying the Index](#querying-the-index) diff --git a/docs/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx b/docs/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx index 2561819ea3..1417eb9f85 100644 --- a/docs/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx +++ b/docs/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx @@ -13,11 +13,11 @@ import CodeBlock from '@theme/CodeBlock'; or when documents in the indexed collection(s) are modified. * In this article: - * [Create sample compare-exchange items](../../compare-exchange/indexing-cmpxchg-values.mdx#create-sample-compare-exchange-items) - * [Index compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#index-compare-exchange-values) - * [Query the index](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index) - * [Query the index and project compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index-and-project-compare-exchange-values) - * [Syntax](../../compare-exchange/indexing-cmpxchg-values.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Index compare-exchange values](#index-compare-exchange-values) + * [Query the index](#query-the-index) + * [Query the index and project compare-exchange values](#query-the-index-and-project-compare-exchange-values) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_overview-csharp.mdx b/docs/compare-exchange/content/_overview-csharp.mdx index d8e03c3533..f49123ffca 100644 --- a/docs/compare-exchange/content/_overview-csharp.mdx +++ b/docs/compare-exchange/content/_overview-csharp.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/docs/compare-exchange/content/_overview-java.mdx b/docs/compare-exchange/content/_overview-java.mdx index ffb644445f..13039f917f 100644 --- a/docs/compare-exchange/content/_overview-java.mdx +++ b/docs/compare-exchange/content/_overview-java.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/docs/compare-exchange/content/_overview-php.mdx b/docs/compare-exchange/content/_overview-php.mdx index 6a91f42772..87af84f5b4 100644 --- a/docs/compare-exchange/content/_overview-php.mdx +++ b/docs/compare-exchange/content/_overview-php.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: * [What compare-exchange items are](../../compare-exchange/overvie.mdxw#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/docs/compare-exchange/content/_overview-python.mdx b/docs/compare-exchange/content/_overview-python.mdx index b68890f7f3..dd7a9b62da 100644 --- a/docs/compare-exchange/content/_overview-python.mdx +++ b/docs/compare-exchange/content/_overview-python.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/docs/compare-exchange/content/_update-cmpxchg-item-csharp.mdx b/docs/compare-exchange/content/_update-cmpxchg-item-csharp.mdx index 753ff4f0fa..7cce357d44 100644 --- a/docs/compare-exchange/content/_update-cmpxchg-item-csharp.mdx +++ b/docs/compare-exchange/content/_update-cmpxchg-item-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Using the Studio * In this article: - * [Update compare-exchange item using a **cluster-wide session**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-cluster-wide-session) - * [Update compare-exchange item using a **store operation**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-store-operation) - * [Update compare-exchange item using the **Studio**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-the-studio) - * [Syntax](../../compare-exchange/update-cmpxchg-item.mdx#syntax) + * [Update compare-exchange item using a **cluster-wide session**](#update-compare-exchange-item-using-a-cluster-wide-session) + * [Update compare-exchange item using a **store operation**](#update-compare-exchange-item-using-a-store-operation) + * [Update compare-exchange item using the **Studio**](#update-compare-exchange-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_update-cmpxchg-item-java.mdx b/docs/compare-exchange/content/_update-cmpxchg-item-java.mdx index b92c5573cc..a254b689b9 100644 --- a/docs/compare-exchange/content/_update-cmpxchg-item-java.mdx +++ b/docs/compare-exchange/content/_update-cmpxchg-item-java.mdx @@ -29,9 +29,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Update compare-exchange item using a **store operation**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-store-operation) - * [Update compare-exchange item using the **Studio**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-the-studio) - * [Syntax](../../compare-exchange/update-cmpxchg-item.mdx#syntax) + * [Update compare-exchange item using a **store operation**](#update-compare-exchange-item-using-a-store-operation) + * [Update compare-exchange item using the **Studio**](#update-compare-exchange-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx b/docs/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx index 6cfd17520f..dfa2e1d904 100644 --- a/docs/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx +++ b/docs/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Using the Studio * In this article: - * [Update compare-exchange item using a **cluster-wide session**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-cluster-wide-session) - * [Update compare-exchange item using a **store operation**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-store-operation) - * [Update compare-exchange item using the **Studio**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-the-studio) - * [Syntax](../../compare-exchange/update-cmpxchg-item.mdx#syntax) + * [Update compare-exchange item using a **cluster-wide session**](#update-compare-exchange-item-using-a-cluster-wide-session) + * [Update compare-exchange item using a **store operation**](#update-compare-exchange-item-using-a-store-operation) + * [Update compare-exchange item using the **Studio**](#update-compare-exchange-item-using-the-studio) + * [Syntax](#syntax) diff --git a/docs/data-archival/content/_archived-documents-and-other-features-csharp.mdx b/docs/data-archival/content/_archived-documents-and-other-features-csharp.mdx index 329fb29b36..d6f9ecea11 100644 --- a/docs/data-archival/content/_archived-documents-and-other-features-csharp.mdx +++ b/docs/data-archival/content/_archived-documents-and-other-features-csharp.mdx @@ -24,16 +24,16 @@ import Panel from '@site/src/components/Panel'; * Learn more below about how various RavenDB features interact with archived documents. * In this article: - * [Archived documents and indexing](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-indexing) - * [Archived documents and querying](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-querying) - * [Archived documents and data subscriptions](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-subscriptions) - * [Archived documents and document extensions](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-document-extensions) - * [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.mdx#archived-documents-and-expiration) - * [Archived documents and ETL](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-etl) - * [Archived documents and backup](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-backup) - * [Archived documents and replication](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-replication) - * [Archived documents and patching](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-patching) + * [Archived documents and indexing](#archived-documents-and-indexing) + * [Archived documents and querying](#archived-documents-and-querying) + * [Archived documents and data subscriptions](#archived-documents-and-subscriptions) + * [Archived documents and document extensions](#archived-documents-and-document-extensions) + * [Archived documents and smuggler (export/import)](#archived-documents-and-smuggler-export-import) + * [Archived documents and expiration](#archived-documents-and-expiration) + * [Archived documents and ETL](#archived-documents-and-etl) + * [Archived documents and backup](#archived-documents-and-backup) + * [Archived documents and replication](#archived-documents-and-replication) + * [Archived documents and patching](#archived-documents-and-patching) diff --git a/docs/data-archival/content/_enable-data-archiving-csharp.mdx b/docs/data-archival/content/_enable-data-archiving-csharp.mdx index 7203941dd1..a5aea83e35 100644 --- a/docs/data-archival/content/_enable-data-archiving-csharp.mdx +++ b/docs/data-archival/content/_enable-data-archiving-csharp.mdx @@ -18,8 +18,8 @@ import Panel from '@site/src/components/Panel'; Learn how to schedule documents for archival in [Schedule document archiving](../../data-archival/schedule-document-archiving.mdx). * In this article: - * [Enable archiving - from the Client API](../../data-archival/enable-data-archiving.mdx#enable-archiving-from-the-client-api) - * [Enable archiving - from the Studio](../../data-archival/enable-data-archiving.mdx#enable-archiving-from-the-studio) + * [Enable archiving - from the Client API](#enable-archiving-from-the-client-api) + * [Enable archiving - from the Studio](#enable-archiving-from-the-studio) diff --git a/docs/data-archival/content/_schedule-document-archiving-csharp.mdx b/docs/data-archival/content/_schedule-document-archiving-csharp.mdx index 185d27a642..0da0878f2b 100644 --- a/docs/data-archival/content/_schedule-document-archiving-csharp.mdx +++ b/docs/data-archival/content/_schedule-document-archiving-csharp.mdx @@ -24,10 +24,10 @@ import Panel from '@site/src/components/Panel'; These documents will be archived once the feature is enabled and the task runs - provided the scheduled time has already passed. * In this article: - * [Schedule a SINGLE document for archiving - from the Client API](../../data-archival/schedule-document-archiving.mdx#schedule-a-single-document-for-archiving-from-the-client-api) - * [Schedule a SINGLE document for archiving - from the Studio](../../data-archival/schedule-document-archiving.mdx#schedule-a-single-document-for-archiving-from-the-studio) - * [Schedule MULTIPLE documents for archiving - from the Client API](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving-from-the-client-api) - * [Schedule MULTIPLE documents for archiving - from the Studio](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving-from-the-studio) + * [Schedule a SINGLE document for archiving - from the Client API](#schedule-a-single-document-for-archiving-from-the-client-api) + * [Schedule a SINGLE document for archiving - from the Studio](#schedule-a-single-document-for-archiving-from-the-studio) + * [Schedule MULTIPLE documents for archiving - from the Client API](#schedule-multiple-documents-for-archiving-from-the-client-api) + * [Schedule MULTIPLE documents for archiving - from the Studio](#schedule-multiple-documents-for-archiving-from-the-studio) @@ -259,7 +259,7 @@ To learn more about the `PatchByQueryOperation`, see [Set-based patch operations **Example**: The following patch script, used directly in the Studio, -performs the same operation as the [Client API example](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving-from-the-client-api) shown above. +performs the same operation as the [Client API example](#schedule-multiple-documents-for-archiving-from-the-client-api) shown above. ![Schedule multiple documents for archiving](../assets/schedule-multiple-documents-for-archiving.png) diff --git a/docs/data-archival/content/_unarchiving-documents-csharp.mdx b/docs/data-archival/content/_unarchiving-documents-csharp.mdx index 63bb7535ae..16ed16280b 100644 --- a/docs/data-archival/content/_unarchiving-documents-csharp.mdx +++ b/docs/data-archival/content/_unarchiving-documents-csharp.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; To properly unarchive a document, use the `archived.unarchive()` method as described below. * In this article: - * [Unarchive documents - from the Client API](../../data-archival/unarchiving-documents.mdx#unarchive-documents-from-the-client-api) - * [Unarchive documents - from the Studio](../../data-archival/unarchiving-documents.mdx#unarchive-documents-from-the-studio) - * [Unarchiving documents with index-based patch queries](../../data-archival/unarchiving-documents.mdx#unarchiving-documents-with-index-based-patch-queries) + * [Unarchive documents - from the Client API](#unarchive-documents-from-the-client-api) + * [Unarchive documents - from the Studio](#unarchive-documents-from-the-studio) + * [Unarchiving documents with index-based patch queries](#unarchiving-documents-with-index-based-patch-queries) @@ -142,7 +142,7 @@ archived.unarchive(doc) **Example**: The following patch script, used directly in the Studio, -performs the same operation as the [Client API example](../../data-archival/unarchiving-documents.mdx#unarchive-documents-from-the-client-api) shown above. +performs the same operation as the [Client API example](#unarchive-documents-from-the-client-api) shown above. It will unarchive all archived documents in the _Orders_ collection. ![Unarchive documents](../assets/unarchive-documents.png) diff --git a/docs/data-archival/overview.mdx b/docs/data-archival/overview.mdx index 16f4408b35..711174266a 100644 --- a/docs/data-archival/overview.mdx +++ b/docs/data-archival/overview.mdx @@ -32,12 +32,12 @@ import Panel from '@site/src/components/Panel'; * To take advantage of the archiving feature, you must first **enable** it. Once enabled, you can **schedule** documents for archiving. - Learn more in the [Overview](../data-archival/overview.mdx#overview) section below. + Learn more in the [Overview](#overview) section below. * In this article: - * [Overview](../data-archival/overview.mdx#overview) - * [The archived document](../data-archival/overview.mdx#the-archived-document) - * [Licensing](../data-archival/overview.mdx#licensing) + * [Overview](#overview) + * [The archived document](#the-archived-document) + * [Licensing](#licensing) diff --git a/docs/document-extensions/attachments/attachments-and-other-features.mdx b/docs/document-extensions/attachments/attachments-and-other-features.mdx index 583f20e6bd..37343692a5 100644 --- a/docs/document-extensions/attachments/attachments-and-other-features.mdx +++ b/docs/document-extensions/attachments/attachments-and-other-features.mdx @@ -24,10 +24,10 @@ import Panel from '@site/src/components/Panel'; [Subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx), etc. * In this article: - * [Attachments & Replication](../../document-extensions/attachments/attachments-and-other-features.mdx#attachments-replication) - * [Attachments & RavenDB ETL](../../document-extensions/attachments/attachments-and-other-features.mdx#attachments-ravendb-etl) - * [Attachments & Export/import/backup/restore](../../document-extensions/attachments/attachments-and-other-features.mdx#attachments-export-import-backup-restore) - * [Attachments & Revisions](../../document-extensions/attachments/attachments-and-other-features.mdx#attachments-revisions) + * [Attachments & Replication](#attachments-replication) + * [Attachments & RavenDB ETL](#attachments-ravendb-etl) + * [Attachments & Export/import/backup/restore](#attachments-export-import-backup-restore) + * [Attachments & Revisions](#attachments-revisions) diff --git a/docs/document-extensions/attachments/content/_configure-remote-attachments-csharp.mdx b/docs/document-extensions/attachments/content/_configure-remote-attachments-csharp.mdx index de7747e6e3..8a4a4d6a21 100644 --- a/docs/document-extensions/attachments/content/_configure-remote-attachments-csharp.mdx +++ b/docs/document-extensions/attachments/content/_configure-remote-attachments-csharp.mdx @@ -27,11 +27,11 @@ import Panel from '@site/src/components/Panel'; Attempts to configure remote attachments on sharded databases will throw an exception. * In this article: - * [Configuring remote attachments settings - from the **Studio**](../../../document-extensions/attachments/configure-remote-attachments.mdx#configuring-remote-attachments-settings-from-the-studio) - * [Configuring remote attachments settings - using the **Client API**](../../../document-extensions/attachments/configure-remote-attachments.mdx#configuring-remote-attachments-settings-using-the-client-api) - * [Configure remote attachments settings](../../../document-extensions/attachments/configure-remote-attachments.mdx#configure-remote-attachments-settings) - * [Get remote attachments settings](../../../document-extensions/attachments/configure-remote-attachments.mdx#get-remote-attachments-settings) - * [Syntax](../../../document-extensions/attachments/configure-remote-attachments.mdx#syntax) + * [Configuring remote attachments settings - from the **Studio**](#configuring-remote-attachments-settings-from-the-studio) + * [Configuring remote attachments settings - using the **Client API**](#configuring-remote-attachments-settings-using-the-client-api) + * [Configure remote attachments settings](#configure-remote-attachments-settings) + * [Get remote attachments settings](#get-remote-attachments-settings) + * [Syntax](#syntax) @@ -127,7 +127,7 @@ import Panel from '@site/src/components/Panel'; Provide the corresponding AWS secret key for this S3 bucket. 11. **Storage class** Choose an Amazon S3 storage class based on how often you access your data and its retention requirements. - For available options, see [S3StorageClass](../../../document-extensions/attachments/configure-remote-attachments.mdx#s3storageclass). Default: `STANDARD`. + For available options, see [S3StorageClass](#s3storageclass). Default: `STANDARD`. 12. **Test credentials** Click this option to verify whether the connection to the S3 storage works successfully. 13. **Apply configuration** @@ -174,7 +174,7 @@ import Panel from '@site/src/components/Panel'; * Note: Configuring remote attachment settings will **override** any existing configurations on the server. If you need to add new destinations without losing existing ones, - make sure to [Get the current remote attachmets settings](../../../document-extensions/attachments/configure-remote-attachments.mdx#get-remote-attachments-settings) first, + make sure to [Get the current remote attachmets settings](#get-remote-attachments-settings) first, update it, and then send it back to the server. * The following example demonstrates how to configure both Amazon S3 and Azure destinations: diff --git a/docs/document-extensions/attachments/content/_copy-move-rename-csharp.mdx b/docs/document-extensions/attachments/content/_copy-move-rename-csharp.mdx index a4a2303dee..2c4b4c1dfb 100644 --- a/docs/document-extensions/attachments/content/_copy-move-rename-csharp.mdx +++ b/docs/document-extensions/attachments/content/_copy-move-rename-csharp.mdx @@ -11,12 +11,12 @@ import Panel from '@site/src/components/Panel'; These actions are executed on the server when calling `SaveChanges()`. * In this article: - * [Copy attachment to another document](../../../document-extensions/attachments/copy-move-rename.mdx#copy-attachment-to-another-document) - * [Copy attachment - via the session](../../../document-extensions/attachments/copy-move-rename.mdx#copy-attachments---via-the-session) - * [Copy attachment - via patching](../../../document-extensions/attachments/copy-move-rename.mdx#copy-attachments---via-patching) - * [Move attachment to another document](../../../document-extensions/attachments/copy-move-rename.mdx#move-attachment-to-another-document) - * [Rename attachment](../../../document-extensions/attachments/copy-move-rename.mdx#rename-attachment) - * [Syntax](../../../document-extensions/attachments/copy-move-rename.mdx#syntax) + * [Copy attachment to another document](#copy-attachment-to-another-document) + * [Copy attachment - via the session](#copy-attachments---via-the-session) + * [Copy attachment - via patching](#copy-attachments---via-patching) + * [Move attachment to another document](#move-attachment-to-another-document) + * [Rename attachment](#rename-attachment) + * [Syntax](#syntax) diff --git a/docs/document-extensions/attachments/content/_copy-move-rename-nodejs.mdx b/docs/document-extensions/attachments/content/_copy-move-rename-nodejs.mdx index e519a63b19..a832770237 100644 --- a/docs/document-extensions/attachments/content/_copy-move-rename-nodejs.mdx +++ b/docs/document-extensions/attachments/content/_copy-move-rename-nodejs.mdx @@ -13,10 +13,10 @@ import Panel from '@site/src/components/Panel'; removing the need to transfer the entire attachment binary data over the network in order to perform the action. * In this page: - * [Copy attachment](../../../document-extensions/attachments/copy-move-rename.mdx#copy-attachment) - * [Move attachment](../../../document-extensions/attachments/copy-move-rename.mdx#move-attachment) - * [Rename attachment](../../../document-extensions/attachments/copy-move-rename.mdx#rename-attachment) - * [Syntax](../../../document-extensions/attachments/copy-move-rename.mdx#syntax) + * [Copy attachment](#copy-attachment) + * [Move attachment](#move-attachment) + * [Rename attachment](#rename-attachment) + * [Syntax](#syntax) diff --git a/docs/document-extensions/attachments/content/_delete-attachment-csharp.mdx b/docs/document-extensions/attachments/content/_delete-attachment-csharp.mdx index af9022db22..ec36b3ffae 100644 --- a/docs/document-extensions/attachments/content/_delete-attachment-csharp.mdx +++ b/docs/document-extensions/attachments/content/_delete-attachment-csharp.mdx @@ -24,12 +24,12 @@ import Panel from '@site/src/components/Panel'; * REMOTE attachments are not deleted from the cloud provider - you must remove them manually. * In this article: - * [Delete attachment using the **Studio**](../../../document-extensions/attachments/delete-attachment.mdx#delete-attachment-using-the-studio) - * [Delete attachment using the **Client API**](../../../document-extensions/attachments/delete-attachment.mdx#delete-attachment-using-the-client-api) - * [Delete attachment - via the session](../../../document-extensions/attachments/delete-attachment.mdx#delete-attachment---via-the-session) - * [Delete attachment - via an operation](../../../document-extensions/attachments/delete-attachment.mdx#delete-attachment---via-an-operation) - * [Delete attachment - via a patch](../../../document-extensions/attachments/delete-attachment.mdx#delete-attachment---via-a-patch) - * [Syntax](../../../document-extensions/attachments/delete-attachment.mdx#syntax) + * [Delete attachment using the **Studio**](#delete-attachment-using-the-studio) + * [Delete attachment using the **Client API**](#delete-attachment-using-the-client-api) + * [Delete attachment - via the session](#delete-attachment---via-the-session) + * [Delete attachment - via an operation](#delete-attachment---via-an-operation) + * [Delete attachment - via a patch](#delete-attachment---via-a-patch) + * [Syntax](#syntax) diff --git a/docs/document-extensions/attachments/content/_delete-attachment-java.mdx b/docs/document-extensions/attachments/content/_delete-attachment-java.mdx index e909a6fecb..73e1c5696d 100644 --- a/docs/document-extensions/attachments/content/_delete-attachment-java.mdx +++ b/docs/document-extensions/attachments/content/_delete-attachment-java.mdx @@ -10,8 +10,8 @@ import Panel from '@site/src/components/Panel'; * This article explains how to delete attachments from a document. * In this article - * [Delete attachment via the session](../../../document-extensions/attachments/delete-attachment.mdx#get-attachment-via-the-session) - * [Delete attachment via an operation](../../../document-extensions/attachments/delete-attachment.mdx#get-attachment-via-an-operation) + * [Delete attachment via the session](#get-attachment-via-the-session) + * [Delete attachment via an operation](#get-attachment-via-an-operation) diff --git a/docs/document-extensions/attachments/content/_delete-attachment-nodejs.mdx b/docs/document-extensions/attachments/content/_delete-attachment-nodejs.mdx index 8225ca2b49..2b5090bba9 100644 --- a/docs/document-extensions/attachments/content/_delete-attachment-nodejs.mdx +++ b/docs/document-extensions/attachments/content/_delete-attachment-nodejs.mdx @@ -10,8 +10,8 @@ import Panel from '@site/src/components/Panel'; * This article explains how to delete attachments from a document. * In this article - * [Delete attachment via the session](../../../document-extensions/attachments/delete-attachment.mdx#get-attachment-via-the-session) - * [Delete attachment via an operation](../../../document-extensions/attachments/delete-attachment.mdx#get-attachment-via-an-operation) + * [Delete attachment via the session](#get-attachment-via-the-session) + * [Delete attachment via an operation](#get-attachment-via-an-operation) diff --git a/docs/document-extensions/attachments/content/_get-attachments-csharp.mdx b/docs/document-extensions/attachments/content/_get-attachments-csharp.mdx index b847fb5543..232b6f23d4 100644 --- a/docs/document-extensions/attachments/content/_get-attachments-csharp.mdx +++ b/docs/document-extensions/attachments/content/_get-attachments-csharp.mdx @@ -24,15 +24,15 @@ import Panel from '@site/src/components/Panel'; Each retrieval will fetch the data again from the remote storage. * In this article: - * [Get attachments using the **Studio**](../../../document-extensions/attachments/get-attachments.mdx#get-attachments-using-the-studio) - * [Get attachments using the **Client API**](../../../document-extensions/attachments/get-attachments.mdx#get-attachments-using-the-client-api) - * [Get attachment details (excluding content)](../../../document-extensions/attachments/get-attachments.mdx#get-attachment-details-excluding-content) - * [Get single attachment from document](../../../document-extensions/attachments/get-attachments.mdx#get-single-attachment-from-document) - * [Get single attachment from revision](../../../document-extensions/attachments/get-attachments.mdx#get-single-attachment-from-revision) - * [Get multiple attachments](../../../document-extensions/attachments/get-attachments.mdx#get-multiple-attachments) - * [Get partial content](../../../document-extensions/attachments/get-attachments.mdx#get-partial-content) - * [Check if an attachment exists](../../../document-extensions/attachments/get-attachments.mdx#check-if-an-attachment-exists) - * [Syntax](../../../document-extensions/attachments/get-attachments.mdx#syntax) + * [Get attachments using the **Studio**](#get-attachments-using-the-studio) + * [Get attachments using the **Client API**](#get-attachments-using-the-client-api) + * [Get attachment details (excluding content)](#get-attachment-details-excluding-content) + * [Get single attachment from document](#get-single-attachment-from-document) + * [Get single attachment from revision](#get-single-attachment-from-revision) + * [Get multiple attachments](#get-multiple-attachments) + * [Get partial content](#get-partial-content) + * [Check if an attachment exists](#check-if-an-attachment-exists) + * [Syntax](#syntax) @@ -53,7 +53,7 @@ The file, whether stored locally or in remote storage, will be downloaded to you Returned entries include both **local** and **remote** attachments. * To get the attachment content stream as well, see the other sections below, - e.g. [Get single attachment](../../../document-extensions/attachments/get-attachments.mdx#get-single-attachment-from-document). + e.g. [Get single attachment](#get-single-attachment-from-document). @@ -639,7 +639,7 @@ public GetAttachmentOperation(string documentId, | Return value | Description | |--------------------|-------------| -| [AttachmentResult](../../../document-extensions/attachments/get-attachments.mdx#attachmentresult) | The retrieved attachment | +| [AttachmentResult](#attachmentresult) | The retrieved attachment | --- diff --git a/docs/document-extensions/attachments/content/_get-attachments-java.mdx b/docs/document-extensions/attachments/content/_get-attachments-java.mdx index 18ed980ac0..3b137242df 100644 --- a/docs/document-extensions/attachments/content/_get-attachments-java.mdx +++ b/docs/document-extensions/attachments/content/_get-attachments-java.mdx @@ -10,8 +10,8 @@ import Panel from '@site/src/components/Panel'; * This article explains how to retrieve attachments that are already stored in the database. * In this article - * [Get attachment via the session](../../../document-extensions/attachments/get-attachments.mdx#get-attachment-via-the-session) - * [Get attachment via an operation](../../../document-extensions/attachments/get-attachments.mdx#get-attachment-via-an-operation) + * [Get attachment via the session](#get-attachment-via-the-session) + * [Get attachment via an operation](#get-attachment-via-an-operation) diff --git a/docs/document-extensions/attachments/content/_get-attachments-nodejs.mdx b/docs/document-extensions/attachments/content/_get-attachments-nodejs.mdx index 08e6367b21..e6ed714daa 100644 --- a/docs/document-extensions/attachments/content/_get-attachments-nodejs.mdx +++ b/docs/document-extensions/attachments/content/_get-attachments-nodejs.mdx @@ -10,8 +10,8 @@ import Panel from '@site/src/components/Panel'; * This article explains how to retrieve attachments that are already stored in the database. * In this article - * [Get attachment via the session](../../../document-extensions/attachments/get-attachments.mdx#get-attachment-via-the-session) - * [Get attachment via an operation](../../../document-extensions/attachments/get-attachments.mdx#get-attachment-via-an-operation) + * [Get attachment via the session](#get-attachment-via-the-session) + * [Get attachment via an operation](#get-attachment-via-an-operation) diff --git a/docs/document-extensions/attachments/content/_indexing-attachments-csharp.mdx b/docs/document-extensions/attachments/content/_indexing-attachments-csharp.mdx index 826593fcc3..404df7212b 100644 --- a/docs/document-extensions/attachments/content/_indexing-attachments-csharp.mdx +++ b/docs/document-extensions/attachments/content/_indexing-attachments-csharp.mdx @@ -18,11 +18,11 @@ import Panel from '@site/src/components/Panel'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Index attachments details](../../../document-extensions/attachments/indexing-attachments.mdx#index-attachments-details) - * [Index details & content - for specific attachment name](../../../document-extensions/attachments/indexing-attachments.mdx#index-details-content-for-specific-attachment-name) - * [Index details & content - for all attachments](../../../document-extensions/attachments/indexing-attachments.mdx#index-details-content-for-all-attachments) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing-attachments.mdx#leveraging-indexed-attachments) - * [Syntax](../../../document-extensions/attachments/indexing-attachments.mdx#syntax) + * [Index attachments details](#index-attachments-details) + * [Index details & content - for specific attachment name](#index-details-content-for-specific-attachment-name) + * [Index details & content - for all attachments](#index-details-content-for-all-attachments) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) + * [Syntax](#syntax) @@ -37,7 +37,7 @@ import Panel from '@site/src/components/Panel'; Once the index is deployed, you can query the index to find Employee documents based on these attachment properties. * Indexing attachment details is supported for both **local** and **remote** attachments. - To index attachment content, see the examples [below](../../../document-extensions/attachments/indexing-attachments.mdx#index-details--content---by-attachment-name). + To index attachment content, see the examples [below](#index-details--content---by-attachment-name). diff --git a/docs/document-extensions/attachments/content/_indexing-attachments-java.mdx b/docs/document-extensions/attachments/content/_indexing-attachments-java.mdx index 3dfeb22e56..595ab093bf 100644 --- a/docs/document-extensions/attachments/content/_indexing-attachments-java.mdx +++ b/docs/document-extensions/attachments/content/_indexing-attachments-java.mdx @@ -16,9 +16,9 @@ import Panel from '@site/src/components/Panel'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Syntax](../../../document-extensions/attachments/indexing-attachments.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing-attachments.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing-attachments.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/docs/document-extensions/attachments/content/_indexing-attachments-nodejs.mdx b/docs/document-extensions/attachments/content/_indexing-attachments-nodejs.mdx index 0d6ffc7cb0..550358222b 100644 --- a/docs/document-extensions/attachments/content/_indexing-attachments-nodejs.mdx +++ b/docs/document-extensions/attachments/content/_indexing-attachments-nodejs.mdx @@ -16,11 +16,11 @@ import Panel from '@site/src/components/Panel'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Index attachments details](../../../document-extensions/attachments/indexing-attachments.mdx#index-attachments-details) - * [Index details & content - for specific attachment name](../../../document-extensions/attachments/indexing-attachments.mdx#index-details--content---for-specific-attachment-name) - * [Index details & content - for all attachments](../../../document-extensions/attachments/indexing-attachments.mdx#index-details--content---for-all-attachments) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing-attachments.mdx#leveraging-indexed-attachments) - * [Syntax](../../../document-extensions/attachments/indexing-attachments.mdx#syntax) + * [Index attachments details](#index-attachments-details) + * [Index details & content - for specific attachment name](#index-details--content---for-specific-attachment-name) + * [Index details & content - for all attachments](#index-details--content---for-all-attachments) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) + * [Syntax](#syntax) @@ -35,7 +35,7 @@ import Panel from '@site/src/components/Panel'; These details can be used to define the index-fields. Once the index is deployed, you can query the index to find Employee documents based on these attachment properties. -* To index **attachments' content**, see the examples [below](../../../document-extensions/attachments/indexing-attachments.mdx#index-details--content---by-attachment-name). +* To index **attachments' content**, see the examples [below](#index-details--content---by-attachment-name). diff --git a/docs/document-extensions/attachments/content/_indexing-attachments-php.mdx b/docs/document-extensions/attachments/content/_indexing-attachments-php.mdx index f33b42858d..63e732e9cf 100644 --- a/docs/document-extensions/attachments/content/_indexing-attachments-php.mdx +++ b/docs/document-extensions/attachments/content/_indexing-attachments-php.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; * In this page: - * [Syntax](../../../document-extensions/attachments/indexing-attachments.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing-attachments.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing-attachments.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/docs/document-extensions/attachments/content/_indexing-attachments-python.mdx b/docs/document-extensions/attachments/content/_indexing-attachments-python.mdx index 482a206453..e717531ce3 100644 --- a/docs/document-extensions/attachments/content/_indexing-attachments-python.mdx +++ b/docs/document-extensions/attachments/content/_indexing-attachments-python.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; * In this page: - * [Syntax](../../../document-extensions/attachments/indexing-attachments.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing-attachments.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing-attachments.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/docs/document-extensions/attachments/content/_overview-csharp.mdx b/docs/document-extensions/attachments/content/_overview-csharp.mdx index b339c4e1f4..098a28c17c 100644 --- a/docs/document-extensions/attachments/content/_overview-csharp.mdx +++ b/docs/document-extensions/attachments/content/_overview-csharp.mdx @@ -28,9 +28,9 @@ import Panel from '@site/src/components/Panel'; See [Store attachments in remote storage](../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx). * In this article: - * [Attachments in the documents list view](../../../document-extensions/attachments/overview.mdx#attachments-in-the-documents-list-view) - * [Attachments in the document view](../../../document-extensions/attachments/overview.mdx#attachments-in-the-document-view) - * [Attachments stats](../../../document-extensions/attachments/overview.mdx#attachments-stats) + * [Attachments in the documents list view](#attachments-in-the-documents-list-view) + * [Attachments in the document view](#attachments-in-the-document-view) + * [Attachments stats](#attachments-stats) diff --git a/docs/document-extensions/attachments/faq.mdx b/docs/document-extensions/attachments/faq.mdx index 8622f4ee1b..bcdaf4081e 100644 --- a/docs/document-extensions/attachments/faq.mdx +++ b/docs/document-extensions/attachments/faq.mdx @@ -11,13 +11,13 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [Is there a size limit for attachments?](../../document-extensions/attachments/faq.mdx#is-there-a-size-limit-for-attachments) - * [Does document compression affect attachments?](../../document-extensions/attachments/faq.mdx#does-document-compression-affect-attachments) - * [What happens to attachments when I delete a document?](../../document-extensions/attachments/faq.mdx#what-happens-to-attachments-when-i-delete-a-document) - * [Are REMOTE attachments included in backups?](../../document-extensions/attachments/faq.mdx#are-remote-attachments-included-in-backups) - * [Are REMOTE attachments cached locally after retrieval?](../../document-extensions/attachments/faq.mdx#are-remote-attachments-cached-locally-after-retrieval) - * [Are REMOTE attachments supported with sharded databases?](../../document-extensions/attachments/faq.mdx#are-remote-attachments-supported-with-sharded-databases) - * [What happens to REMOTE attachments if I delete my database?](../../document-extensions/attachments/faq.mdx#what-happens-to-remote-attachments-if-i-delete-my-database) + * [Is there a size limit for attachments?](#is-there-a-size-limit-for-attachments) + * [Does document compression affect attachments?](#does-document-compression-affect-attachments) + * [What happens to attachments when I delete a document?](#what-happens-to-attachments-when-i-delete-a-document) + * [Are REMOTE attachments included in backups?](#are-remote-attachments-included-in-backups) + * [Are REMOTE attachments cached locally after retrieval?](#are-remote-attachments-cached-locally-after-retrieval) + * [Are REMOTE attachments supported with sharded databases?](#are-remote-attachments-supported-with-sharded-databases) + * [What happens to REMOTE attachments if I delete my database?](#what-happens-to-remote-attachments-if-i-delete-my-database) diff --git a/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-csharp.mdx b/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-csharp.mdx index c223713e92..36561e304f 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-csharp.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-csharp.mdx @@ -11,11 +11,11 @@ import Panel from '@site/src/components/Panel'; storing attachments alongside documents in a high-throughput, streamed process that avoids sending a separate request for each attachment. * In this article: - * [What is Bulk Insert](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#what-is-bulk-insert) - * [Inserting attachment with Bulk Insert](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#inserting-attachments-with-bulk-insert) - * [Bulk Insert attachments - Local storage](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#bulk-insert-attachments-local-storage) - * [Bulk Insert attachments - Remote storage](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#bulk-insert-attachments-remote-storage) - * [Syntax](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#syntax) + * [What is Bulk Insert](#what-is-bulk-insert) + * [Inserting attachment with Bulk Insert](#inserting-attachments-with-bulk-insert) + * [Bulk Insert attachments - Local storage](#bulk-insert-attachments-local-storage) + * [Bulk Insert attachments - Remote storage](#bulk-insert-attachments-remote-storage) + * [Syntax](#syntax) diff --git a/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-nodejs.mdx b/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-nodejs.mdx index e4227f2bef..306843f1b7 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-nodejs.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-nodejs.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; Use its `attachmentsFor` interface to add attachments to documents with great speed. * In this page: - * [Usage flow](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#usage-example) - * [Syntax](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#syntax) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) + * [Syntax](#syntax) diff --git a/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-python.mdx b/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-python.mdx index 7b96efc01d..0253dbfd65 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-python.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_bulk-insert-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; Use its `attachments_for` interface to add attachments to multiple documents with great speed. * In this page: - * [Usage flow](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../../document-extensions/attachments/store-attachments/bulk-insert.mdx#usage-example) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) diff --git a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-csharp.mdx b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-csharp.mdx index 4903ab9bb9..d704913b31 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-csharp.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-csharp.mdx @@ -11,14 +11,14 @@ import Panel from '@site/src/components/Panel'; To learn about remote storage, see [Store attachments in remote storage](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx). * In this article - * [Overview](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#overview) - * [Store attachments using the **Studio**](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachments-using-the-studio) - * [Store attachments using the **Client API**](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachments-using-the-client-api) - * [Store via the Session](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachments-via-the-session) - * [Store via an Operation](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachments-via-an-operation) - * [The attachment metadata](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#the-attachment-metadata) - * [Deduplicating local attachments](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#deduplicating-local-attachments) - * [Syntax](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#syntax) + * [Overview](#overview) + * [Store attachments using the **Studio**](#store-attachments-using-the-studio) + * [Store attachments using the **Client API**](#store-attachments-using-the-client-api) + * [Store via the Session](#store-attachments-via-the-session) + * [Store via an Operation](#store-attachments-via-an-operation) + * [The attachment metadata](#the-attachment-metadata) + * [Deduplicating local attachments](#deduplicating-local-attachments) + * [Syntax](#syntax) @@ -57,7 +57,7 @@ You can add and manage attachments directly in the Studio. It only shows the `@flags` property with the value `HasAttachments` in the document's `@metadata` section to indicate that the document has attachments. 5. Click this JSON button to view the document's raw content, including its full metadata. - Learn more about the attachment metadata in [The attachment metadata](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#the-attachment-metadata). + Learn more about the attachment metadata in [The attachment metadata](#the-attachment-metadata). @@ -335,7 +335,7 @@ public PutAttachmentOperation(string documentId, StoreAttachmentParameters param | Return value | Description | |----------------------|---------------------------------------------| -| [AttachmentDetails](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#attachmentdetails) | An object with the new attachment's details | +| [AttachmentDetails](#attachmentdetails) | An object with the new attachment's details | --- diff --git a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-java.mdx b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-java.mdx index e444b39985..a20ec82274 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-java.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-java.mdx @@ -24,8 +24,8 @@ import Panel from '@site/src/components/Panel'; the new content will replace the existing content in the local storage. * In this article - * [Store attachment via the session](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachment-via-the-session) - * [Store attachment via an operation](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachment-via-an-operation) + * [Store attachment via the session](#store-attachment-via-the-session) + * [Store attachment via an operation](#store-attachment-via-an-operation) diff --git a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-nodejs.mdx b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-nodejs.mdx index 3e1474a02a..a80d7998da 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-nodejs.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-local-nodejs.mdx @@ -24,8 +24,8 @@ import Panel from '@site/src/components/Panel' the new content will replace the existing content in the local storage. * In this article - * [Store attachment via the session](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachment-via-the-session) - * [Store attachment via an operation](../../../../document-extensions/attachments/store-attachments/store-attachments-local.mdx#store-attachment-via-an-operation) + * [Store attachment via the session](#store-attachment-via-the-session) + * [Store attachment via an operation](#store-attachment-via-an-operation) diff --git a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-remote-csharp.mdx b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-remote-csharp.mdx index 54ec1f0c37..f013c4f33d 100644 --- a/docs/document-extensions/attachments/store-attachments/content/_store-attachments-remote-csharp.mdx +++ b/docs/document-extensions/attachments/store-attachments/content/_store-attachments-remote-csharp.mdx @@ -17,17 +17,17 @@ import Panel from '@site/src/components/Panel'; See [Configure remote attachments](../../../../document-extensions/attachments/configure-remote-attachments.mdx). * In this article - * [Overview](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#overview) - * [Remote attachment upload - flow](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#remote-attachment-upload---flow) - * [Remote attachment upload – considerations](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#remote-attachment-upload--considerations) - * [Store attachments remotely - using the **Studio**](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#store-attachments-remotely-using-the-studio) - * [Store attachments remotely - using the **Client API**](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#store-attachments-remotely-using-the-client-api) - * [Store via the Session](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#store-attachments-remotely---via-the-session) - * [Store via an Operation](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#store-attachments-remotely---via-an-operation) - * [Schedule existing attachments for remote upload](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#schedule-existing-attachments-for-remote-upload) - * [The attachment metadata](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#the-attachment-metadata) - * [Deduplicating remote attachments](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#deduplicating-remote-attachments) - * [Syntax](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#syntax) + * [Overview](#overview) + * [Remote attachment upload - flow](#remote-attachment-upload---flow) + * [Remote attachment upload – considerations](#remote-attachment-upload--considerations) + * [Store attachments remotely - using the **Studio**](#store-attachments-remotely-using-the-studio) + * [Store attachments remotely - using the **Client API**](#store-attachments-remotely-using-the-client-api) + * [Store via the Session](#store-attachments-remotely---via-the-session) + * [Store via an Operation](#store-attachments-remotely---via-an-operation) + * [Schedule existing attachments for remote upload](#schedule-existing-attachments-for-remote-upload) + * [The attachment metadata](#the-attachment-metadata) + * [Deduplicating remote attachments](#deduplicating-remote-attachments) + * [Syntax](#syntax) @@ -121,7 +121,7 @@ import Panel from '@site/src/components/Panel'; It only shows the `@flags` property with the value `HasAttachments` in the document's `@metadata` section to indicate that the document has attachments. 4. Click this JSON button to view the document's raw content, including its full metadata. - Learn more about the attachment metadata in [The attachment metadata](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#the-attachment-metadata). + Learn more about the attachment metadata in [The attachment metadata](#the-attachment-metadata). ![Add attachment to remote storage 4](../assets/add-attachment-to-remote-storage-4.png) @@ -374,7 +374,7 @@ await using (var stream = new FileStream(attachmentPath, * Once patching is successful: * The document's metadata is updated with the requested remote attachment parameters, - as described in [The attachment metadata](../../../../document-extensions/attachments/store-attachments/store-attachments-remote.mdx#the-attachment-metadata). + as described in [The attachment metadata](#the-attachment-metadata). * If the feature is enabled and destinations are defined (see [Configure remote attachments](../../../../document-extensions/attachments/configure-remote-attachments.mdx)), the background task will upload the attachment to the specified remote destination when the scheduled time arrives. diff --git a/docs/document-extensions/counters/content/_counters-and-other-features-csharp.mdx b/docs/document-extensions/counters/content/_counters-and-other-features-csharp.mdx index 863dfb6f88..4358f0507f 100644 --- a/docs/document-extensions/counters/content/_counters-and-other-features-csharp.mdx +++ b/docs/document-extensions/counters/content/_counters-and-other-features-csharp.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -38,7 +38,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -163,7 +163,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -210,16 +210,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/docs/document-extensions/counters/content/_counters-and-other-features-java.mdx b/docs/document-extensions/counters/content/_counters-and-other-features-java.mdx index 70d4cd51cd..ccfd1cf30a 100644 --- a/docs/document-extensions/counters/content/_counters-and-other-features-java.mdx +++ b/docs/document-extensions/counters/content/_counters-and-other-features-java.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -37,7 +37,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be projected from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -158,7 +158,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -204,15 +204,15 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | ### Counters Bulk-Insert diff --git a/docs/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx b/docs/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx index 09be7ff504..f35bd69e24 100644 --- a/docs/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx +++ b/docs/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -37,7 +37,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -159,7 +159,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -205,16 +205,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | ### Counters Bulk-Insert diff --git a/docs/document-extensions/counters/content/_counters-and-other-features-php.mdx b/docs/document-extensions/counters/content/_counters-and-other-features-php.mdx index d0fa48b7f5..97c903f287 100644 --- a/docs/document-extensions/counters/content/_counters-and-other-features-php.mdx +++ b/docs/document-extensions/counters/content/_counters-and-other-features-php.mdx @@ -10,12 +10,12 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL` + * [Counters and Other Features: summary](#counters-and-other-features-summary) @@ -35,7 +35,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Send the server **raw queries** for execution. * You can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get counter values from a query without downloading whole documents. @@ -150,14 +150,14 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/docs/document-extensions/counters/content/_counters-and-other-features-python.mdx b/docs/document-extensions/counters/content/_counters-and-other-features-python.mdx index 891730050c..09802277aa 100644 --- a/docs/document-extensions/counters/content/_counters-and-other-features-python.mdx +++ b/docs/document-extensions/counters/content/_counters-and-other-features-python.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -36,7 +36,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -119,7 +119,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -165,16 +165,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/docs/document-extensions/counters/content/_create-or-modify-csharp.mdx b/docs/document-extensions/counters/content/_create-or-modify-csharp.mdx index 686ff98437..16ea3ed57f 100644 --- a/docs/document-extensions/counters/content/_create-or-modify-csharp.mdx +++ b/docs/document-extensions/counters/content/_create-or-modify-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `CountersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`Increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`Increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `Increment` usage diff --git a/docs/document-extensions/counters/content/_create-or-modify-java.mdx b/docs/document-extensions/counters/content/_create-or-modify-java.mdx index 8ca6e85d3c..c2431a76a3 100644 --- a/docs/document-extensions/counters/content/_create-or-modify-java.mdx +++ b/docs/document-extensions/counters/content/_create-or-modify-java.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` uage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` uage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/docs/document-extensions/counters/content/_create-or-modify-nodejs.mdx b/docs/document-extensions/counters/content/_create-or-modify-nodejs.mdx index e0bb3cfe9d..4dfdc4e297 100644 --- a/docs/document-extensions/counters/content/_create-or-modify-nodejs.mdx +++ b/docs/document-extensions/counters/content/_create-or-modify-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `Increment` usage diff --git a/docs/document-extensions/counters/content/_create-or-modify-php.mdx b/docs/document-extensions/counters/content/_create-or-modify-php.mdx index ade9c52fa4..af77652f9d 100644 --- a/docs/document-extensions/counters/content/_create-or-modify-php.mdx +++ b/docs/document-extensions/counters/content/_create-or-modify-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/docs/document-extensions/counters/content/_create-or-modify-python.mdx b/docs/document-extensions/counters/content/_create-or-modify-python.mdx index d87e9dbff7..eede5973ac 100644 --- a/docs/document-extensions/counters/content/_create-or-modify-python.mdx +++ b/docs/document-extensions/counters/content/_create-or-modify-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `counters_for ` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/docs/document-extensions/counters/content/_delete-csharp.mdx b/docs/document-extensions/counters/content/_delete-csharp.mdx index f585cbc7f6..34a37e8bfe 100644 --- a/docs/document-extensions/counters/content/_delete-csharp.mdx +++ b/docs/document-extensions/counters/content/_delete-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `CountersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`Delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`Delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `Delete ` usage diff --git a/docs/document-extensions/counters/content/_delete-java.mdx b/docs/document-extensions/counters/content/_delete-java.mdx index 14ae398fe3..ef88364085 100644 --- a/docs/document-extensions/counters/content/_delete-java.mdx +++ b/docs/document-extensions/counters/content/_delete-java.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/docs/document-extensions/counters/content/_delete-nodejs.mdx b/docs/document-extensions/counters/content/_delete-nodejs.mdx index b2ff732097..38c26eca35 100644 --- a/docs/document-extensions/counters/content/_delete-nodejs.mdx +++ b/docs/document-extensions/counters/content/_delete-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/docs/document-extensions/counters/content/_delete-php.mdx b/docs/document-extensions/counters/content/_delete-php.mdx index 7d84ed481b..daee209c83 100644 --- a/docs/document-extensions/counters/content/_delete-php.mdx +++ b/docs/document-extensions/counters/content/_delete-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete` usage diff --git a/docs/document-extensions/counters/content/_delete-python.mdx b/docs/document-extensions/counters/content/_delete-python.mdx index f947d7a552..6c1b890dfb 100644 --- a/docs/document-extensions/counters/content/_delete-python.mdx +++ b/docs/document-extensions/counters/content/_delete-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `counters_for` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/docs/document-extensions/counters/content/_including-counters-csharp.mdx b/docs/document-extensions/counters/content/_including-counters-csharp.mdx index 5e151c5ee0..59d495ac52 100644 --- a/docs/document-extensions/counters/content/_including-counters-csharp.mdx +++ b/docs/document-extensions/counters/content/_including-counters-csharp.mdx @@ -17,18 +17,18 @@ import Panel from '@site/src/components/Panel'; [Create subscription - include counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). * In this article: - * [Sample data](../../../document-extensions/counters/including-counters.mdx#sample-data) - * [Include counters when **loading**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-loading) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters) - * [Include counters when **querying**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-querying) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter-1) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters-1) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters-1) - * [Including multiple item types](../../../document-extensions/counters/including-counters.mdx#including-multiple-item-types) - * [Include behavior and constraints](../../../document-extensions/counters/including-counters.mdx#include-behavior-and-constraints) - * [Syntax](../../../document-extensions/counters/including-counters.mdx#syntax) + * [Sample data](#sample-data) + * [Include counters when **loading**](#include-counters-when-loading) + * [Include single counter](#include-single-counter) + * [Include multiple counters](#include-multiple-counters) + * [Include all counters](#include-all-counters) + * [Include counters when **querying**](#include-counters-when-querying) + * [Include single counter](#include-single-counter-1) + * [Include multiple counters](#include-multiple-counters-1) + * [Include all counters](#include-all-counters-1) + * [Including multiple item types](#including-multiple-item-types) + * [Include behavior and constraints](#include-behavior-and-constraints) + * [Syntax](#syntax) @@ -631,8 +631,8 @@ using (var session = store.OpenSession(new SessionOptions The following sections describe behavior that applies when including counters - whether during **load or query**: -* [Counters that don't exist at include time](../../../document-extensions/counters/including-counters.mdx#counters-that-dont-exist-at-include-time) -* [Do not mix IncludeAllCounters with individual counter includes](../../../document-extensions/counters/including-counters.mdx#do-not-mix-includeallcounters-with-individual-counter-includes) +* [Counters that don't exist at include time](#counters-that-dont-exist-at-include-time) +* [Do not mix IncludeAllCounters with individual counter includes](#do-not-mix-includeallcounters-with-individual-counter-includes) --- diff --git a/docs/document-extensions/counters/content/_including-counters-nodejs.mdx b/docs/document-extensions/counters/content/_including-counters-nodejs.mdx index fb594c3473..93f2912779 100644 --- a/docs/document-extensions/counters/content/_including-counters-nodejs.mdx +++ b/docs/document-extensions/counters/content/_including-counters-nodejs.mdx @@ -17,18 +17,18 @@ import Panel from '@site/src/components/Panel'; [Create subscription - include counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). * In this article: - * [Sample data](../../../document-extensions/counters/including-counters.mdx#sample-data) - * [Include counters when **loading**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-loading) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters) - * [Include counters when **querying**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-querying) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter-1) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters-1) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters-1) - * [Including multiple item types](../../../document-extensions/counters/including-counters.mdx#including-multiple-item-types) - * [Include behavior and constraints](../../../document-extensions/counters/including-counters.mdx#include-behavior-and-constraints) - * [Syntax](../../../document-extensions/counters/including-counters.mdx#syntax) + * [Sample data](#sample-data) + * [Include counters when **loading**](#include-counters-when-loading) + * [Include single counter](#include-single-counter) + * [Include multiple counters](#include-multiple-counters) + * [Include all counters](#include-all-counters) + * [Include counters when **querying**](#include-counters-when-querying) + * [Include single counter](#include-single-counter-1) + * [Include multiple counters](#include-multiple-counters-1) + * [Include all counters](#include-all-counters-1) + * [Including multiple item types](#including-multiple-item-types) + * [Include behavior and constraints](#include-behavior-and-constraints) + * [Syntax](#syntax) @@ -411,8 +411,8 @@ const product = await session.load("products/1-A", { The following sections describe behavior that applies when including counters - whether during **load or query**: -* [Counters that don't exist at include time](../../../document-extensions/counters/including-counters.mdx#counters-that-dont-exist-at-include-time) -* [Do not mix IncludeAllCounters with individual counter includes](../../../document-extensions/counters/including-counters.mdx#do-not-mix-includeallcounters-with-individual-counter-includes) +* [Counters that don't exist at include time](#counters-that-dont-exist-at-include-time) +* [Do not mix IncludeAllCounters with individual counter includes](#do-not-mix-includeallcounters-with-individual-counter-includes) --- diff --git a/docs/document-extensions/counters/content/_indexing-csharp.mdx b/docs/document-extensions/counters/content/_indexing-csharp.mdx index b29f514b68..5668586e49 100644 --- a/docs/document-extensions/counters/content/_indexing-csharp.mdx +++ b/docs/document-extensions/counters/content/_indexing-csharp.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/docs/document-extensions/counters/content/_indexing-java.mdx b/docs/document-extensions/counters/content/_indexing-java.mdx index e342f170a1..7427114c1b 100644 --- a/docs/document-extensions/counters/content/_indexing-java.mdx +++ b/docs/document-extensions/counters/content/_indexing-java.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/docs/document-extensions/counters/content/_indexing-nodejs.mdx b/docs/document-extensions/counters/content/_indexing-nodejs.mdx index 9ddac7ee83..0282b47914 100644 --- a/docs/document-extensions/counters/content/_indexing-nodejs.mdx +++ b/docs/document-extensions/counters/content/_indexing-nodejs.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask ` or `AbstractRawJavaScrip * Auto-indexes for counters are not available at this time. * In this page: - * [Usage](../../../document-extensions/counters/indexing.mdx#usage) - * [AbstractCsharpCountersIndexCreationTask ](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Usage](#usage) + * [AbstractCsharpCountersIndexCreationTask ](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Usage diff --git a/docs/document-extensions/counters/content/_indexing-php.mdx b/docs/document-extensions/counters/content/_indexing-php.mdx index 59042cb3e6..132f160803 100644 --- a/docs/document-extensions/counters/content/_indexing-php.mdx +++ b/docs/document-extensions/counters/content/_indexing-php.mdx @@ -11,9 +11,9 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section) ## Syntax diff --git a/docs/document-extensions/counters/content/_indexing-python.mdx b/docs/document-extensions/counters/content/_indexing-python.mdx index 3b10b00c0d..781e452cfc 100644 --- a/docs/document-extensions/counters/content/_indexing-python.mdx +++ b/docs/document-extensions/counters/content/_indexing-python.mdx @@ -11,9 +11,9 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section) ## Syntax diff --git a/docs/document-extensions/counters/content/_overview-csharp.mdx b/docs/document-extensions/counters/content/_overview-csharp.mdx index 2e184cc5c0..d50dc693bf 100644 --- a/docs/document-extensions/counters/content/_overview-csharp.mdx +++ b/docs/document-extensions/counters/content/_overview-csharp.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `CountersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `CountersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/docs/document-extensions/counters/content/_overview-java.mdx b/docs/document-extensions/counters/content/_overview-java.mdx index 9ee2f16a00..b7842ae2e2 100644 --- a/docs/document-extensions/counters/content/_overview-java.mdx +++ b/docs/document-extensions/counters/content/_overview-java.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `CountersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `CountersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/docs/document-extensions/counters/content/_overview-nodejs.mdx b/docs/document-extensions/counters/content/_overview-nodejs.mdx index 904972b831..b609e03147 100644 --- a/docs/document-extensions/counters/content/_overview-nodejs.mdx +++ b/docs/document-extensions/counters/content/_overview-nodejs.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `countersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `countersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/docs/document-extensions/counters/content/_overview-php.mdx b/docs/document-extensions/counters/content/_overview-php.mdx index 4e3ea4b0a8..387bb228f8 100644 --- a/docs/document-extensions/counters/content/_overview-php.mdx +++ b/docs/document-extensions/counters/content/_overview-php.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `countersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `countersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/docs/document-extensions/counters/content/_overview-python.mdx b/docs/document-extensions/counters/content/_overview-python.mdx index ca3a47d7e6..52242de71d 100644 --- a/docs/document-extensions/counters/content/_overview-python.mdx +++ b/docs/document-extensions/counters/content/_overview-python.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `counters_for` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `counters_for` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/docs/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx b/docs/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx index 3b08d5d219..e3ec07db42 100644 --- a/docs/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx +++ b/docs/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/docs/document-extensions/counters/content/_retrieve-counter-values-java.mdx b/docs/document-extensions/counters/content/_retrieve-counter-values-java.mdx index 80b4df4ea1..5749da8aea 100644 --- a/docs/document-extensions/counters/content/_retrieve-counter-values-java.mdx +++ b/docs/document-extensions/counters/content/_retrieve-counter-values-java.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/docs/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx b/docs/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx index 9e2ad7e9a4..ec1b8cfbc0 100644 --- a/docs/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx +++ b/docs/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/docs/document-extensions/counters/content/_retrieve-counter-values-php.mdx b/docs/document-extensions/counters/content/_retrieve-counter-values-php.mdx index d69751a8f8..db77e5bf6f 100644 --- a/docs/document-extensions/counters/content/_retrieve-counter-values-php.mdx +++ b/docs/document-extensions/counters/content/_retrieve-counter-values-php.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get values of specific counters](../../../document-extensions/counters/retrieve-counter-values.mdx#get-values-of-specific-counters) - * [`get` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage) - * [`get` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example) - * [`get` syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [`getAll` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage-1) - * [`getAll` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example-1) - * [`getAll` Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax-1) + * [Get values of specific counters](#get-values-of-specific-counters) + * [`get` usage](#usage) + * [`get` example](#example) + * [`get` syntax](#syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [`getAll` usage](#usage-1) + * [`getAll` example](#example-1) + * [`getAll` Syntax](#syntax-1) ## Get values of specific counters diff --git a/docs/document-extensions/counters/content/_retrieve-counter-values-python.mdx b/docs/document-extensions/counters/content/_retrieve-counter-values-python.mdx index 749d5ad883..1853138c55 100644 --- a/docs/document-extensions/counters/content/_retrieve-counter-values-python.mdx +++ b/docs/document-extensions/counters/content/_retrieve-counter-values-python.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [`get` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage) - * [`get` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example) - * [`get` syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [`get_all` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage-1) - * [`get_all` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example-1) - * [`get_all` Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax-1) + * [Get a single Counter's value](#get-a-single-counter) + * [`get` usage](#usage) + * [`get` example](#example) + * [`get` syntax](#syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [`get_all` usage](#usage-1) + * [`get_all` example](#example-1) + * [`get_all` Syntax](#syntax-1) ## Get a single Counter's value diff --git a/docs/document-extensions/counters/counters-in-clusters.mdx b/docs/document-extensions/counters/counters-in-clusters.mdx index 5a9f585fc5..e0a116a8b1 100644 --- a/docs/document-extensions/counters/counters-in-clusters.mdx +++ b/docs/document-extensions/counters/counters-in-clusters.mdx @@ -22,14 +22,14 @@ import Panel from '@site/src/components/Panel'; * When conflicting actions (such as _Delete_ and _Increment_) may occur, and how they are resolved * In this article: - * [Counter value modification](../../document-extensions/counters/counters-in-clusters.mdx#counter-value-modification) - * [Value modification and replication flow](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication-flow) - * [Reading a Counter's value](../../document-extensions/counters/counters-in-clusters.mdx#reading-a-counters-value) - * [Counter name modification](../../document-extensions/counters/counters-in-clusters.mdx#counter-name-modification) - * [Concurrent value modification](../../document-extensions/counters/counters-in-clusters.mdx#concurrent-value-modification) - * [Concurrent `Delete` and `Increment`](../../document-extensions/counters/counters-in-clusters.mdx#concurrent-delete-and-increment) - * [In a single-node system](../../document-extensions/counters/counters-in-clusters.mdx#in-a-single-node-system) - * [In a multi-node cluster](../../document-extensions/counters/counters-in-clusters.mdx#in-a-multi-node-cluster) + * [Counter value modification](#counter-value-modification) + * [Value modification and replication flow](#value-modification-and-replication-flow) + * [Reading a Counter's value](#reading-a-counters-value) + * [Counter name modification](#counter-name-modification) + * [Concurrent value modification](#concurrent-value-modification) + * [Concurrent `Delete` and `Increment`](#concurrent-delete-and-increment) + * [In a single-node system](#in-a-single-node-system) + * [In a multi-node cluster](#in-a-multi-node-cluster) @@ -58,7 +58,7 @@ In the following example: | ProductLikes | **B** | **33** | | ProductLikes | C | 10 | -After a Counter’s value is modified on a node, that node [replicates](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication) +After a Counter’s value is modified on a node, that node [replicates](#value-modification-and-replication) the updated value to all other nodes in the cluster. In the above example: * The "ProductLikes" Counter was incremented by 5 on node B. @@ -105,7 +105,7 @@ In the following example: **The same Counter can be concurrently modified by multiple clients**. -As explained in the [Value modification and replication flow](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication-flow) section, +As explained in the [Value modification and replication flow](#value-modification-and-replication-flow) section, each node manages its own portion of a Counter’s value independently. As a result: diff --git a/docs/document-extensions/overview.mdx b/docs/document-extensions/overview.mdx index 1744b3d2f7..ee4be5a649 100644 --- a/docs/document-extensions/overview.mdx +++ b/docs/document-extensions/overview.mdx @@ -28,8 +28,8 @@ import Panel from '@site/src/components/Panel'; Learn more in [Sharding: Document Extensions](../sharding/document-extensions.mdx). * In this article: - * [Document extensions](../document-extensions/overview.mdx#document-extensions) - * [Document extensions in the Studio](../document-extensions/overview.mdx#document-extensions-in-the-studio) + * [Document extensions](#document-extensions) + * [Document extensions in the Studio](#document-extensions-in-the-studio) diff --git a/docs/document-extensions/revisions/client-api/content/_overview-csharp.mdx b/docs/document-extensions/revisions/client-api/content/_overview-csharp.mdx index 3e9f9d128f..db7f1a1da5 100644 --- a/docs/document-extensions/revisions/client-api/content/_overview-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/content/_overview-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed from the [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * From the **Client API**, revisions can be configured and managed by: - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/docs/document-extensions/revisions/client-api/content/_overview-java.mdx b/docs/document-extensions/revisions/client-api/content/_overview-java.mdx index 517669054d..035a2a35d0 100644 --- a/docs/document-extensions/revisions/client-api/content/_overview-java.mdx +++ b/docs/document-extensions/revisions/client-api/content/_overview-java.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Learn about revisions here: [Docuument Revisions Overview](../../../../document-extensions/revisions/overview.mdx) * In this page: - * [Revisions Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Revisions Session methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Revisions Store Operations](#revisions-store-operations) + * [Revisions Session methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/docs/document-extensions/revisions/client-api/content/_overview-nodejs.mdx b/docs/document-extensions/revisions/client-api/content/_overview-nodejs.mdx index eb28887268..e589e7d003 100644 --- a/docs/document-extensions/revisions/client-api/content/_overview-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/content/_overview-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed from the [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * From the **Client API**, revisions can be configured and managed by: - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/docs/document-extensions/revisions/client-api/content/_overview-php.mdx b/docs/document-extensions/revisions/client-api/content/_overview-php.mdx index 290f891ca8..341d26454e 100644 --- a/docs/document-extensions/revisions/client-api/content/_overview-php.mdx +++ b/docs/document-extensions/revisions/client-api/content/_overview-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed using [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * Find below a list of methods that revisions can be configured and managed by. - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions `store` Operations diff --git a/docs/document-extensions/revisions/client-api/content/_overview-python.mdx b/docs/document-extensions/revisions/client-api/content/_overview-python.mdx index aa1deb7104..0a936c618e 100644 --- a/docs/document-extensions/revisions/client-api/content/_overview-python.mdx +++ b/docs/document-extensions/revisions/client-api/content/_overview-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed using [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * Find below a list of methods that revisions can be configured and managed by. - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions `store` Operations diff --git a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx index 2ae9b0d582..b55c12267c 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx index a9d1c3f942..9649d445ff 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; using the Configure Revisions Operation. * In this page: - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) - * [RevisionsCollectionConfiguration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) - * [RevisionsConfiguration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionsconfiguration) - * [ConfigureRevisionsOperation](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#configurerevisionsoperation) - * [Example](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#example) + * [Syntax](#syntax) + * [RevisionsCollectionConfiguration](#revisionscollectionconfiguration) + * [RevisionsConfiguration](#revisionsconfiguration) + * [ConfigureRevisionsOperation](#configurerevisionsoperation) + * [Example](#example) ## Syntax @@ -27,13 +27,13 @@ settings. To configure the revisions settings for a database and/or the collections in that database, follow these steps: -[1.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) +[1.](#revisionscollectionconfiguration) Create a RevisionsCollectionConfiguration` object for each desired collection. -[2.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionsconfiguration) +[2.](#revisionsconfiguration) Put those `RevisionsCollectionConfiguration` objects in a `RevisionsConfiguration` object. -[3.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#configurerevisionsoperation) +[3.](#configurerevisionsoperation) Send that RevisionsConfiguration` to the server. ### RevisionsCollectionConfiguration @@ -96,7 +96,7 @@ configuration. Note that when this object is sent to the server, it overrides the configurations for **all** collections, including all existing configurations currently on the server. If a collection is not listed in `collections` and `defaultConfig` has not been set, the -default values listed in the table [above](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) +default values listed in the table [above](#revisionscollectionconfiguration) are applied. ### ConfigureRevisionsOperation diff --git a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx index 5beaf93ab7..706b43473c 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx index a0b187130a..a8ba2c6fe0 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx index edd592a21b..f067fee783 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx b/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx index 1d035bf9ee..d056609af9 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx b/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx index 830c7d26d5..2b57d9a678 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx b/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx index 31e5ac31f6..0a835b0367 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/docs/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx b/docs/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx index 93ecff8acc..f0f0cc1318 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Delete all revisions - single document](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-all-revisions---single-document) - * [Delete revisions - multiple documents](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions---multiple-documents) - * [Delete revisions by time frame](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions-by-time-frame) - * [Delete revisions by change vectors](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions-by-change-vectors) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#syntax) + * [Delete all revisions - single document](#delete-all-revisions---single-document) + * [Delete revisions - multiple documents](#delete-revisions---multiple-documents) + * [Delete revisions by time frame](#delete-revisions-by-time-frame) + * [Delete revisions by change vectors](#delete-revisions-by-change-vectors) + * [Syntax](#syntax) ## Delete all revisions - single document diff --git a/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-csharp.mdx b/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-csharp.mdx index 951068298e..a4e73aad64 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-csharp.mdx @@ -22,12 +22,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; To run it from Studio, see [Enforce configuration](../../../../../studio/database/settings/document-revisions.mdx#enforce-configuration) in the Document Revisions settings view. * In this article: - * [Enforce configuration on all collections](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#enforce-configuration-on-all-collections) - * [Enforce configuration on specific collections](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#enforce-configuration-on-specific-collections) - * [Include force-created revisions](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#include-force-created-revisions) - * [Throttle the operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#throttle-the-operation) - * [Resume an interrupted operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#resume-an-interrupted-operation) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#syntax) + * [Enforce configuration on all collections](#enforce-configuration-on-all-collections) + * [Enforce configuration on specific collections](#enforce-configuration-on-specific-collections) + * [Include force-created revisions](#include-force-created-revisions) + * [Throttle the operation](#throttle-the-operation) + * [Resume an interrupted operation](#resume-an-interrupted-operation) + * [Syntax](#syntax) @@ -37,7 +37,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; Running the operation can delete them all in a single enforcement run and may require substantial server resources. Schedule it accordingly. -* On large datasets, use `MaxOpsPerSecond` to [throttle the operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#throttle-the-operation) +* On large datasets, use `MaxOpsPerSecond` to [throttle the operation](#throttle-the-operation) and reduce its resource consumption. * Revisions in collections that no current configuration applies to may be deleted. @@ -373,7 +373,7 @@ public class RevisionsOperationParameters | **IncludeForceCreated** | `bool` | `true` - [Force-created revisions](../../../../../document-extensions/revisions/overview.mdx#force-revision-creation) may also be removed by the operation.
`false` (default) - Force-created revisions are not included in deletion paths that protect them. | | **MaxOpsPerSecond** | `int?` | Limits the number of documents processed per second.
`null` (default) - no throttling.
Must be greater than `0`, otherwise an `InvalidOperationException` is thrown. | | **Collections** | `string[]` | The collections the operation applies to.
`null` or empty array - the operation applies to all collections. | -| **ContinuationParameters** | `RevisionsOperationContinuationParameters` | Optional state used to resume an interrupted revisions operation. See [Resume an interrupted operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#resume-an-interrupted-operation). | +| **ContinuationParameters** | `RevisionsOperationContinuationParameters` | Optional state used to resume an interrupted revisions operation. See [Resume an interrupted operation](#resume-an-interrupted-operation). | ```csharp public class RevisionsOperationContinuationParameters diff --git a/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-java.mdx b/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-java.mdx index 90cf6356bb..8f5e864464 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-java.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-java.mdx @@ -22,11 +22,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; To run it from Studio, see [Enforce configuration](../../../../../studio/database/settings/document-revisions.mdx#enforce-configuration) in the Document Revisions settings view. * In this article: - * [Enforce configuration on all collections](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#enforce-configuration-on-all-collections) - * [Enforce configuration on specific collections](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#enforce-configuration-on-specific-collections) - * [Include force-created revisions](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#include-force-created-revisions) - * [Throttle the operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#throttle-the-operation) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#syntax) + * [Enforce configuration on all collections](#enforce-configuration-on-all-collections) + * [Enforce configuration on specific collections](#enforce-configuration-on-specific-collections) + * [Include force-created revisions](#include-force-created-revisions) + * [Throttle the operation](#throttle-the-operation) + * [Syntax](#syntax) @@ -36,7 +36,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; Running the operation can delete them all in a single enforcement run and may require substantial server resources. Schedule it accordingly. -* On large datasets, use `setMaxOpsPerSecond(...)` to [throttle the operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#throttle-the-operation) +* On large datasets, use `setMaxOpsPerSecond(...)` to [throttle the operation](#throttle-the-operation) and reduce its resource consumption. * Revisions in collections that no current configuration applies to may be deleted. diff --git a/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-nodejs.mdx b/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-nodejs.mdx index 0d4fc4d206..1a8cc4b379 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_enforce-revisions-configuration-nodejs.mdx @@ -22,11 +22,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; To run it from Studio, see [Enforce configuration](../../../../../studio/database/settings/document-revisions.mdx#enforce-configuration) in the Document Revisions settings view. * In this article: - * [Enforce configuration on all collections](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#enforce-configuration-on-all-collections) - * [Enforce configuration on specific collections](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#enforce-configuration-on-specific-collections) - * [Include force-created revisions](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#include-force-created-revisions) - * [Throttle the operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#throttle-the-operation) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#syntax) + * [Enforce configuration on all collections](#enforce-configuration-on-all-collections) + * [Enforce configuration on specific collections](#enforce-configuration-on-specific-collections) + * [Include force-created revisions](#include-force-created-revisions) + * [Throttle the operation](#throttle-the-operation) + * [Syntax](#syntax) @@ -36,7 +36,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; Running the operation can delete them all in a single enforcement run and may require substantial server resources. Schedule it accordingly. -* On large datasets, use `maxOpsPerSecond` to [throttle the operation](../../../../../document-extensions/revisions/client-api/operations/enforce-revisions-configuration.mdx#throttle-the-operation) +* On large datasets, use `maxOpsPerSecond` to [throttle the operation](#throttle-the-operation) and reduce its resource consumption. * Revisions in collections that no current configuration applies to may be deleted. diff --git a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx index b939e97f83..34e00c5698 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [GetCountFor](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx index fd2f34531d..bd0181b2cb 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [getCountFor](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx index 340c2acb32..fb984e7578 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [get_count_for](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx index e001b90934..dfa4c019e0 100644 --- a/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx +++ b/docs/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [get_count_for](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx b/docs/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx index 7ece213782..7440bf2e06 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the advance session method `GetCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/docs/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx b/docs/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx index 2c16073f83..b37e4e853a 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the advance session method `getCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/docs/document-extensions/revisions/client-api/session/content/_counting-php.mdx b/docs/document-extensions/revisions/client-api/session/content/_counting-php.mdx index 42316254e4..807e435fe6 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_counting-php.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_counting-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the session `advanced` method `getCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/docs/document-extensions/revisions/client-api/session/content/_counting-python.mdx b/docs/document-extensions/revisions/client-api/session/content/_counting-python.mdx index 803dc2f4ed..632cd5234c 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_counting-python.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_counting-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the session `advanced` method `get_count_for`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/docs/document-extensions/revisions/client-api/session/content/_including-csharp.mdx b/docs/document-extensions/revisions/client-api/session/content/_including-csharp.mdx index e14515fbda..1336e84a2a 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_including-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_including-csharp.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a SINGLE revision can be included per document. - To include MULTIPLE revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include MULTIPLE revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include SINGLE or MULTIPLE document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -512,8 +512,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/docs/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx b/docs/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx index 70a7d963eb..33f022fa2b 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a SINGLE revision can be included per document. - To include MULTIPLE revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include MULTIPLE revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include SINGLE or MULTIPLE document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -388,8 +388,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/docs/document-extensions/revisions/client-api/session/content/_including-php.mdx b/docs/document-extensions/revisions/client-api/session/content/_including-php.mdx index cb0428e279..5533aa9bb9 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_including-php.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_including-php.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a **single** revision can be included per document. - To include **multiple** revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include **multiple** revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include single or multiple document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -493,8 +493,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/docs/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx b/docs/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx index c28a13e13b..8a3c7bc981 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx b/docs/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx index 2c8aacefca..18091068c2 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/session/content/_loading-php.mdx b/docs/document-extensions/revisions/client-api/session/content/_loading-php.mdx index fe28da7797..bb38aae3df 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_loading-php.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_loading-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/docs/document-extensions/revisions/client-api/session/content/_loading-python.mdx b/docs/document-extensions/revisions/client-api/session/content/_loading-python.mdx index 3952370bc2..bb063b677e 100644 --- a/docs/document-extensions/revisions/client-api/session/content/_loading-python.mdx +++ b/docs/document-extensions/revisions/client-api/session/content/_loading-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/docs/document-extensions/revisions/content/_overview-csharp.mdx b/docs/document-extensions/revisions/content/_overview-csharp.mdx index 64fef25d5d..00b3a747c0 100644 --- a/docs/document-extensions/revisions/content/_overview-csharp.mdx +++ b/docs/document-extensions/revisions/content/_overview-csharp.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -218,8 +218,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/docs/document-extensions/revisions/content/_overview-nodejs.mdx b/docs/document-extensions/revisions/content/_overview-nodejs.mdx index 877cfa40e5..c08ce132c6 100644 --- a/docs/document-extensions/revisions/content/_overview-nodejs.mdx +++ b/docs/document-extensions/revisions/content/_overview-nodejs.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -218,8 +218,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/docs/document-extensions/revisions/content/_overview-python.mdx b/docs/document-extensions/revisions/content/_overview-python.mdx index 910c5a6e6c..9f29cc3e81 100644 --- a/docs/document-extensions/revisions/content/_overview-python.mdx +++ b/docs/document-extensions/revisions/content/_overview-python.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -245,8 +245,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/docs/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx b/docs/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx index e5f4cd51a5..722d2b9cce 100644 --- a/docs/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx +++ b/docs/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/docs/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx b/docs/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx index c6cdd003bc..4d5aea2a0e 100644 --- a/docs/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx +++ b/docs/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/docs/document-extensions/revisions/content/_revisions-and-other-features-php.mdx b/docs/document-extensions/revisions/content/_revisions-and-other-features-php.mdx index 00e9a2dc90..a579636030 100644 --- a/docs/document-extensions/revisions/content/_revisions-and-other-features-php.mdx +++ b/docs/document-extensions/revisions/content/_revisions-and-other-features-php.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/docs/document-extensions/revisions/content/_revisions-and-other-features-python.mdx b/docs/document-extensions/revisions/content/_revisions-and-other-features-python.mdx index 7101843df4..711128857a 100644 --- a/docs/document-extensions/revisions/content/_revisions-and-other-features-python.mdx +++ b/docs/document-extensions/revisions/content/_revisions-and-other-features-python.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/docs/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx b/docs/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx index faa6af3411..52284f8e48 100644 --- a/docs/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx +++ b/docs/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; see [Revert documents to specific time](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx). * In this article: - * [Overview](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#overview) - * [Revert documents](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-documents) - * [Revert single document](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-single-document) - * [Revert multiple documents](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-multiple-documents) - * [Syntax](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#syntax) + * [Overview](#overview) + * [Revert documents](#revert-documents) + * [Revert single document](#revert-single-document) + * [Revert multiple documents](#revert-multiple-documents) + * [Syntax](#syntax) @@ -62,7 +62,7 @@ import Panel from '@site/src/components/Panel'; The change-vector of a revision can be obtained via: - * The Client API - follow the code in the examples [below](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-single-document) + * The Client API - follow the code in the examples [below](#revert-single-document) * Or from the document view in the Studio ![Get revision CV](../assets/get-cv-for-revision.png) diff --git a/docs/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx b/docs/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx index 516b138fc8..6c31ebe933 100644 --- a/docs/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx +++ b/docs/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx @@ -29,11 +29,11 @@ import Panel from '@site/src/components/Panel'; and facilitate instant recovery without the need to search and retrieve a stored backup. * In this article: - * [The revisions settings view](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#the-revisions-settings-view) - * [Revert documents](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents) - * [Point in time](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#point-in-time) - * [Time Window](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#time-window) - * [Content reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#content-reverted) + * [The revisions settings view](#the-revisions-settings-view) + * [Revert documents](#revert-documents) + * [Point in time](#point-in-time) + * [Time Window](#time-window) + * [Content reverted](#content-reverted) @@ -45,7 +45,7 @@ import Panel from '@site/src/components/Panel'; In the Studio, go to _Settings > Document Revisions_. From this view you can: * [Set](../../../studio/database/settings/document-revisions.mdx#revisions-configuration) revision configurations * [Enforce](../../../studio/database/settings/document-revisions.mdx#enforce-configuration) revision configurations - * [Revert](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents) documents to revisions + * [Revert](#revert-documents) documents to revisions 2. **Revision configurations**: * The ability to revert documents to their past revisions depends on revisions being created. @@ -55,7 +55,7 @@ import Panel from '@site/src/components/Panel'; 3. **Revert documents**: Click the _Revert Revisions_ button to revert documents from all or selected collections to a specified point in time. - Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents). + Learn more [below](#revert-documents). @@ -63,9 +63,9 @@ import Panel from '@site/src/components/Panel'; ![Revert Revisions](./assets/revert-revisions-2.png) -1. Enter the **Point in Time** to which you would like to revert the documents. Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#point-in-time). +1. Enter the **Point in Time** to which you would like to revert the documents. Learn more [below](#point-in-time). -2. Enter the **Time Window**. Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#time-window). +2. Enter the **Time Window**. Learn more [below](#time-window). 3. Revert **All collections** in the database, or toggle to select **Specific collections** to revert. diff --git a/docs/document-extensions/revisions/revisions-bin-cleaner.mdx b/docs/document-extensions/revisions/revisions-bin-cleaner.mdx index 958ef05de6..cdf043c8b5 100644 --- a/docs/document-extensions/revisions/revisions-bin-cleaner.mdx +++ b/docs/document-extensions/revisions/revisions-bin-cleaner.mdx @@ -23,10 +23,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * For a complete list of deletion methods, see [All ways to delete revisions](../../studio/database/document-extensions/revisions/all-revisions.mdx#all-ways-to-delete-revisions). * In this page: - * [The revisions bin cleaner](../../document-extensions/revisions/revisions-bin-cleaner.mdx#the-revisions-bin-cleaner) - * [Setting the revisions bin cleaner - from the Studio](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-studio) - * [Setting the revisions bin cleaner - from the Client API](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-client-api) - * [Syntax](../../document-extensions/revisions/revisions-bin-cleaner.mdx#syntax) + * [The revisions bin cleaner](#the-revisions-bin-cleaner) + * [Setting the revisions bin cleaner - from the Studio](#setting-the-revisions-bin-cleaner---from-the-studio) + * [Setting the revisions bin cleaner - from the Client API](#setting-the-revisions-bin-cleaner---from-the-client-api) + * [Syntax](#syntax) ## The revisions bin cleaner @@ -43,8 +43,8 @@ ALL the revisions associated with the deleted document are **permanently deleted * **Entries age to keep** - The cleaner deletes revision entries older than this value. * The cleaner task can be managed from: - * The [Revisions bin cleaner view](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio - * The [Client API](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-client-api). + * The [Revisions bin cleaner view](#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio + * The [Client API](#setting-the-revisions-bin-cleaner---from-the-client-api). * When working with a secure server: * Configuring the Revisions Bin Cleaner is logged in the [audit log](../../server/security/audit-log/audit-log-overview.mdx). diff --git a/docs/document-extensions/revisions/troubleshooting.mdx b/docs/document-extensions/revisions/troubleshooting.mdx index c13de5a9cd..9d0387c16c 100644 --- a/docs/document-extensions/revisions/troubleshooting.mdx +++ b/docs/document-extensions/revisions/troubleshooting.mdx @@ -16,7 +16,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`ThrowRevisionKeyTooBig` exception](../../document-extensions/revisions/troubleshooting.mdx#throwrevisionkeytoobig-exception) + * [`ThrowRevisionKeyTooBig` exception](#throwrevisionkeytoobig-exception) ## `ThrowRevisionKeyTooBig` exception diff --git a/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx b/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx index 4c9784b36e..b58dac757a 100644 --- a/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; but without the overhead associated with the _Session_, resulting in significantly improved performance. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#examples) - * [Append single entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-single-entry) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-entries) - * [Append multiple values per entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-values-per-entry) - * [Append multiple time series](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) - * [Syntax](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append single entry](#append-single-entry) + * [Append multiple entries](#append-multiple-entries) + * [Append multiple values per entry](#append-multiple-values-per-entry) + * [Append multiple time series](#append-multiple-time-series) + * [Syntax](#syntax) @@ -41,7 +41,7 @@ import CodeBlock from '@theme/CodeBlock'; * To append multiple entries, call `Append` as many times as needed. * Ensure there is at least a 1-millisecond interval between each timestamp. * The client converts all timestamps to **UTC** before sending the batch to the server. -* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) below. +* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](#append-multiple-time-series) below. diff --git a/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx b/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx index 4096f6adc3..7af153503b 100644 --- a/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; but without the overhead associated with the _Session_, resulting in significantly improved performance. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#examples) - * [Append single entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-single-entry) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-entries) - * [Append multiple values per entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-values-per-entry) - * [Append multiple time series](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) - * [Syntax](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append single entry](#append-single-entry) + * [Append multiple entries](#append-multiple-entries) + * [Append multiple values per entry](#append-multiple-values-per-entry) + * [Append multiple time series](#append-multiple-time-series) + * [Syntax](#syntax) @@ -41,7 +41,7 @@ import CodeBlock from '@theme/CodeBlock'; * To append multiple entries, call `append` as many times as needed. * Ensure there is at least a 1-millisecond interval between each timestamp. * The client converts all timestamps to **UTC** before sending the batch to the server. -* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) below. +* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](#append-multiple-time-series) below. diff --git a/docs/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx b/docs/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx index 5de832d7c5..fde7db2fd4 100644 --- a/docs/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; * The server treats timestamps passed in the scripts as **UTC**, no conversion is applied by the client to local time. * In this page: - * [JavaScript time series API methods](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#javascript-time-series-api-methods) - * [timeseries - choose a time series](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section) - * [timeseries.append - append an entry](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-1) - * [timeseries.delete - delete entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) - * [timeseries.get - get entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) - * [Examples](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#examples) + * [JavaScript time series API methods](#javascript-time-series-api-methods) + * [timeseries - choose a time series](#section) + * [timeseries.append - append an entry](#section-1) + * [timeseries.delete - delete entries](#section-2) + * [timeseries.get - get entries](#section-3) + * [Examples](#examples) ## JavaScript time series API methods diff --git a/docs/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx b/docs/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx index a8a8dd226f..896c752a4e 100644 --- a/docs/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; * The server treats timestamps passed in the scripts as **UTC**, no conversion is applied by the client to local time. * In this page: - * [JavaScript time series API methods](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#javascript-time-series-api-methods) - * [timeseries - choose a time series](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section) - * [timeseries.append - append an entry](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-1) - * [timeseries.delete - delete entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) - * [timeseries.get - get entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) - * [Examples](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#examples) + * [JavaScript time series API methods](#javascript-time-series-api-methods) + * [timeseries - choose a time series](#section) + * [timeseries.append - append an entry](#section-1) + * [timeseries.delete - delete entries](#section-2) + * [timeseries.get - get entries](#section-3) + * [Examples](#examples) ## JavaScript time series API methods diff --git a/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx b/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx index c2735d6b84..d10029fab8 100644 --- a/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; you need to register the time series types on the server. * In this page: - * [Named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#named-values) - * [Define time series type](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#define-time-series-type) - * [Examples](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#examples) - * [Register time series type](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#register-time-series-type) - * [Usage](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#usage) - * [Syntax](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#syntax) + * [Named values](#named-values) + * [Define time series type](#define-time-series-type) + * [Examples](#examples) + * [Register time series type](#register-time-series-type) + * [Usage](#usage) + * [Syntax](#syntax) ## Named values diff --git a/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx b/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx index 47f7dc5d7a..a9830e3332 100644 --- a/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; you need to register the named values on the server. * In this page: - * [Named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#named-values) - * [Define time series class with named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#define-time-series-class-with-named-values) - * [Examples](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#examples) - * [Register time series named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#register-time-series-named-values) - * [Usage](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#usage) - * [Syntax](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#syntax) + * [Named values](#named-values) + * [Define time series class with named values](#define-time-series-class-with-named-values) + * [Examples](#examples) + * [Register time series named values](#register-time-series-named-values) + * [Usage](#usage) + * [Syntax](#syntax) ## Named values diff --git a/docs/document-extensions/timeseries/client-api/content/_overview-csharp.mdx b/docs/document-extensions/timeseries/client-api/content/_overview-csharp.mdx index aebb944f2c..02d3eec7cf 100644 --- a/docs/document-extensions/timeseries/client-api/content/_overview-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/content/_overview-csharp.mdx @@ -12,10 +12,10 @@ You can use the API to **append** (create and update), **get**, **delete**, **include**, **patch** and **query** time series data. * In this page: - * [Creating and Removing Time Series](../../../../document-extensions/timeseries/client-api/overview.mdx#creating-and-removing-time-series) - * [`session` Methods -vs- `document-store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#session-methods--vs--document-store-operations) - * [Available Time Series `session` methods](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-session-methods) - * [Available Time Series `store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-store-operations) + * [Creating and Removing Time Series](#creating-and-removing-time-series) + * [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations) + * [Available Time Series `session` methods](#available-time-series-session-methods) + * [Available Time Series `store` Operations](#available-time-series-store-operations) ## Creating and Removing Time Series diff --git a/docs/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx b/docs/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx index bd2dc85c4b..32bcf14b1b 100644 --- a/docs/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx @@ -12,10 +12,10 @@ You can use the API to **append** (create and update), **get**, **delete**, **include**, **patch** and **query** time series data. * In this page: - * [Creating and Removing Time Series](../../../../document-extensions/timeseries/client-api/overview.mdx#creating-and-removing-time-series) - * [`session` Methods -vs- `document-store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#session-methods--vs--document-store-operations) - * [Available Time Series `session` methods](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-session-methods) - * [Available Time Series `store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-store-operations) + * [Creating and Removing Time Series](#creating-and-removing-time-series) + * [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations) + * [Available Time Series `session` methods](#available-time-series-session-methods) + * [Available Time Series `store` Operations](#available-time-series-store-operations) ## Creating and Removing Time Series diff --git a/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx b/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx index b61a2ca8f7..c3f2b88b97 100644 --- a/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#delete-multiple-entries) - * [Append & Delete entries in the same batch](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Append & Delete entries in the same batch](#append--delete-entries-in-the-same-batch) + * [Syntax](#syntax) ## Usage @@ -39,7 +39,7 @@ import CodeBlock from '@theme/CodeBlock'; **Note**: * All the added Append and Delete operations will be executed in a single-node transaction. -* Delete actions are executed **before** Append actions. As seen in [this example](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch). +* Delete actions are executed **before** Append actions. As seen in [this example](#append--delete-entries-in-the-same-batch). * Appending entries to a time series that doesn't yet exist yet will create the time series. * An exception will be thrown if the specified document does Not exist. diff --git a/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx b/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx index a0084dd06b..8ebd11426b 100644 --- a/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#delete-multiple-entries) - * [Append & delete entries in the same batch](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Append & delete entries in the same batch](#append--delete-entries-in-the-same-batch) + * [Syntax](#syntax) ## Usage @@ -39,7 +39,7 @@ import CodeBlock from '@theme/CodeBlock'; **Note**: * All the added Append and Delete operations will be executed in a single-node transaction. - * Delete actions are executed **before** Append actions. As seen in [this example](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch). + * Delete actions are executed **before** Append actions. As seen in [this example](#append--delete-entries-in-the-same-batch). * Appending entries to a time series that doesn't yet exist yet will create the time series. * An exception will be thrown if the specified document does Not exist. diff --git a/docs/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx b/docs/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx index ec6f818d54..ae4a8859cd 100644 --- a/docs/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Get entries - from single time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-single-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax) - * [Get entries - from multiple time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-multiple-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax-1) + * [Get entries - from single time series](#get-entries---from-single-time-series) + * [Example](#example) + * [Syntax](#syntax) + * [Get entries - from multiple time series](#get-entries---from-multiple-time-series) + * [Example](#example-1) + * [Syntax](#syntax-1) ## Get entries - from single time series diff --git a/docs/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx b/docs/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx index dff1839e1d..02aeb7d15a 100644 --- a/docs/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Get entries - from single time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-single-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax) - * [Get entries - from multiple time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-multiple-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax-1) + * [Get entries - from single time series](#get-entries---from-single-time-series) + * [Example](#example) + * [Syntax](#syntax) + * [Get entries - from multiple time series](#get-entries---from-multiple-time-series) + * [Example](#example-1) + * [Syntax](#syntax-1) ## Get entries - from single time series diff --git a/docs/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx b/docs/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx index ceed67e8b6..6b7ff59a4d 100644 --- a/docs/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * Patching time series entries on a single document can also be performed via the [Session](../../../../../document-extensions/timeseries/client-api/session/patch.mdx). * In this page: - * [Patch time series data - single document](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---single-document) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax) - * [Patch time series data - multiple documents](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---multiple-documents) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage-1) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax-1) + * [Patch time series data - single document](#patch-time-series-data---single-document) + * [Usage](#usage) + * [Examples](#examples) + * [Syntax](#syntax) + * [Patch time series data - multiple documents](#patch-time-series-data---multiple-documents) + * [Usage](#usage-1) + * [Examples](#examples-1) + * [Syntax](#syntax-1) ## Patch time series data - single document diff --git a/docs/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx b/docs/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx index 5f84b98911..4ebad890b4 100644 --- a/docs/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * Patching time series entries on a single document can also be performed via the [session](../../../../../document-extensions/timeseries/client-api/session/patch.mdx). * In this page: - * [Patch time series data - single document](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---single-document) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax) - * [Patch time series data - multiple documents](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---multiple-documents) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage-1) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax-1) + * [Patch time series data - single document](#patch-time-series-data---single-document) + * [Usage](#usage) + * [Examples](#examples) + * [Syntax](#syntax) + * [Patch time series data - multiple documents](#patch-time-series-data---multiple-documents) + * [Usage](#usage-1) + * [Examples](#examples-1) + * [Syntax](#syntax-1) ## Patch time series data - single document diff --git a/docs/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx index 4277527818..b51c66e14d 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [`Append` usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [`Append` usage](#append-usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## `Append` usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx index dc9b8a000d..ec0fe8103a 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [`append` usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [`append` usage](#append-usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## `append` usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_append-php.mdx b/docs/document-extensions/timeseries/client-api/session/content/_append-php.mdx index e9c02c5dbe..2472c5dbb8 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_append-php.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_append-php.mdx @@ -21,10 +21,10 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) + * [Usage](#usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) ## Usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_append-python.mdx b/docs/document-extensions/timeseries/client-api/session/content/_append-python.mdx index e1a856cc61..1245ebcb83 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_append-python.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_append-python.mdx @@ -27,11 +27,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## Usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx index 7e89c76c16..cec86a5de0 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; To remove the whole time series simply delete all its entries. * In this page: - * [`Delete` usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#examples) - * [Delete single entry](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-single-entry) - * [Delete range of entries](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-range-of-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [`Delete` usage](#delete-usage) + * [Examples](#examples) + * [Delete single entry](#delete-single-entry) + * [Delete range of entries](#delete-range-of-entries) + * [Syntax](#syntax) ## `Delete` usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx index d4ecf68a08..b1e9aa747d 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * **Delete the whole time series** * In this page: - * [`delete` usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#examples) - * [Delete single entry](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-single-entry) - * [Delete range of entries](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-range-of-entries) - * [Delete time series](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-time-series-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [`delete` usage](#delete-usage) + * [Examples](#examples) + * [Delete single entry](#delete-single-entry) + * [Delete range of entries](#delete-range-of-entries) + * [Delete time series](#delete-time-series-1) + * [Syntax](#syntax) ## `Delete` usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_delete-php.mdx b/docs/document-extensions/timeseries/client-api/session/content/_delete-php.mdx index a7cf6a854c..f000a46f16 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_delete-php.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_delete-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * A time series is removed when all of its entries are deleted. * In this page: - * [usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#usage) - * [Example](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#example) + * [usage](#usage) + * [Example](#example) ## usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_delete-python.mdx b/docs/document-extensions/timeseries/client-api/session/content/_delete-python.mdx index bdf0168161..04883bfc18 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_delete-python.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_delete-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A time series is removed when all of its entries are deleted. * In this page: - * [usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#usage) - * [Example](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [usage](#usage) + * [Example](#example) + * [Syntax](#syntax) ## usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx index 91c7b711e1..edca271545 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx index 981d2f5f19..75a16147f7 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_patch-php.mdx b/docs/document-extensions/timeseries/client-api/session/content/_patch-php.mdx index 906080ac2c..e01239271b 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_patch-php.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_patch-php.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_patch-python.mdx b/docs/document-extensions/timeseries/client-api/session/content/_patch-python.mdx index b384e3be53..c75b21680f 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_patch-python.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_patch-python.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/docs/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx index b401cd2e04..ae86daa4c9 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx @@ -15,18 +15,18 @@ import CodeBlock from '@theme/CodeBlock'; which can be provided to a `RawQuery` or executed from the Studio's [Query view](../../../../../studio/database/queries/query-view.mdx). * In this page: - * [Query](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query) - * [Query usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-usage) - * [Query examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-examples) - * [Query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax) - * [DocumentQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery) - * [DocumentQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-usage) - * [DocumentQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-examples) - * [DocumentQuery Syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-syntax) - * [RawQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery) - * [RawQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-usage) - * [RawQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-examples) - * [RawQuery syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-syntax) + * [Query](#query) + * [Query usage](#query-usage) + * [Query examples](#query-examples) + * [Query syntax](#query-syntax) + * [DocumentQuery](#documentquery) + * [DocumentQuery usage](#documentquery-usage) + * [DocumentQuery examples](#documentquery-examples) + * [DocumentQuery Syntax](#documentquery-syntax) + * [RawQuery](#rawquery) + * [RawQuery usage](#rawquery-usage) + * [RawQuery examples](#rawquery-examples) + * [RawQuery syntax](#rawquery-syntax) diff --git a/docs/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx index dc4d479004..9c45f25c38 100644 --- a/docs/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx @@ -14,14 +14,14 @@ import CodeBlock from '@theme/CodeBlock'; which can be provided to a `rawQuery` or executed from the Studio's [Query view](../../../../../studio/database/queries/query-view.mdx). * In this page: - * [Query](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query) - * [Query usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-usage) - * [Query examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-examples) - * [Query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax) - * [RawQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery) - * [RawQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-usage) - * [RawQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-examples) - * [RawQuery syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-syntax) + * [Query](#query) + * [Query usage](#query-usage) + * [Query examples](#query-examples) + * [Query syntax](#query-syntax) + * [RawQuery](#rawquery) + * [RawQuery usage](#rawquery-usage) + * [RawQuery examples](#rawquery-examples) + * [RawQuery syntax](#rawquery-syntax) @@ -482,7 +482,7 @@ select timeseries( |------------|----------|----------------------| | **query** | `string` | The RQL query string | -The return value is the same as listed under the [query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax). +The return value is the same as listed under the [query syntax](#query-syntax). diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx index f3199c494c..0a82af823c 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `TimeSeriesFor.Get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in: [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`Get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`Get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `Get` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx index 6f38e5936d..f2a4ad5a66 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `timeSeriesFor.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `get` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx index a3d780855e..4b0fdcea42 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx @@ -16,19 +16,19 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `timeSeriesFor.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. * In this page: - * [`get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `get` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx index f9c60e597d..8ef2fdbd81 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `time_series_for.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in: [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`Get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`Get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `Get` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx index d7f998f448..ae50f6639a 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `Advanced.GetTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`GetTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`GetTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `GetTimeSeriesFor` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx index 084e9185c5..bd962c6a29 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.getTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`GetTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`GetTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `getTimeSeriesFor` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx index 92910cf595..3c164e90a8 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.getTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`getTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`getTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `getTimeSeriesFor` usage diff --git a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx index e6f9e5f16c..74cb85a178 100644 --- a/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx +++ b/docs/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.get_time_series_for` to get the names of all time series for the specified entity. * In this page: - * [`get_time_series_for` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#get_time_series_for-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`get_time_series_for` usage](#get_time_series_for-usage) + * [Example](#example) + * [Syntax](#syntax) ## `get_time_series_for` usage diff --git a/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx index 0e5f698a97..940a3568fa 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; without any additional server calls. * In this page: - * [Include time series when making a raw query](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#include-time-series-when-making-a-raw-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#syntax) + * [Include time series when making a raw query](#include-time-series-when-making-a-raw-query) + * [Syntax](#syntax) ## Include time series when making a raw query diff --git a/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx index b3b104278e..c9ea81947f 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; without any additional server calls. * In this page: - * [Include time series when making a raw query](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#include-time-series-when-making-a-raw-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#syntax) + * [Include time series when making a raw query](#include-time-series-when-making-a-raw-query) + * [Syntax](#syntax) ## Include time series when making a raw query diff --git a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx index ce6d837e6a..3a2ad360a7 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when loading a document](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#include-time-series-when-loading-a-document) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#syntax) + * [Include time series when loading a document](#include-time-series-when-loading-a-document) + * [Syntax](#syntax) ## Include time series when loading a document diff --git a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx index 5d4b285950..be96ff6baf 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when loading a document](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#include-time-series-when-loading-a-document) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#syntax) + * [Include time series when loading a document](#include-time-series-when-loading-a-document) + * [Syntax](#syntax) ## Include time series when loading a document diff --git a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx index 440399f7c0..867e266cf3 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when making a query](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#include-time-series-when-making-a-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#syntax) + * [Include time series when making a query](#include-time-series-when-making-a-query) + * [Syntax](#syntax) ## Include time series when making a query diff --git a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx index 29bf72b12c..a1ab83ff58 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when making a query](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#include-time-series-when-making-a-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#syntax) + * [Include time series when making a query](#include-time-series-when-making-a-query) + * [Syntax](#syntax) ## Include time series when making a query diff --git a/docs/document-extensions/timeseries/content/_design-csharp.mdx b/docs/document-extensions/timeseries/content/_design-csharp.mdx index 3a5e3e859e..88a3fa8688 100644 --- a/docs/document-extensions/timeseries/content/_design-csharp.mdx +++ b/docs/document-extensions/timeseries/content/_design-csharp.mdx @@ -10,17 +10,17 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB time series are stored and managed as document extensions, achieving much greater speed and efficiency compared to storing them as JSON-formatted data within a document. * In this page: - * [Time series architecture](../../../document-extensions/timeseries/design.mdx#time-series-architecture) - * [Time series as a document extension](../../../document-extensions/timeseries/design.mdx#time-series-as-a--document-extension) - * [The `HasTimeSeries` flag](../../../document-extensions/timeseries/design.mdx#the--flag) - * [The time series entry](../../../document-extensions/timeseries/design.mdx#the-time-series-entry) - * [Segmentation](../../../document-extensions/timeseries/design.mdx#segmentation) - * [Compression](../../../document-extensions/timeseries/design.mdx#compression) - * [Updating time series](../../../document-extensions/timeseries/design.mdx#updating-time-series) - * [Document change](../../../document-extensions/timeseries/design.mdx#document-change) - * [No conflicts](../../../document-extensions/timeseries/design.mdx#no-conflicts) - * [Transactions](../../../document-extensions/timeseries/design.mdx#transactions) - * [Case insensitive](../../../document-extensions/timeseries/design.mdx#case-insensitive) + * [Time series architecture](#time-series-architecture) + * [Time series as a document extension](#time-series-as-a--document-extension) + * [The `HasTimeSeries` flag](#the--flag) + * [The time series entry](#the-time-series-entry) + * [Segmentation](#segmentation) + * [Compression](#compression) + * [Updating time series](#updating-time-series) + * [Document change](#document-change) + * [No conflicts](#no-conflicts) + * [Transactions](#transactions) + * [Case insensitive](#case-insensitive) ## Time series architecture @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; * The document and the time series reference each another: * The document's metadata keeps a reference to the time series **name**. The time series **data** itself is stored in a separate location. - * The [segments](../../../document-extensions/timeseries/design.mdx#segmentation) containing the time series data keep a reference to the document ID. + * The [segments](#segmentation) containing the time series data keep a reference to the document ID. ### The `HasTimeSeries` flag * When a document has one or more time series, diff --git a/docs/document-extensions/timeseries/content/_design-nodejs.mdx b/docs/document-extensions/timeseries/content/_design-nodejs.mdx index 8082b97622..33967b5c53 100644 --- a/docs/document-extensions/timeseries/content/_design-nodejs.mdx +++ b/docs/document-extensions/timeseries/content/_design-nodejs.mdx @@ -10,17 +10,17 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB time series are stored and managed as document extensions, achieving much greater speed and efficiency compared to storing them as JSON-formatted data within a document. * In this page: - * [Time series architecture](../../../document-extensions/timeseries/design.mdx#time-series-architecture) - * [Time series as a document extension](../../../document-extensions/timeseries/design.mdx#time-series-as-a--document-extension) - * [The `HasTimeSeries` flag](../../../document-extensions/timeseries/design.mdx#the--flag) - * [The time series entry](../../../document-extensions/timeseries/design.mdx#the-time-series-entry) - * [Segmentation](../../../document-extensions/timeseries/design.mdx#segmentation) - * [Compression](../../../document-extensions/timeseries/design.mdx#compression) - * [Updating time series](../../../document-extensions/timeseries/design.mdx#updating-time-series) - * [Document change](../../../document-extensions/timeseries/design.mdx#document-change) - * [No conflicts](../../../document-extensions/timeseries/design.mdx#no-conflicts) - * [Transactions](../../../document-extensions/timeseries/design.mdx#transactions) - * [Case insensitive](../../../document-extensions/timeseries/design.mdx#case-insensitive) + * [Time series architecture](#time-series-architecture) + * [Time series as a document extension](#time-series-as-a--document-extension) + * [The `HasTimeSeries` flag](#the--flag) + * [The time series entry](#the-time-series-entry) + * [Segmentation](#segmentation) + * [Compression](#compression) + * [Updating time series](#updating-time-series) + * [Document change](#document-change) + * [No conflicts](#no-conflicts) + * [Transactions](#transactions) + * [Case insensitive](#case-insensitive) ## Time series architecture @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; * The document and the time series reference each another: * The document's metadata keeps a reference to the time series **name**. The time series **data** itself is stored in a separate location. - * The [segments](../../../document-extensions/timeseries/design.mdx#segmentation) containing the time series data keep a reference to the document ID. + * The [segments](#segmentation) containing the time series data keep a reference to the document ID. ### The `HasTimeSeries` flag * When a document has one or more time series, diff --git a/docs/document-extensions/timeseries/content/_indexing-csharp.mdx b/docs/document-extensions/timeseries/content/_indexing-csharp.mdx index 16de1783f5..3e6b127581 100644 --- a/docs/document-extensions/timeseries/content/_indexing-csharp.mdx +++ b/docs/document-extensions/timeseries/content/_indexing-csharp.mdx @@ -10,15 +10,15 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Map index - index all time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-single-collection) - * [Map index - index all time series from all collections](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-all-collections) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Map index - index all time series from single collection](#map-index---index-all-time-series-from-single-collection) + * [Map index - index all time series from all collections](#map-index---index-all-time-series-from-all-collections) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -50,7 +50,7 @@ from entry in segment * Values & timestamp of a time series entry * The entry tag * Content from a document referenced by the tag - * Properties of the containing segment (see **[`TimeSeriesSegment`](../../../document-extensions/timeseries/indexing.mdx#section-5)**) + * Properties of the containing segment (see **[`TimeSeriesSegment`](#section-5)**) * Document index: @@ -80,16 +80,16 @@ from entry in segment There are two main ways to create a time series index: 1. Create a class that inherits from one of the following abstract index creation task classes: - * [`AbstractTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section) + * [`AbstractTimeSeriesIndexCreationTask`](#section) for [map](../../../indexes/map-indexes.mdx) and [map-reduce](../../../indexes/map-reduce-indexes.mdx) time series indexes. - * [`AbstractMultiMapTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section-1) + * [`AbstractMultiMapTimeSeriesIndexCreationTask`](#section-1) for [multi-map](../../../indexes/multi-map-indexes.mdx) time series indexes. - * [`AbstractJavaScriptTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section-2) + * [`AbstractJavaScriptTimeSeriesIndexCreationTask`](#section-2) for static [javascript indexes](../../../indexes/javascript-indexes.mdx). 2. Deploy a time series index definition via [PutIndexesOperation](../../../client-api/operations/maintenance/indexes/put-indexes.mdx): - * Create a [`TimeSeriesIndexDefinition`](../../../document-extensions/timeseries/indexing.mdx#section-3) directly. - * Create a strongly typed index definition using [`TimeSeriesIndexDefinitionBuilder`](../../../document-extensions/timeseries/indexing.mdx#section-4). + * Create a [`TimeSeriesIndexDefinition`](#section-3) directly. + * Create a strongly typed index definition using [`TimeSeriesIndexDefinitionBuilder`](#section-4). @@ -102,7 +102,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/docs/document-extensions/timeseries/content/_indexing-nodejs.mdx b/docs/document-extensions/timeseries/content/_indexing-nodejs.mdx index 56d10e47a9..74a6f3844f 100644 --- a/docs/document-extensions/timeseries/content/_indexing-nodejs.mdx +++ b/docs/document-extensions/timeseries/content/_indexing-nodejs.mdx @@ -10,15 +10,15 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Map index - index all time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-single-collection) - * [Map index - index all time series from all collections](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-all-collections) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Map index - index all time series from single collection](#map-index---index-all-time-series-from-single-collection) + * [Map index - index all time series from all collections](#map-index---index-all-time-series-from-all-collections) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * Values & timestamp of a time series entry * The entry tag * Content from a document referenced by the tag - * Properties of the containing segment (see **[segment properties](../../../document-extensions/timeseries/indexing.mdx#segment-properties)**) + * Properties of the containing segment (see **[segment properties](#segment-properties)**) * Document index: @@ -61,9 +61,9 @@ import CodeBlock from '@theme/CodeBlock'; There are two main ways to create a time series index: -1. Create a class that inherits from the abstract index class [`AbstractRawJavaScriptTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section). +1. Create a class that inherits from the abstract index class [`AbstractRawJavaScriptTimeSeriesIndexCreationTask`](#section). -2. Create a [`TimeSeriesIndexDefinition`](../../../document-extensions/timeseries/indexing.mdx#section-1) +2. Create a [`TimeSeriesIndexDefinition`](#section-1) and deploy the time series index definition via [PutIndexesOperation](../../../client-api/operations/maintenance/indexes/put-indexes.mdx). diff --git a/docs/document-extensions/timeseries/content/_indexing-php.mdx b/docs/document-extensions/timeseries/content/_indexing-php.mdx index 12e10e45bc..28cac6ba4a 100644 --- a/docs/document-extensions/timeseries/content/_indexing-php.mdx +++ b/docs/document-extensions/timeseries/content/_indexing-php.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -100,7 +100,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/docs/document-extensions/timeseries/content/_indexing-python.mdx b/docs/document-extensions/timeseries/content/_indexing-python.mdx index 578928c705..14fef78a5e 100644 --- a/docs/document-extensions/timeseries/content/_indexing-python.mdx +++ b/docs/document-extensions/timeseries/content/_indexing-python.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -100,7 +100,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/docs/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx b/docs/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx index 40b95ba56b..e4e91ef7a9 100644 --- a/docs/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx +++ b/docs/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/docs/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx b/docs/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx index bb25a54a65..481be1efa2 100644 --- a/docs/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx +++ b/docs/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/docs/document-extensions/timeseries/content/_rollup-and-retention-php.mdx b/docs/document-extensions/timeseries/content/_rollup-and-retention-php.mdx index ee00a617c8..48927b8f8a 100644 --- a/docs/document-extensions/timeseries/content/_rollup-and-retention-php.mdx +++ b/docs/document-extensions/timeseries/content/_rollup-and-retention-php.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/docs/document-extensions/timeseries/content/_rollup-and-retention-python.mdx b/docs/document-extensions/timeseries/content/_rollup-and-retention-python.mdx index f43509620d..a1e305095d 100644 --- a/docs/document-extensions/timeseries/content/_rollup-and-retention-python.mdx +++ b/docs/document-extensions/timeseries/content/_rollup-and-retention-python.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/docs/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx b/docs/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx index 3faaf40cfb..9a06ee5db9 100644 --- a/docs/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx +++ b/docs/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; or they have their own pages describing their interaction with time series (such as [indexing](../../../document-extensions/timeseries/indexing.mdx)). * In this page: - * [General features](../../../document-extensions/timeseries/time-series-and-other-features.mdx#general-features) - * [Smuggler](../../../document-extensions/timeseries/time-series-and-other-features.mdx#smuggler) - * [Ongoing tasks](../../../document-extensions/timeseries/time-series-and-other-features.mdx#ongoing-tasks) - * [Revisions](../../../document-extensions/timeseries/time-series-and-other-features.mdx#revisions) + * [General features](#general-features) + * [Smuggler](#smuggler) + * [Ongoing tasks](#ongoing-tasks) + * [Revisions](#revisions) ## General features diff --git a/docs/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx b/docs/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx index 9ee3ed9c2f..7980d74dc0 100644 --- a/docs/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx +++ b/docs/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; or they have their own pages describing their interaction with time series (such as [indexing](../../../document-extensions/timeseries/indexing.mdx)). * In this page: - * [General features](../../../document-extensions/timeseries/time-series-and-other-features.mdx#general-features) - * [Smuggler](../../../document-extensions/timeseries/time-series-and-other-features.mdx#smuggler) - * [Ongoing tasks](../../../document-extensions/timeseries/time-series-and-other-features.mdx#ongoing-tasks) - * [Revisions](../../../document-extensions/timeseries/time-series-and-other-features.mdx#revisions) + * [General features](#general-features) + * [Smuggler](#smuggler) + * [Ongoing tasks](#ongoing-tasks) + * [Revisions](#revisions) ## General features diff --git a/docs/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx b/docs/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx index 1a6ce949af..a9541ad4fe 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Javascript Support](../../../../document-extensions/timeseries/client-api/javascript-support.mdx) has been extended to support incremental time series. -* You can use the Javascript [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#timeseriesincrement) +* You can use the Javascript [timeseries.increment](#timeseriesincrement) method to create and modify incremental time series and their entries. The method behaves the same way it does when it is called [using C#](../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx). @@ -33,9 +33,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [timeseries.get](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) * In this page: - * [The `timeseries` Interface](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#the-timeseries-interface) - * [`timeseries.increment`](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#timeseriesincrement) - * [Usage Sample](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#usage-sample) + * [The `timeseries` Interface](#the-timeseries-interface) + * [`timeseries.increment`](#timeseriesincrement) + * [Usage Sample](#usage-sample) @@ -50,7 +50,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; | name | `string` | Incremental time series Name (e.g. `INC:StockPrice`) | * Use one of the following methods to access the chosen time series: - * [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#the-timeseries-interface) + * [timeseries.increment](#the-timeseries-interface) * [timeseries.delete](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) * [timeseries.get](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) diff --git a/docs/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx b/docs/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx index 852880ae6a..1b479928cb 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Using this method, you can retrieve node values from incremental time series entries. * In this page: - * [`GetTimeSeriesOperation`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#gettimeseriesoperation) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#usage-sample) + * [`GetTimeSeriesOperation`](#gettimeseriesoperation) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#usage-sample) ## `GetTimeSeriesOperation` diff --git a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx index 607a1586c1..f67e117042 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx @@ -20,10 +20,10 @@ Delete a range of incremental time series entries using `IncrementalTimeSeriesFo * You can delete a **single entry** or a **range of entries**. * In this page: - * [`IncrementalTimeSeriesFor.Delete`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#incrementaltimeseriesfordelete) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#code-samples) + * [`IncrementalTimeSeriesFor.Delete`](#incrementaltimeseriesfordelete) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#code-samples) ## `IncrementalTimeSeriesFor.Delete` diff --git a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx index 4ab62ca6ab..ed26b2a525 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx @@ -30,9 +30,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`IncrementalTimeSeriesFor.Get`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#incrementaltimeseriesforget) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#usage-flow) + * [`IncrementalTimeSeriesFor.Get`](#incrementaltimeseriesforget) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) * [Code Samples](../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#code-samples) diff --git a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx index ff7d9ec313..51b0b7a3c3 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; `session.SaveChanges`, to create multiple entries in a single transaction. * In this page: - * [`IncrementalTimeSeriesFor.Increment`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#timeseriesforappend) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#code-samples) + * [`IncrementalTimeSeriesFor.Increment`](#timeseriesforappend) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#code-samples) ## `IncrementalTimeSeriesFor.Increment` diff --git a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx index 0419584b1b..1149f4843f 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx @@ -28,9 +28,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * and Increase a value by some delta. * In this page: - * [Session API Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#session-api-methods) - * [IncrementalTimeSeriesFor Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#methods) - * [Additional Session Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#additional-session-methods) + * [Session API Methods](#session-api-methods) + * [IncrementalTimeSeriesFor Methods](#methods) + * [Additional Session Methods](#additional-session-methods) ## Session API Methods ### `IncrementalTimeSeriesFor` Methods diff --git a/docs/document-extensions/timeseries/incremental-time-series/overview.mdx b/docs/document-extensions/timeseries/incremental-time-series/overview.mdx index 0bc039875a..cef5015ce8 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/overview.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/overview.mdx @@ -30,9 +30,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and via [Studio](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series). * In this page: - * [What are Incremental Time Series and Why Use Them](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#what-are-incremental-time-series-and-why-use-them) - * [Incremental Time Series -vs- Non-incremental Time Series](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#incremental-time-series--vs--non-incremental-time-series) - * [Incremental Time Series Structure](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#incremental-time-series-structure) + * [What are Incremental Time Series and Why Use Them](#what-are-incremental-time-series-and-why-use-them) + * [Incremental Time Series -vs- Non-incremental Time Series](#incremental-time-series--vs--non-incremental-time-series) + * [Incremental Time Series Structure](#incremental-time-series-structure) diff --git a/docs/document-extensions/timeseries/overview.mdx b/docs/document-extensions/timeseries/overview.mdx index 1291e9c8bc..cb6924be2c 100644 --- a/docs/document-extensions/timeseries/overview.mdx +++ b/docs/document-extensions/timeseries/overview.mdx @@ -29,20 +29,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Time series data is **compressed** to lower storage usage and transaction time. * In this page: - * [Overview](../../document-extensions/timeseries/overview.mdx#overview) - * [RavenDB's Time Series Implementation](../../document-extensions/timeseries/overview.mdx#ravendbs-time-series-implementation) - * [Distributed Time Series](../../document-extensions/timeseries/overview.mdx#distributed-time-series) - * [Time Series as Document Extensions](../../document-extensions/timeseries/overview.mdx#time-series-as-document-extensions) - * [Time Series Features](../../document-extensions/timeseries/overview.mdx#time-series-features) - * [Time Series Data](../../document-extensions/timeseries/overview.mdx#time-series-data) - * [Separate Name and Data Storage](../../document-extensions/timeseries/overview.mdx#separate-name-and-data-storage) - * [Time Series Segments](../../document-extensions/timeseries/overview.mdx#time-series-segments) - * [Transactions Performance](../../document-extensions/timeseries/overview.mdx#transactions-performance) - * [Common-Queries Performance](../../document-extensions/timeseries/overview.mdx#common-queries-performance) - * [Time Series Entries](../../document-extensions/timeseries/overview.mdx#time-series-entries) - * [Timestamps](../../document-extensions/timeseries/overview.mdx#timestamps) - * [Values](../../document-extensions/timeseries/overview.mdx#values) - * [Tags](../../document-extensions/timeseries/overview.mdx#tags) + * [Overview](#overview) + * [RavenDB's Time Series Implementation](#ravendbs-time-series-implementation) + * [Distributed Time Series](#distributed-time-series) + * [Time Series as Document Extensions](#time-series-as-document-extensions) + * [Time Series Features](#time-series-features) + * [Time Series Data](#time-series-data) + * [Separate Name and Data Storage](#separate-name-and-data-storage) + * [Time Series Segments](#time-series-segments) + * [Transactions Performance](#transactions-performance) + * [Common-Queries Performance](#common-queries-performance) + * [Time Series Entries](#time-series-entries) + * [Timestamps](#timestamps) + * [Values](#values) + * [Tags](#tags) ## Overview @@ -95,7 +95,7 @@ Notable time series features include - * **Highly-Efficient Storage Management** Time series data is [compressed](../../document-extensions/timeseries/design.mdx#compression) - and [segmented](../../document-extensions/timeseries/overview.mdx#time-series-segments) to minimize storage usage and transmission time. + and [segmented](#time-series-segments) to minimize storage usage and transmission time. * **A Thorough Set of API Methods** The [time series API](../../document-extensions/timeseries/client-api/overview.mdx) includes a variety of `session methods` and `store operations`. * **Full GUI Support** @@ -103,7 +103,7 @@ Notable time series features include - * **Time Series Indexing** Time series can be [indexed](../../document-extensions/timeseries/indexing.mdx). * **Time Series Querying and Aggregation** - * [High-performance common queries](../../document-extensions/timeseries/overview.mdx#common-queries-performance) + * [High-performance common queries](#common-queries-performance) The results of a set of common queries are prepared in advance in time series segments' headers, so the response to querying for a series minimum value, for example, is returned nearly instantly. * [LINQ and raw RQL queries](../../document-extensions/timeseries/querying/overview-and-syntax.mdx) @@ -126,10 +126,10 @@ Notable time series features include - ## Time Series Data Time series **names** are kept in their parent documents' metadata, while their -**data** is kept [separately](../../document-extensions/timeseries/overview.mdx#separate-name-and-data-storage). +**data** is kept [separately](#separate-name-and-data-storage). Time series data is **compressed** and composed of consecutive -[segments](../../document-extensions/timeseries/overview.mdx#time-series-segments) and -[entries](../../document-extensions/timeseries/overview.mdx#time-series-entries). +[segments](#time-series-segments) and +[entries](#time-series-entries). diff --git a/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx index bf0e24a5b8..4fb1ea586a 100644 --- a/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx @@ -12,16 +12,16 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Group by dynamic criteria](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#group-by-dynamic-criteria) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) - * [Syntax](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#syntax) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Group by dynamic criteria](#group-by-dynamic-criteria) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) + * [Syntax](#syntax) ## Grouping and aggregation options diff --git a/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx b/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx index fcfeddad06..6b4cb727d2 100644 --- a/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx +++ b/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) ## Grouping and aggregation options diff --git a/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx b/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx index c685a79942..99456fec1d 100644 --- a/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx +++ b/docs/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; such as an hour or a week. * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) ## Grouping and aggregation options diff --git a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx index db1a0ce715..caff435b91 100644 --- a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx index a8646ada3d..634a82341c 100644 --- a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx +++ b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx index a91e80170b..6b27c8b1c4 100644 --- a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx +++ b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx @@ -9,12 +9,12 @@ import CodeBlock from '@theme/CodeBlock'; such as those collected in the last 7 days. * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx index ab5d0bf799..fd54d0e3da 100644 --- a/docs/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx +++ b/docs/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/docs/document-extensions/timeseries/querying/content/_filtering-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_filtering-csharp.mdx index 2cb42b54a6..1a00c3c2fb 100644 --- a/docs/document-extensions/timeseries/querying/content/_filtering-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_filtering-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/docs/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx b/docs/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx index 3834e2d6ae..5456c0cf5a 100644 --- a/docs/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx +++ b/docs/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/docs/document-extensions/timeseries/querying/content/_filtering-php.mdx b/docs/document-extensions/timeseries/querying/content/_filtering-php.mdx index 000c2f9ed5..6f373aadbe 100644 --- a/docs/document-extensions/timeseries/querying/content/_filtering-php.mdx +++ b/docs/document-extensions/timeseries/querying/content/_filtering-php.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; you can filter the time series entries by their **values**, **tag**, or by the contents of a **document referenced in the tag**. * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/docs/document-extensions/timeseries/querying/content/_filtering-python.mdx b/docs/document-extensions/timeseries/querying/content/_filtering-python.mdx index 0ff2cb3a8a..97593a4a9a 100644 --- a/docs/document-extensions/timeseries/querying/content/_filtering-python.mdx +++ b/docs/document-extensions/timeseries/querying/content/_filtering-python.mdx @@ -9,9 +9,9 @@ In addition to limiting time series query results by specifying the [range of en you can filter the time series entries by their **values**, **tag**, or by the contents of a **document referenced in the tag**. * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/docs/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx index aa202e76f8..cc9952cff1 100644 --- a/docs/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/document-extensions/timeseries/querying/content/_gap-filling-java.mdx b/docs/document-extensions/timeseries/querying/content/_gap-filling-java.mdx index 6f74171f6b..a624a042f4 100644 --- a/docs/document-extensions/timeseries/querying/content/_gap-filling-java.mdx +++ b/docs/document-extensions/timeseries/querying/content/_gap-filling-java.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx b/docs/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx index df0f6d1715..b357fcb810 100644 --- a/docs/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx +++ b/docs/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx index 817359ebaf..961ecfa740 100644 --- a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -141,8 +141,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx index 6981e4d029..293144443a 100644 --- a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx +++ b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -166,8 +166,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx index e745fffde8..ec39508339 100644 --- a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx +++ b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -140,8 +140,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx index f6fc0bec87..47dfbe7e2b 100644 --- a/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx +++ b/docs/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -141,8 +141,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/docs/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx index 770e45febc..f917a7f18f 100644 --- a/docs/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; 2. Stream time series query results. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx b/docs/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx index 01ba11aadc..bf15f86d4e 100644 --- a/docs/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx +++ b/docs/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; 2. Stream time series query results. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx b/docs/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx index d6cf333203..0d8529bdbc 100644 --- a/docs/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx +++ b/docs/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx @@ -24,17 +24,17 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) - * [Syntax](../../../../document-extensions/timeseries/querying/using-indexes.mdx#syntax) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) + * [Syntax](#syntax) ## Sample Index @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/docs/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx b/docs/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx index a051729e29..4c6d93a2f7 100644 --- a/docs/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx +++ b/docs/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx @@ -24,16 +24,16 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) ## Sample Index @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will in the shape of the defined index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/docs/document-extensions/timeseries/querying/content/_using-indexes-php.mdx b/docs/document-extensions/timeseries/querying/content/_using-indexes-php.mdx index 553e1a5486..286530ec41 100644 --- a/docs/document-extensions/timeseries/querying/content/_using-indexes-php.mdx +++ b/docs/document-extensions/timeseries/querying/content/_using-indexes-php.mdx @@ -24,16 +24,16 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) ## Sample Index @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/docs/document-extensions/timeseries/querying/content/_using-indexes-python.mdx b/docs/document-extensions/timeseries/querying/content/_using-indexes-python.mdx index 9ece34ebbf..2c65b8d4a5 100644 --- a/docs/document-extensions/timeseries/querying/content/_using-indexes-python.mdx +++ b/docs/document-extensions/timeseries/querying/content/_using-indexes-python.mdx @@ -28,13 +28,13 @@ import CodeBlock from '@theme/CodeBlock'; The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) - * [Syntax](../../../../document-extensions/timeseries/querying/using-indexes.mdx#syntax) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) + * [Syntax](#syntax) ## Sample Index @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/docs/document-extensions/timeseries/querying/statistics.mdx b/docs/document-extensions/timeseries/querying/statistics.mdx index adea93845f..b1305d51d9 100644 --- a/docs/document-extensions/timeseries/querying/statistics.mdx +++ b/docs/document-extensions/timeseries/querying/statistics.mdx @@ -23,8 +23,8 @@ one measure for the first values in each entry, another measure for the second values in each entry, and so on. * In this page: - * [Syntax](../../../document-extensions/timeseries/querying/statistics.mdx#syntax) - * [Examples](../../../document-extensions/timeseries/querying/statistics.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax @@ -48,7 +48,7 @@ series or range of time series entries. It takes one `double` value that is grea 0 and less than or equal to 100. This represents the percent of the time series values that should be smaller than the result. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Slope * RQL method: `slope()` @@ -64,7 +64,7 @@ the time series, grouping the entries into whole numbers of time units. The difference in time is measured in milliseconds. Use [scaling](../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) to adjust the results to your preferred units. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Standard Deviation * RQL method: `stddev()` @@ -73,7 +73,7 @@ See examples [below](../../../document-extensions/timeseries/querying/statistics These methods return the [standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) of time series values. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Result Format Queries with these methods return results with the following format: diff --git a/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx b/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx index f9537a9a7f..630fa96aaa 100644 --- a/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx +++ b/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx @@ -18,18 +18,18 @@ import Panel from "@site/src/components/Panel"; * Audit stored documents' compliance with a schema to identify and address any validation violations. - * You can run an [audit operation](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#running-an-audit-operation) that scans a document collection or a part of it and generates a validation violations report. - * You can also audit document compliance [by index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#audit-document-compliance-by-index), validating documents during indexing and embedding any validation error messages into the indexes. The indexed documents can then be queried and managed based on their schema compliance. + * You can run an [audit operation](#running-an-audit-operation) that scans a document collection or a part of it and generates a validation violations report. + * You can also audit document compliance [by index](#audit-document-compliance-by-index), validating documents during indexing and embedding any validation error messages into the indexes. The indexed documents can then be queried and managed based on their schema compliance. * In this article: - * [Running an audit operation](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#running-an-audit-operation) - * [`StartSchemaValidationOperation`](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#startschemavalidationoperation) - * [Example](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#example) - * [Audit document compliance by index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#audit-document-compliance-by-index) - * [Define a validation schema](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#define-a-validation-schema) - * [Define and execute an index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#define-and-execute-an-index) - * [Query the index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#query-the-index) - * [Full Example](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#full-example) + * [Running an audit operation](#running-an-audit-operation) + * [`StartSchemaValidationOperation`](#startschemavalidationoperation) + * [Example](#example) + * [Audit document compliance by index](#audit-document-compliance-by-index) + * [Define a validation schema](#define-a-validation-schema) + * [Define and execute an index](#define-and-execute-an-index) + * [Query the index](#query-the-index) + * [Full Example](#full-example) @@ -158,7 +158,7 @@ public class Order Use this audit approach to continuously validate document compliance during indexing and store validation error messages in the index. The index can then be queried to filter documents by their compliance status. -This method is useful for checking data integrity in large or frequently changing datasets, where [a single audit operation](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#running-an-audit-operation) may be less efficient. +This method is useful for checking data integrity in large or frequently changing datasets, where [a single audit operation](#running-an-audit-operation) may be less efficient. To validate documents by index: @@ -166,7 +166,7 @@ To validate documents by index: #### Define a validation schema Define a validation schema that the index will use to validate documents during indexing. -The index will use the schema defined in its index configuration (see [below](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#defining-an-index-level-validation-schema) how to define it). +The index will use the schema defined in its index configuration (see [below](#defining-an-index-level-validation-schema) how to define it). * If no schema is defined in the index configuration, the index will use the [database-level schema](../../../documents/schema-validation/write-validation/write-validation_api.mdx#creating-a-validation-schema). * If no schema is defined either in the index configuration or at the database level, the index will not perform any validation. diff --git a/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx b/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx index 41b5026c84..bba11e0f1b 100644 --- a/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx +++ b/docs/documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx @@ -18,17 +18,17 @@ import Panel from "@site/src/components/Panel"; To check document compliance with a validation schema via Studio, you can: - - Run a manual [validation test operation](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#running-a-validation-test), that goes through a collection or a part of it and reports invalid documents and their validation errors. - - Create an [audit index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#audit-documents-compliance-by-index), that validates documents during indexing and stores any validation error messages in the index, so the documents can be queried by compliance status and specific validation error messages. + - Run a manual [validation test operation](#running-a-validation-test), that goes through a collection or a part of it and reports invalid documents and their validation errors. + - Create an [audit index](#audit-documents-compliance-by-index), that validates documents during indexing and stores any validation error messages in the index, so the documents can be queried by compliance status and specific validation error messages. * In this article: - * [Running a validation test](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#running-a-validation-test) - * [Test a schema using the Document Schema view](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#test-a-schema-using-the-document-schema-view) - * [Test a schema using the Schema Playground](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#test-a-schema-using-the-schema-playground) - * [Audit documents compliance by index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#audit-documents-compliance-by-index) - * [Define a validation schema](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#define-a-validation-schema) - * [Create the audit index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#create-the-audit-index) - * [Query the index](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#query-the-index) + * [Running a validation test](#running-a-validation-test) + * [Test a schema using the Document Schema view](#test-a-schema-using-the-document-schema-view) + * [Test a schema using the Schema Playground](#test-a-schema-using-the-schema-playground) + * [Audit documents compliance by index](#audit-documents-compliance-by-index) + * [Define a validation schema](#define-a-validation-schema) + * [Create the audit index](#create-the-audit-index) + * [Query the index](#query-the-index) @@ -84,7 +84,7 @@ You can define an **audit index** that validates documents against a schema duri #### Define a validation schema The index will use the schema defined in its index configuration. -See how to add a schema to the index configuration [below](../../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_studio.mdx#create-the-audit-index). +See how to add a schema to the index configuration [below](#create-the-audit-index). * If no schema is defined in the index configuration, the index will use the [database-level schema](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#creating-a-collection-schema). * If no schema is defined either in the index configuration or at the database level, the index will not perform any validation. diff --git a/docs/documents/schema-validation/configuration.mdx b/docs/documents/schema-validation/configuration.mdx index cf7e0c7a1b..7942d9ceef 100644 --- a/docs/documents/schema-validation/configuration.mdx +++ b/docs/documents/schema-validation/configuration.mdx @@ -20,9 +20,9 @@ import Panel from "@site/src/components/Panel"; This page aims to clarify the scope of settings and configurations related to schema validation. * In this article: - * [Enabling and disabling validation for the database](../../documents/schema-validation/configuration.mdx#enabling-and-disabling-validation-for-the-database) - * [Per-collection configuration](../../documents/schema-validation/configuration.mdx#per-collection-configuration) - * [Index configuration](../../documents/schema-validation/configuration.mdx#index-configuration) + * [Enabling and disabling validation for the database](#enabling-and-disabling-validation-for-the-database) + * [Per-collection configuration](#per-collection-configuration) + * [Index configuration](#index-configuration) diff --git a/docs/documents/schema-validation/overview.mdx b/docs/documents/schema-validation/overview.mdx index 329d110b7d..4978cb9f23 100644 --- a/docs/documents/schema-validation/overview.mdx +++ b/docs/documents/schema-validation/overview.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; * A validation schema is a JSON object associated with a document collection. If a schema is enabled for a collection, the collection's documents can be written only if the documents comply with the constraints defined by the schema. -* Validation is enforced both when documents are saved directly, and when they are added or modified via [supported batch operations](../../documents/schema-validation/overview.mdx#a-list-of-operations-that-trigger-validation) such as patching or ETL tasks. +* Validation is enforced both when documents are saved directly, and when they are added or modified via [supported batch operations](#a-list-of-operations-that-trigger-validation) such as patching or ETL tasks. * Validating document compliance during writing can help ensure data consistency (e.g., by preventing the saving of documents with missing required fields) and simplify read-time handling by preventing the need for additional checks and transformations. @@ -32,12 +32,12 @@ import Panel from "@site/src/components/Panel"; - By [validating documents during indexing](../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api.mdx#audit-document-compliance-by-index) and embedding validation error messages in the indexes. * In this article: - * [The validation process](../../documents/schema-validation/overview.mdx#the-validation-process) - * [A list of operations that trigger validation](../../documents/schema-validation/overview.mdx#a-list-of-operations-that-trigger-validation) - * [Available constraints](../../documents/schema-validation/overview.mdx#available-constraints) - * [Considerations](../../documents/schema-validation/overview.mdx#considerations) - * [Auditing schema validation](../../documents/schema-validation/overview.mdx#auditing-schema-validation) - * [Use cases](../../documents/schema-validation/overview.mdx#use-cases) + * [The validation process](#the-validation-process) + * [A list of operations that trigger validation](#a-list-of-operations-that-trigger-validation) + * [Available constraints](#available-constraints) + * [Considerations](#considerations) + * [Auditing schema validation](#auditing-schema-validation) + * [Use cases](#use-cases) diff --git a/docs/documents/schema-validation/write-validation/write-validation_api.mdx b/docs/documents/schema-validation/write-validation/write-validation_api.mdx index 749b2fa1a2..7b2dafadfe 100644 --- a/docs/documents/schema-validation/write-validation/write-validation_api.mdx +++ b/docs/documents/schema-validation/write-validation/write-validation_api.mdx @@ -24,14 +24,14 @@ import Panel from "@site/src/components/Panel"; * Validation is automatically triggered when documents in the associated collection are saved directly or via operations such as patching or ETL tasks. * In this article: - * [Creating a validation schema](../../../documents/schema-validation/write-validation/write-validation_api.mdx#creating-a-validation-schema) - * [Define your schema as a string](../../../documents/schema-validation/write-validation/write-validation_api.mdx#1-define-your-schema-as-a-string) - * [Create the schema configuration](../../../documents/schema-validation/write-validation/write-validation_api.mdx#2-create-the-schema-configuration) - * [Register the schema with the server](../../../documents/schema-validation/write-validation/write-validation_api.mdx#3-register-the-schema-with-the-server) - * [Validate documents](../../../documents/schema-validation/write-validation/write-validation_api.mdx#4-validate-documents) - * [Example](../../../documents/schema-validation/write-validation/write-validation_api.mdx#example) - * [Available constraints](../../../documents/schema-validation/write-validation/write-validation_api.mdx#available-constraints) - * [Syntax](../../../documents/schema-validation/write-validation/write-validation_api.mdx#syntax) + * [Creating a validation schema](#creating-a-validation-schema) + * [Define your schema as a string](#1-define-your-schema-as-a-string) + * [Create the schema configuration](#2-create-the-schema-configuration) + * [Register the schema with the server](#3-register-the-schema-with-the-server) + * [Validate documents](#4-validate-documents) + * [Example](#example) + * [Available constraints](#available-constraints) + * [Syntax](#syntax) @@ -149,7 +149,7 @@ string schemaDefinition = @"{ ### 2. Create the schema configuration -Create a [SchemaValidationConfiguration](../../../documents/schema-validation/write-validation/write-validation_api.mdx#schemavalidationconfiguration-class) object and use it to enable validation and associate your schema with a document collection. +Create a [SchemaValidationConfiguration](#schemavalidationconfiguration-class) object and use it to enable validation and associate your schema with a document collection. E.g., to associate your schema with the `Users` collection: ```csharp @@ -174,7 +174,7 @@ var configuration = new SchemaValidationConfiguration ### 3. Register the schema with the server -Use [ConfigureSchemaValidationOperation](../../../documents/schema-validation/write-validation/write-validation_api.mdx#configureschemavalidationoperation-definition) to register the schema configuration with the server. +Use [ConfigureSchemaValidationOperation](#configureschemavalidationoperation-definition) to register the schema configuration with the server. E.g., ```csharp @@ -193,7 +193,7 @@ Once a schema is enabled for a collection, collection documents are validated wh ### 4. Validate documents After registering the schema, any document saved to the associated collection will be validated against the schema constraints. -E.g., attempting to save a document that violates the `maxLength` constraint will result in a [SchemaValidationException](../../../documents/schema-validation/write-validation/write-validation_api.mdx#schemavalidationexception-message) such as: +E.g., attempting to save a document that violates the `maxLength` constraint will result in a [SchemaValidationException](#schemavalidationexception-message) such as: ```plain Raven.Client.Exceptions.SchemaValidation.SchemaValidationException: The length of the value 'TooLongValue' at 'Name' should not exceed 7, but its actual length is 12. ``` diff --git a/docs/documents/schema-validation/write-validation/write-validation_studio.mdx b/docs/documents/schema-validation/write-validation/write-validation_studio.mdx index 67866fe911..4da3d32a7c 100644 --- a/docs/documents/schema-validation/write-validation/write-validation_studio.mdx +++ b/docs/documents/schema-validation/write-validation/write-validation_studio.mdx @@ -20,11 +20,11 @@ import Panel from "@site/src/components/Panel"; Manage [schema validation](../../../documents/schema-validation/overview.mdx) using the Studio **Document Schema** view, to condition documents storage on their compliance with a defined JSON schema. * In this article: - * [The Document Schema view](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#the-document-schema-view) - * [Creating a collection schema](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#creating-a-collection-schema) - * [Managing and Testing existing schemas](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#managing-and-testing-existing-schemas) - * [The schema playground](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#the-schema-playground) - * [Validating a specific document](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#validating-a-specific-document) + * [The Document Schema view](#the-document-schema-view) + * [Creating a collection schema](#creating-a-collection-schema) + * [Managing and Testing existing schemas](#managing-and-testing-existing-schemas) + * [The schema playground](#the-schema-playground) + * [Validating a specific document](#validating-a-specific-document) @@ -39,9 +39,9 @@ Use this view to create, test, and manage document schemas for your database col 2. **Document schema** Click to open this view. 3. **Schema playground** - Click to create and test schemas in a [secluded playground](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#the-schema-playground). + Click to create and test schemas in a [secluded playground](#the-schema-playground). 3. **Add new** - Click to create a [new schema](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#creating-a-collection-schema) associated with one of your document collections. + Click to create a [new schema](#creating-a-collection-schema) associated with one of your document collections. @@ -187,7 +187,7 @@ To create and test schemas in a secluded environment, without affecting your pro To validate a specific document against the schema defined for its collection, open the [document view](../../../studio/database/documents/document-view.mdx#the-document-view), select the document, and click the **Validate document** button. * The validation button will be displayed only if a schema is defined for the document's collection. -* To validate a whole collection, use the **Document Schema** view [Test](../../../documents/schema-validation/write-validation/write-validation_studio.mdx#managing-and-testing-existing-schemas) as described above. +* To validate a whole collection, use the **Document Schema** view [Test](#managing-and-testing-existing-schemas) as described above. ![Validate document button](./assets/schema-validation_studio_validate-document-button.png) diff --git a/docs/indexes/additional-assemblies.mdx b/docs/indexes/additional-assemblies.mdx index 38d9d89dc9..5553b6b2ab 100644 --- a/docs/indexes/additional-assemblies.mdx +++ b/docs/indexes/additional-assemblies.mdx @@ -31,11 +31,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; all of the index's Additional Assemblies. * In this page: - * [Syntax](../indexes/additional-assemblies.mdx#syntax) - * [Examples](../indexes/additional-assemblies.mdx#examples) - * [Basic Example](../indexes/additional-assemblies.mdx#basic-example) - * [Complex Example](../indexes/additional-assemblies.mdx#complex-example) - * [Pre-Release Packages](../indexes/additional-assemblies.mdx#pre-release-packages) + * [Syntax](#syntax) + * [Examples](#examples) + * [Basic Example](#basic-example) + * [Complex Example](#complex-example) + * [Pre-Release Packages](#pre-release-packages) ## Syntax diff --git a/docs/indexes/content/_boosting-csharp.mdx b/docs/indexes/content/_boosting-csharp.mdx index 95b737977e..a39d58d28d 100644 --- a/docs/indexes/content/_boosting-csharp.mdx +++ b/docs/indexes/content/_boosting-csharp.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -284,7 +284,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** * When using **Corax** as the underlying indexing engine, a boost factor can only be assigned - to the [index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + to the [index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an _index-field_ is Not supported. * When using **Lucene**, a boost factor can be assigned to both the index-field and the whole index-entry. diff --git a/docs/indexes/content/_boosting-java.mdx b/docs/indexes/content/_boosting-java.mdx index 95e8765ded..5f9a1b97a9 100644 --- a/docs/indexes/content/_boosting-java.mdx +++ b/docs/indexes/content/_boosting-java.mdx @@ -8,7 +8,7 @@ a basic score is calculated for each document in the results by the underlying e Providing a **boost value** to some fields allows you to prioritize the resulting documents. The boost value is integrated with the basic score, making the document rank higher. -Automatic ordering of the results by the score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +Automatic ordering of the results by the score is [configurable](#automatic-score-based-ordering). From the index perspective we can associate to an index entry a boosting factor. The higher value it has, the more relevant term will be. To do this, we must use the `Boost` method. diff --git a/docs/indexes/content/_boosting-nodejs.mdx b/docs/indexes/content/_boosting-nodejs.mdx index 6211954a3c..2712587025 100644 --- a/docs/indexes/content/_boosting-nodejs.mdx +++ b/docs/indexes/content/_boosting-nodejs.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -160,7 +160,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** - * When using **Corax** as the underlying indexing engine, you can only [assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + * When using **Corax** as the underlying indexing engine, you can only [assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an index-field is Not supported. * When using **Lucene**, you can assign a boost factor to both the index-field and the whole index-entry. diff --git a/docs/indexes/content/_boosting-php.mdx b/docs/indexes/content/_boosting-php.mdx index 86091e0857..5e82e6b30a 100644 --- a/docs/indexes/content/_boosting-php.mdx +++ b/docs/indexes/content/_boosting-php.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -294,7 +294,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** * When using **Corax** as the underlying indexing engine, a boost factor can only be assigned - to the [index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + to the [index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an _index-field_ is Not supported. * When using **Lucene**, a boost factor can be assigned to both the index-field and the whole index-entry. diff --git a/docs/indexes/content/_creating-and-deploying-csharp.mdx b/docs/indexes/content/_creating-and-deploying-csharp.mdx index 5ce269cdc1..c42ca1aa39 100644 --- a/docs/indexes/content/_creating-and-deploying-csharp.mdx +++ b/docs/indexes/content/_creating-and-deploying-csharp.mdx @@ -9,25 +9,25 @@ import CodeBlock from '@theme/CodeBlock'; For a general overview of indexes, see [What are indexes](../../indexes/what-are-indexes.mdx). * You can either: - * [create a Static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or - * let the RavenDB server [create an Auto-index](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) for you based on query patterns. + * [create a Static-index](#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or + * let the RavenDB server [create an Auto-index](#creating-auto-indexes) for you based on query patterns. * Static-indexes can be created: * using the Client API, as outlined in this article, or * from the [Indexes list view](../../studio/database/indexes/indexes-list-view.mdx) in the Studio. * In this page: - * [Static-indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Define a static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) - * [Deploy a static-index](../../indexes/creating-and-deploying.mdx#deploy-a-static-index) - * [Deploy single index](../../indexes/creating-and-deploying.mdx#deploy-single-index) - * [Deploy multiple indexes](../../indexes/creating-and-deploying.mdx#deploy-multiple-indexes) - * [Deploy syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) - * [Deployment behavior](../../indexes/creating-and-deploying.mdx#deployment-behavior) - * [Creating a static-index - Example](../../indexes/creating-and-deploying.mdx#create-a-static-index---example) - * [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Creating auto-indexes](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) - * [Disabling auto-indexes](../../indexes/creating-and-deploying.mdx#disabling-auto-indexes) + * [Static-indexes](#static-indexes) + * [Define a static-index](#define-a-static-index) + * [Deploy a static-index](#deploy-a-static-index) + * [Deploy single index](#deploy-single-index) + * [Deploy multiple indexes](#deploy-multiple-indexes) + * [Deploy syntax](#deploy-syntax) + * [Deployment behavior](#deployment-behavior) + * [Creating a static-index - Example](#create-a-static-index---example) + * [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation) + * [Auto-indexes](#auto-indexes) + * [Creating auto-indexes](#creating-auto-indexes) + * [Disabling auto-indexes](#disabling-auto-indexes) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; ##### Define a static-index using a custom class * To define a static-index using a custom class inherit from `AbstractIndexCreationTask`. -* This method is recommended over the [Creating an index using an operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) method +* This method is recommended over the [Creating an index using an operation](#create-a-static-index---using-an-operation) method for its simplicity and the following advantages: * **Strongly-typed syntax**: Provides strong typing when defining the index, making it easier to work with. @@ -65,7 +65,7 @@ public class Orders_ByTotal : AbstractIndexCreationTask `} -* A complete example of creating a static-index is provided [below](../../indexes/creating-and-deploying.mdx#create-a-static-index---example). +* A complete example of creating a static-index is provided [below](#create-a-static-index---example). @@ -105,13 +105,13 @@ public class Orders_ByTotal : AbstractIndexCreationTask * To begin indexing data, the index must be deployed to the server. * This section provides options for deploying indexes that inherit from `AbstractIndexCreationTask`. * To create and deploy an index using the `IndexDefinition` class via `PutIndexesOperation`, - see [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation). + see [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation). ##### Deploy single index * Use `Execute()` or `ExecuteIndex()` to deploy a single index. * The following examples deploy index `Ordes/ByTotal` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -156,7 +156,7 @@ await store.ExecuteIndexAsync(new Orders_ByTotal()); If it fails, it will repeat the execution by calling the `Execute` method for each index, one by one, in separate requests. * The following examples deploy indexes `Ordes/ByTotal` and `Employees/ByLastName` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -401,7 +401,7 @@ public static void Main(string[] args) * When using this operation: - * Unlike the [naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) used with indexes inheriting from `AbstractIndexCreationTask`, + * Unlike the [naming convention](#naming-convention) used with indexes inheriting from `AbstractIndexCreationTask`, you can choose any string-based name for the index. However, when querying, you must use that string-based name rather than the index class type. diff --git a/docs/indexes/content/_creating-and-deploying-java.mdx b/docs/indexes/content/_creating-and-deploying-java.mdx index 1c1717746a..157f5545f2 100644 --- a/docs/indexes/content/_creating-and-deploying-java.mdx +++ b/docs/indexes/content/_creating-and-deploying-java.mdx @@ -26,40 +26,40 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes created by issuing a query are called `dynamic` or `Auto` indexes. * They can be easily identified. Their name starts with the `Auto/` prefix. - * If no [Auto-Index](../../indexes/creating-and-deploying.mdx#auto-indexes) exists to satisfy a query, + * If no [Auto-Index](#auto-indexes) exists to satisfy a query, a new Auto-Index will be created and maintained automatically. * Indexes created explicitly by the user are called `static`. * [To use a Static Index in a query](../../indexes/querying/query-index.mdx), **you must specify the index in the query definition**. If you don't specify the index, RavenDB will look for an auto-index and potentially create a new one. * Static Indexes can be defined to do calculations, conversions, and various other processes behind the scenes, to prevent - doing these costly processes at query time (see [Using AbstractIndexCreationTask](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask), + doing these costly processes at query time (see [Using AbstractIndexCreationTask](#using-abstractindexcreationtask), our [map-indexes](../../indexes/map-indexes.mdx) article, [indexing multiple collections](../../indexes/multi-map-indexes.mdx), and [map-reduce indexing](../../indexes/map-reduce-indexes.mdx)). * In this page: - * [Static indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Using AbstractIndexCreationTask](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask) - * [Naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) - * [Sending to server](../../indexes/creating-and-deploying.mdx#sending-to-server) - * [Creating an index with custom configuration](../../indexes/creating-and-deploying.mdx#creating-an-index-with-custom-configuration) - * [Using assembly scanner](../../indexes/creating-and-deploying.mdx#using-assembly-scanner) - * [Example](../../indexes/creating-and-deploying.mdx#example) - * [Using maintenance operations](../../indexes/creating-and-deploying.mdx#using-maintenance-operations) - * [IndexDefinitionBuilder](../../indexes/creating-and-deploying.mdx#indexdefinitionbuilder) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Naming convention](../../indexes/creating-and-deploying.mdx#naming-convention-1) - * [Auto indexes and indexing state](../../indexes/creating-and-deploying.mdx#auto-indexes-and-indexing-state) - * [If indexes exhaust system resources](../../indexes/creating-and-deploying.mdx#if-indexes-exhaust-system-resources) + * [Static indexes](#static-indexes) + * [Using AbstractIndexCreationTask](#using-abstractindexcreationtask) + * [Naming convention](#naming-convention) + * [Sending to server](#sending-to-server) + * [Creating an index with custom configuration](#creating-an-index-with-custom-configuration) + * [Using assembly scanner](#using-assembly-scanner) + * [Example](#example) + * [Using maintenance operations](#using-maintenance-operations) + * [IndexDefinitionBuilder](#indexdefinitionbuilder) + * [Auto-indexes](#auto-indexes) + * [Naming convention](#naming-convention-1) + * [Auto indexes and indexing state](#auto-indexes-and-indexing-state) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) ## Static indexes -There are a couple of ways to create a `static index` and send it to the server. We can use [maintenance operations](../../indexes/creating-and-deploying.mdx#using-maintenance-operations) or create a [custom class](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask). +There are a couple of ways to create a `static index` and send it to the server. We can use [maintenance operations](#using-maintenance-operations) or create a [custom class](#using-abstractindexcreationtask). --- diff --git a/docs/indexes/content/_creating-and-deploying-nodejs.mdx b/docs/indexes/content/_creating-and-deploying-nodejs.mdx index f8eca7db69..6ae945d077 100644 --- a/docs/indexes/content/_creating-and-deploying-nodejs.mdx +++ b/docs/indexes/content/_creating-and-deploying-nodejs.mdx @@ -9,25 +9,25 @@ import CodeBlock from '@theme/CodeBlock'; For a general overview of indexes, see [What are indexes](../../indexes/what-are-indexes.mdx). * You can either: - * [create a Static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or - * let the RavenDB server [create an Auto-index](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) for you based on query patterns. + * [create a Static-index](#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or + * let the RavenDB server [create an Auto-index](#creating-auto-indexes) for you based on query patterns. * Static-indexes can be created: * using the Client API, as outlined in this article, or * from the [Indexes list view](../../studio/database/indexes/indexes-list-view.mdx) in the Studio. * In this page: - * [Static-indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Define a static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) - * [Deploy a static-index](../../indexes/creating-and-deploying.mdx#deploy-a-static-index) - * [Deploy single index](../../indexes/creating-and-deploying.mdx#deploy-single-index) - * [Deploy multiple indexes](../../indexes/creating-and-deploying.mdx#deploy-multiple-indexes) - * [Deploy syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) - * [Deployment behavior](../../indexes/creating-and-deploying.mdx#deployment-behavior) - * [Creating a static-index - Example](../../indexes/creating-and-deploying.mdx#create-a-static-index---example) - * [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Creating auto-indexes](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) - * [Disabling auto-indexes](../../indexes/creating-and-deploying.mdx#disabling-auto-indexes) + * [Static-indexes](#static-indexes) + * [Define a static-index](#define-a-static-index) + * [Deploy a static-index](#deploy-a-static-index) + * [Deploy single index](#deploy-single-index) + * [Deploy multiple indexes](#deploy-multiple-indexes) + * [Deploy syntax](#deploy-syntax) + * [Deployment behavior](#deployment-behavior) + * [Creating a static-index - Example](#create-a-static-index---example) + * [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation) + * [Auto-indexes](#auto-indexes) + * [Creating auto-indexes](#creating-auto-indexes) + * [Disabling auto-indexes](#disabling-auto-indexes) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; ##### Define a static-index using a custom class * To define a static-index using a custom class, extend the `AbstractJavaScriptIndexCreationTask` class. -* This method is recommended over the [Creating an index using an operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) method +* This method is recommended over the [Creating an index using an operation](#create-a-static-index---using-an-operation) method for its simplified index definition, offering a straightforward way to define the index. @@ -58,7 +58,7 @@ import CodeBlock from '@theme/CodeBlock'; `} -* A complete example of creating a static-index is provided [below](../../indexes/creating-and-deploying.mdx#create-a-static-index---example). +* A complete example of creating a static-index is provided [below](#create-a-static-index---example). @@ -100,13 +100,13 @@ import CodeBlock from '@theme/CodeBlock'; * To begin indexing data, the index must be deployed to the server. * This section provides options for deploying indexes that inherit from `AbstractJavaScriptIndexCreationTask`. * To create and deploy an index using the `IndexDefinition` class via `PutIndexesOperation`, - see [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation). + see [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation). ##### Deploy single index * Use `execute()` or `executeIndex()` to deploy a single index. * The following examples deploy index `Ordes/ByTotal` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -132,7 +132,7 @@ await documentStore.executeIndex(new Orders_ByTotal()); If it fails, it will repeat the execution by calling the `execute` method for each index, one by one, in separate requests. * The following examples deploy indexes `Ordes/ByTotal` and `Employees/ByLastName` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -275,7 +275,7 @@ async function main() \{ * When using this operation: - * Unlike the [naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) used with indexes inheriting from `AbstractJavaScriptIndexCreationTask`, + * Unlike the [naming convention](#naming-convention) used with indexes inheriting from `AbstractJavaScriptIndexCreationTask`, you can choose any string-based name for the index. However, when querying, you must use that string-based name rather than the index class type. diff --git a/docs/indexes/content/_extending-indexes-csharp.mdx b/docs/indexes/content/_extending-indexes-csharp.mdx index 510e0ac2c6..cf6757e2e2 100644 --- a/docs/indexes/content/_extending-indexes-csharp.mdx +++ b/docs/indexes/content/_extending-indexes-csharp.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/docs/indexes/content/_extending-indexes-java.mdx b/docs/indexes/content/_extending-indexes-java.mdx index 46bf6b4534..13f21647e0 100644 --- a/docs/indexes/content/_extending-indexes-java.mdx +++ b/docs/indexes/content/_extending-indexes-java.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/docs/indexes/content/_extending-indexes-nodejs.mdx b/docs/indexes/content/_extending-indexes-nodejs.mdx index f72a842b7a..58d2e5a594 100644 --- a/docs/indexes/content/_extending-indexes-nodejs.mdx +++ b/docs/indexes/content/_extending-indexes-nodejs.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/docs/indexes/content/_indexing-hierarchical-data-csharp.mdx b/docs/indexes/content/_indexing-hierarchical-data-csharp.mdx index 7bb5c596c8..9fe58fe3e8 100644 --- a/docs/indexes/content/_indexing-hierarchical-data-csharp.mdx +++ b/docs/indexes/content/_indexing-hierarchical-data-csharp.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -90,7 +90,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/docs/indexes/content/_indexing-hierarchical-data-nodejs.mdx b/docs/indexes/content/_indexing-hierarchical-data-nodejs.mdx index 29893dc8d0..a769b7a1fb 100644 --- a/docs/indexes/content/_indexing-hierarchical-data-nodejs.mdx +++ b/docs/indexes/content/_indexing-hierarchical-data-nodejs.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -92,7 +92,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/docs/indexes/content/_indexing-hierarchical-data-php.mdx b/docs/indexes/content/_indexing-hierarchical-data-php.mdx index f1ac73dacc..78293f5e57 100644 --- a/docs/indexes/content/_indexing-hierarchical-data-php.mdx +++ b/docs/indexes/content/_indexing-hierarchical-data-php.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -168,7 +168,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/docs/indexes/content/_indexing-hierarchical-data-python.mdx b/docs/indexes/content/_indexing-hierarchical-data-python.mdx index 34eb3e4d9b..689d9d45c0 100644 --- a/docs/indexes/content/_indexing-hierarchical-data-python.mdx +++ b/docs/indexes/content/_indexing-hierarchical-data-python.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -89,7 +89,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/docs/indexes/content/_indexing-linq-extensions-csharp.mdx b/docs/indexes/content/_indexing-linq-extensions-csharp.mdx index 4d78c1f828..a63f170e74 100644 --- a/docs/indexes/content/_indexing-linq-extensions-csharp.mdx +++ b/docs/indexes/content/_indexing-linq-extensions-csharp.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/docs/indexes/content/_indexing-linq-extensions-java.mdx b/docs/indexes/content/_indexing-linq-extensions-java.mdx index 3c7b5249bc..802ac05b8b 100644 --- a/docs/indexes/content/_indexing-linq-extensions-java.mdx +++ b/docs/indexes/content/_indexing-linq-extensions-java.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/docs/indexes/content/_indexing-linq-extensions-nodejs.mdx b/docs/indexes/content/_indexing-linq-extensions-nodejs.mdx index d6a5965164..e4569f17b0 100644 --- a/docs/indexes/content/_indexing-linq-extensions-nodejs.mdx +++ b/docs/indexes/content/_indexing-linq-extensions-nodejs.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/docs/indexes/content/_indexing-metadata-csharp.mdx b/docs/indexes/content/_indexing-metadata-csharp.mdx index b63e7dbe06..873cb84a78 100644 --- a/docs/indexes/content/_indexing-metadata-csharp.mdx +++ b/docs/indexes/content/_indexing-metadata-csharp.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/docs/indexes/content/_indexing-metadata-java.mdx b/docs/indexes/content/_indexing-metadata-java.mdx index 946a3c9263..db8bc915db 100644 --- a/docs/indexes/content/_indexing-metadata-java.mdx +++ b/docs/indexes/content/_indexing-metadata-java.mdx @@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) + * [Indexing metadata properties](#indexing-metadata-properties) ## Indexing metadata properties diff --git a/docs/indexes/content/_indexing-metadata-nodejs.mdx b/docs/indexes/content/_indexing-metadata-nodejs.mdx index d72e4b75fd..cd760971e6 100644 --- a/docs/indexes/content/_indexing-metadata-nodejs.mdx +++ b/docs/indexes/content/_indexing-metadata-nodejs.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/docs/indexes/content/_indexing-metadata-php.mdx b/docs/indexes/content/_indexing-metadata-php.mdx index ae14788be5..947ab3ac0b 100644 --- a/docs/indexes/content/_indexing-metadata-php.mdx +++ b/docs/indexes/content/_indexing-metadata-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/docs/indexes/content/_indexing-metadata-python.mdx b/docs/indexes/content/_indexing-metadata-python.mdx index d4bce9739d..31cd3e9b40 100644 --- a/docs/indexes/content/_indexing-metadata-python.mdx +++ b/docs/indexes/content/_indexing-metadata-python.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/docs/indexes/content/_indexing-nested-data-csharp.mdx b/docs/indexes/content/_indexing-nested-data-csharp.mdx index 56437d0503..f97d6ca1c2 100644 --- a/docs/indexes/content/_indexing-nested-data-csharp.mdx +++ b/docs/indexes/content/_indexing-nested-data-csharp.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -563,7 +563,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), then in this case, the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/docs/indexes/content/_indexing-nested-data-nodejs.mdx b/docs/indexes/content/_indexing-nested-data-nodejs.mdx index 10772d86bc..9f46265224 100644 --- a/docs/indexes/content/_indexing-nested-data-nodejs.mdx +++ b/docs/indexes/content/_indexing-nested-data-nodejs.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -383,7 +383,7 @@ where color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `totalResults` property (available when calling the query `statistics()` method) diff --git a/docs/indexes/content/_indexing-nested-data-php.mdx b/docs/indexes/content/_indexing-nested-data-php.mdx index 3f7c90b372..11c53af6bf 100644 --- a/docs/indexes/content/_indexing-nested-data-php.mdx +++ b/docs/indexes/content/_indexing-nested-data-php.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -608,7 +608,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/docs/indexes/content/_indexing-nested-data-python.mdx b/docs/indexes/content/_indexing-nested-data-python.mdx index 7fc420551c..d54540ea9f 100644 --- a/docs/indexes/content/_indexing-nested-data-python.mdx +++ b/docs/indexes/content/_indexing-nested-data-python.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -428,7 +428,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/docs/indexes/content/_indexing-polymorphic-data-csharp.mdx b/docs/indexes/content/_indexing-polymorphic-data-csharp.mdx index 0280110a61..faff7cb5fa 100644 --- a/docs/indexes/content/_indexing-polymorphic-data-csharp.mdx +++ b/docs/indexes/content/_indexing-polymorphic-data-csharp.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/docs/indexes/content/_indexing-polymorphic-data-java.mdx b/docs/indexes/content/_indexing-polymorphic-data-java.mdx index e54be18a3b..527426f2f0 100644 --- a/docs/indexes/content/_indexing-polymorphic-data-java.mdx +++ b/docs/indexes/content/_indexing-polymorphic-data-java.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/docs/indexes/content/_indexing-polymorphic-data-nodejs.mdx b/docs/indexes/content/_indexing-polymorphic-data-nodejs.mdx index 753137ec91..e188d14d83 100644 --- a/docs/indexes/content/_indexing-polymorphic-data-nodejs.mdx +++ b/docs/indexes/content/_indexing-polymorphic-data-nodejs.mdx @@ -9,11 +9,11 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this page: - * [The challenge](../../indexes/indexing-polymorphic-data.mdx#the-challenge) - * [Possible solutions:](../../indexes/indexing-polymorphic-data.mdx#possible-solutions) - * [Multi-map index](../../indexes/indexing-polymorphic-data.mdx#multi-map-index) - * [Polymorphic index](../../indexes/indexing-polymorphic-data.mdx#polymorphic-index) - * [Customize collection](../../indexes/indexing-polymorphic-data.mdx#customize-collection) + * [The challenge](#the-challenge) + * [Possible solutions:](#possible-solutions) + * [Multi-map index](#multi-map-index) + * [Polymorphic index](#polymorphic-index) + * [Customize collection](#customize-collection) ## The challenge diff --git a/docs/indexes/content/_indexing-polymorphic-data-php.mdx b/docs/indexes/content/_indexing-polymorphic-data-php.mdx index e22dc153cc..cd0023b362 100644 --- a/docs/indexes/content/_indexing-polymorphic-data-php.mdx +++ b/docs/indexes/content/_indexing-polymorphic-data-php.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/docs/indexes/content/_indexing-polymorphic-data-python.mdx b/docs/indexes/content/_indexing-polymorphic-data-python.mdx index e0f1998866..4491fae79c 100644 --- a/docs/indexes/content/_indexing-polymorphic-data-python.mdx +++ b/docs/indexes/content/_indexing-polymorphic-data-python.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/docs/indexes/content/_indexing-related-documents-csharp.mdx b/docs/indexes/content/_indexing-related-documents-csharp.mdx index ab2058099f..023a878f57 100644 --- a/docs/indexes/content/_indexing-related-documents-csharp.mdx +++ b/docs/indexes/content/_indexing-related-documents-csharp.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -269,7 +269,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -287,7 +287,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/docs/indexes/content/_indexing-related-documents-nodejs.mdx b/docs/indexes/content/_indexing-related-documents-nodejs.mdx index 052b1d118d..9175bf2fa2 100644 --- a/docs/indexes/content/_indexing-related-documents-nodejs.mdx +++ b/docs/indexes/content/_indexing-related-documents-nodejs.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) + * [What are related documents](#what-are-related-documents) - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). **The index**: @@ -239,7 +239,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -258,7 +258,7 @@ where BookNames = "The Witcher" * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). **The index**: diff --git a/docs/indexes/content/_indexing-related-documents-php.mdx b/docs/indexes/content/_indexing-related-documents-php.mdx index 7394b7dac6..ebd813f063 100644 --- a/docs/indexes/content/_indexing-related-documents-php.mdx +++ b/docs/indexes/content/_indexing-related-documents-php.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -316,7 +316,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -334,7 +334,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/docs/indexes/content/_indexing-related-documents-python.mdx b/docs/indexes/content/_indexing-related-documents-python.mdx index 9bdfd27308..f55338cd99 100644 --- a/docs/indexes/content/_indexing-related-documents-python.mdx +++ b/docs/indexes/content/_indexing-related-documents-python.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -224,7 +224,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -242,7 +242,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/docs/indexes/content/_indexing-spatial-data-csharp.mdx b/docs/indexes/content/_indexing-spatial-data-csharp.mdx index c822ca8496..8c97cfc856 100644 --- a/docs/indexes/content/_indexing-spatial-data-csharp.mdx +++ b/docs/indexes/content/_indexing-spatial-data-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -148,7 +148,7 @@ object CreateSpatialField(string shapeWkt); // Shape in WKT string form Use the `Spatial` method from `AbstractIndexCreationTask` to modify this setting. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/docs/indexes/content/_indexing-spatial-data-nodejs.mdx b/docs/indexes/content/_indexing-spatial-data-nodejs.mdx index 20a76799d0..c82d819209 100644 --- a/docs/indexes/content/_indexing-spatial-data-nodejs.mdx +++ b/docs/indexes/content/_indexing-spatial-data-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -141,7 +141,7 @@ createSpatialField(wkt); Use the `spatial` method to modify this setting. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/docs/indexes/content/_indexing-spatial-data-php.mdx b/docs/indexes/content/_indexing-spatial-data-php.mdx index 56c5438810..6607020d7a 100644 --- a/docs/indexes/content/_indexing-spatial-data-php.mdx +++ b/docs/indexes/content/_indexing-spatial-data-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -205,7 +205,7 @@ object CreateSpatialField(string shapeWkt); // Shape in WKT string form * **By default**, the `geohashPrefixTreeIndex` strategy is used with `geohashLevel` set to **9**. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/docs/indexes/content/_indexing-spatial-data-python.mdx b/docs/indexes/content/_indexing-spatial-data-python.mdx index a7c4bf8ec4..d80b843ad9 100644 --- a/docs/indexes/content/_indexing-spatial-data-python.mdx +++ b/docs/indexes/content/_indexing-spatial-data-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -134,7 +134,7 @@ class WktField(DynamicSpatialField): # Shape in WKT string format * **By default**, the `geohash_prefix_tree_index` strategy is used with `geohash_level` set to **9**. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/docs/indexes/content/_javascript-indexes-csharp.mdx b/docs/indexes/content/_javascript-indexes-csharp.mdx index b276615b98..929d536785 100644 --- a/docs/indexes/content/_javascript-indexes-csharp.mdx +++ b/docs/indexes/content/_javascript-indexes-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; In addition, RavenDB provides a set of predefined JavaScript functions that can be used in JavaScript indexes and in other features such as subscriptions, ETL scripts, set-based patching, and more. See the full list in [Predefined JavaScript functions](../../server/kb/javascript-engine.mdx#predefined-javascript-functions). * In this article: - * [Creating and deploying a JavaScript index](../../indexes/javascript-indexes.mdx#creating-and-deploying-a-javascript-index) - * [Map index](../../indexes/javascript-indexes.mdx#map-index) - * [Map index - basic](../../indexes/javascript-indexes.mdx#example-i---map-index---basic) - * [Map index - with additional sources](../../indexes/javascript-indexes.mdx#example-ii---map-index---with-additional-sources) - * [Map index - with inline string compilation](../../indexes/javascript-indexes.mdx#example-iii---map-index---with-inline-string-compilation) - * [Multi-Map index](../../indexes/javascript-indexes.mdx#multi-map-index) - * [Map-Reduce index](../../indexes/javascript-indexes.mdx#map-reduce-index) + * [Creating and deploying a JavaScript index](#creating-and-deploying-a-javascript-index) + * [Map index](#map-index) + * [Map index - basic](#example-i---map-index---basic) + * [Map index - with additional sources](#example-ii---map-index---with-additional-sources) + * [Map index - with inline string compilation](#example-iii---map-index---with-inline-string-compilation) + * [Multi-Map index](#multi-map-index) + * [Map-Reduce index](#map-reduce-index) @@ -70,7 +70,7 @@ public class Documents_ByName_JS : AbstractJavaScriptIndexCreationTask ## Map index * A map index contains a single `map` function. - To define an index that uses multiple map functions, see the section on [Multi-Map indexes](../../indexes/javascript-indexes.mdx#multi-map-index) below. + To define an index that uses multiple map functions, see the section on [Multi-Map indexes](#multi-map-index) below. * The `map` function is written as a string and specifies what content from the documents will be indexed. diff --git a/docs/indexes/content/_map-indexes-csharp.mdx b/docs/indexes/content/_map-indexes-csharp.mdx index 82c536f6a8..06a41cc614 100644 --- a/docs/indexes/content/_map-indexes-csharp.mdx +++ b/docs/indexes/content/_map-indexes-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; JavaScript indexes); they can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/docs/indexes/content/_map-indexes-java.mdx b/docs/indexes/content/_map-indexes-java.mdx index 49f70a23b2..3c38d3df98 100644 --- a/docs/indexes/content/_map-indexes-java.mdx +++ b/docs/indexes/content/_map-indexes-java.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; JavaScript indexes); they can be considered the **core** of indexes. * In this page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Indexing nested data](#indexing-nested-data) diff --git a/docs/indexes/content/_map-indexes-nodejs.mdx b/docs/indexes/content/_map-indexes-nodejs.mdx index a1687da3b1..9325de5f93 100644 --- a/docs/indexes/content/_map-indexes-nodejs.mdx +++ b/docs/indexes/content/_map-indexes-nodejs.mdx @@ -11,11 +11,11 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions are **LINQ-based functions**; they can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/docs/indexes/content/_map-indexes-php.mdx b/docs/indexes/content/_map-indexes-php.mdx index 255d24ccb9..f2e78a4648 100644 --- a/docs/indexes/content/_map-indexes-php.mdx +++ b/docs/indexes/content/_map-indexes-php.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/docs/indexes/content/_map-indexes-python.mdx b/docs/indexes/content/_map-indexes-python.mdx index 922cd7aa75..2d4b4eabb9 100644 --- a/docs/indexes/content/_map-indexes-python.mdx +++ b/docs/indexes/content/_map-indexes-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/docs/indexes/content/_map-reduce-indexes-csharp.mdx b/docs/indexes/content/_map-reduce-indexes-csharp.mdx index 39d782797b..7ac6e2db7b 100644 --- a/docs/indexes/content/_map-reduce-indexes-csharp.mdx +++ b/docs/indexes/content/_map-reduce-indexes-csharp.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -515,7 +515,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -527,7 +527,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -547,7 +547,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -803,7 +803,7 @@ public class OutputReduceToCollectionReference #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/docs/indexes/content/_map-reduce-indexes-java.mdx b/docs/indexes/content/_map-reduce-indexes-java.mdx index 1338f6b9cf..684670df54 100644 --- a/docs/indexes/content/_map-reduce-indexes-java.mdx +++ b/docs/indexes/content/_map-reduce-indexes-java.mdx @@ -23,9 +23,9 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Important Comments](../../indexes/map-reduce-indexes.mdx#important-comments) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Important Comments](#important-comments) @@ -396,7 +396,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -408,7 +408,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -428,7 +428,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -578,7 +578,7 @@ May 6th 1998. ## Important Comments ## Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. ## Recursive indexing loop diff --git a/docs/indexes/content/_map-reduce-indexes-nodejs.mdx b/docs/indexes/content/_map-reduce-indexes-nodejs.mdx index 1a9f9832cf..4ba013bf8c 100644 --- a/docs/indexes/content/_map-reduce-indexes-nodejs.mdx +++ b/docs/indexes/content/_map-reduce-indexes-nodejs.mdx @@ -23,9 +23,9 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Important Comments](../../indexes/map-reduce-indexes.mdx#important-comments) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Important Comments](#important-comments) @@ -227,7 +227,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -317,7 +317,7 @@ const patternForOutputReduceToCollectionReferences = indexDefinition.patternForO ## Important Comments ## Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. ## Recursive indexing loop diff --git a/docs/indexes/content/_map-reduce-indexes-php.mdx b/docs/indexes/content/_map-reduce-indexes-php.mdx index 9bad365dde..cf50c110ad 100644 --- a/docs/indexes/content/_map-reduce-indexes-php.mdx +++ b/docs/indexes/content/_map-reduce-indexes-php.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -700,7 +700,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in the [example](../../indexes/map-reduce-indexes.mdx#example) below may generate +The index in the [example](#example) below may generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -720,7 +720,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in this [example](../../indexes/map-reduce-indexes.mdx#example) has this pattern for +The index in this [example](#example) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -928,7 +928,7 @@ May 6th 1998. #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/docs/indexes/content/_map-reduce-indexes-python.mdx b/docs/indexes/content/_map-reduce-indexes-python.mdx index 5da418f54e..17648710bb 100644 --- a/docs/indexes/content/_map-reduce-indexes-python.mdx +++ b/docs/indexes/content/_map-reduce-indexes-python.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -454,7 +454,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -466,7 +466,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -486,7 +486,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -644,7 +644,7 @@ May 6th 1998. #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/docs/indexes/content/_multi-map-indexes-csharp.mdx b/docs/indexes/content/_multi-map-indexes-csharp.mdx index fe7f2e02ba..0e3dcbae4a 100644 --- a/docs/indexes/content/_multi-map-indexes-csharp.mdx +++ b/docs/indexes/content/_multi-map-indexes-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [AddMap & AddMapForAll](../../indexes/multi-map-indexes.mdx#addmap--addmapforall) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [AddMap & AddMapForAll](#addmap--addmapforall) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/docs/indexes/content/_multi-map-indexes-java.mdx b/docs/indexes/content/_multi-map-indexes-java.mdx index e9a0b53af3..68bccd953a 100644 --- a/docs/indexes/content/_multi-map-indexes-java.mdx +++ b/docs/indexes/content/_multi-map-indexes-java.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [AddMap](../../indexes/multi-map-indexes.mdx#addmap) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [AddMap](#addmap) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/docs/indexes/content/_multi-map-indexes-nodejs.mdx b/docs/indexes/content/_multi-map-indexes-nodejs.mdx index cb74caae01..af01a97b2a 100644 --- a/docs/indexes/content/_multi-map-indexes-nodejs.mdx +++ b/docs/indexes/content/_multi-map-indexes-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [Indexing multiple collections](../../indexes/multi-map-indexes.mdx#indexing-multiple-collections) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [Indexing multiple collections](#indexing-multiple-collections) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/docs/indexes/content/_multi-map-indexes-php.mdx b/docs/indexes/content/_multi-map-indexes-php.mdx index 943a2e8d7b..75ce89be26 100644 --- a/docs/indexes/content/_multi-map-indexes-php.mdx +++ b/docs/indexes/content/_multi-map-indexes-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [`addMap`](../../indexes/multi-map-indexes.mdx#addmap) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [`addMap`](#addmap) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/docs/indexes/content/_multi-map-indexes-python.mdx b/docs/indexes/content/_multi-map-indexes-python.mdx index c00cb5324f..605f74fc21 100644 --- a/docs/indexes/content/_multi-map-indexes-python.mdx +++ b/docs/indexes/content/_multi-map-indexes-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [`_add_map`](../../indexes/multi-map-indexes.mdx#_add_map) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [`_add_map`](#_add_map) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/docs/indexes/content/_number-type-conversion-csharp.mdx b/docs/indexes/content/_number-type-conversion-csharp.mdx index 9b20c88b9a..e9a5ae4383 100644 --- a/docs/indexes/content/_number-type-conversion-csharp.mdx +++ b/docs/indexes/content/_number-type-conversion-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more about how numbers are stored in RavenDB [here](../../server/kb/numbers-in-ravendb.mdx). * In this page: - * [Syntax](../number-type-conversion.mdx#syntax) - * [Examples](../number-type-conversion.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/docs/indexes/content/_storing-data-in-index-csharp.mdx b/docs/indexes/content/_storing-data-in-index-csharp.mdx index 22f78f07ae..cb4bf076c2 100644 --- a/docs/indexes/content/_storing-data-in-index-csharp.mdx +++ b/docs/indexes/content/_storing-data-in-index-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; This behavior can be configured at the query level. See [Projection behavior with a static-index](../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) for details. * In this article: - * [What content is stored in the index](../../indexes/storing-data-in-index.mdx#what-content-is-stored-in-the-index) - * [When and why to store data in an index](../../indexes/storing-data-in-index.mdx#when-and-why-to-store-data-in-an-index) - * [Storing data in index - from the Client API](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-client-api) - * [Storing data in index - from the Studio](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-studio) + * [What content is stored in the index](#what-content-is-stored-in-the-index) + * [When and why to store data in an index](#when-and-why-to-store-data-in-an-index) + * [Storing data in index - from the Client API](#storing-data-in-index---from-the-client-api) + * [Storing data in index - from the Studio](#storing-data-in-index---from-the-studio) ## What content is stored in the index @@ -382,7 +382,7 @@ To configure index-fields from the Studio, open the _Edit Index_ view: ![The index](../assets/store-field-in-index-1.png) -1. This is the index from the [example above](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-client-api). +1. This is the index from the [example above](#storing-data-in-index---from-the-client-api). 2. These are the index-fields defined in the index map function. Scroll down to configure each index-field: @@ -398,7 +398,7 @@ you can choose to display the stored index fields in the Results view: ![Display the stored fields](../assets/store-field-in-index-3.png) -1. This is the query from the [example above](../../indexes/storing-data-in-index.mdx#query-the-index). +1. This is the query from the [example above](#query-the-index). 2. Open the _Settings_ options. 3. Toggle ON _Show stored index fields only_. 4. When executing the query, diff --git a/docs/indexes/content/_storing-data-in-index-java.mdx b/docs/indexes/content/_storing-data-in-index-java.mdx index 004928e64b..a3690ad3dc 100644 --- a/docs/indexes/content/_storing-data-in-index-java.mdx +++ b/docs/indexes/content/_storing-data-in-index-java.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/docs/indexes/content/_storing-data-in-index-nodejs.mdx b/docs/indexes/content/_storing-data-in-index-nodejs.mdx index 54bc8c893c..d763b44a2c 100644 --- a/docs/indexes/content/_storing-data-in-index-nodejs.mdx +++ b/docs/indexes/content/_storing-data-in-index-nodejs.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/docs/indexes/content/_storing-data-in-index-php.mdx b/docs/indexes/content/_storing-data-in-index-php.mdx index ba55ebff8b..243e64603a 100644 --- a/docs/indexes/content/_storing-data-in-index-php.mdx +++ b/docs/indexes/content/_storing-data-in-index-php.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/docs/indexes/content/_storing-data-in-index-python.mdx b/docs/indexes/content/_storing-data-in-index-python.mdx index 08c35b8d49..7a92cab527 100644 --- a/docs/indexes/content/_storing-data-in-index-python.mdx +++ b/docs/indexes/content/_storing-data-in-index-python.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/docs/indexes/content/_using-analyzers-csharp.mdx b/docs/indexes/content/_using-analyzers-csharp.mdx index be8e7bd1f7..93fd91f43b 100644 --- a/docs/indexes/content/_using-analyzers-csharp.mdx +++ b/docs/indexes/content/_using-analyzers-csharp.mdx @@ -23,26 +23,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; giving you full flexibility in configuring your indexes. * In this article: - * [Understanding the role of analyzers](../../indexes/using-analyzers.mdx#understanding-the-role-of-analyzers) - * [Analyzers in the index definition](../../indexes/using-analyzers.mdx#analyzers-in-the-index-definition) - * [Analyzers at indexing time](../../indexes/using-analyzers.mdx#analyzers-at-indexing-time) - * [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) - * [Full-text search](../../indexes/using-analyzers.mdx#full-text-search) - * [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb) - * [Analyzers that remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) - * [Analyzers that do not remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words) - * [Analyzers that tokenize according to the defined number of characters](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) - * [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field) - * [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendbs-default-analyzers) - * [Using the Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) - * [Using the Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer) - * [Using the Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) - * [Disabling indexing for index-field](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field) - * [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers) - * [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - * [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - * [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) - * [Viewing the indexed terms](../../indexes/using-analyzers.mdx#viewing-the-indexed-terms) + * [Understanding the role of analyzers](#understanding-the-role-of-analyzers) + * [Analyzers in the index definition](#analyzers-in-the-index-definition) + * [Analyzers at indexing time](#analyzers-at-indexing-time) + * [Analyzers at query time](#analyzers-at-query-time) + * [Full-text search](#full-text-search) + * [Analyzers available in RavenDB](#analyzers-available-in-ravendb) + * [Analyzers that remove common stop words](#analyzers-that-remove-common-stop-words) + * [Analyzers that do not remove common stop words](#analyzers-that-do-not-remove-common-stop-words) + * [Analyzers that tokenize according to the defined number of characters](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) + * [Setting analyzer for index-field](#setting-analyzer-for-index-field) + * [RavenDB's default analyzers](#ravendbs-default-analyzers) + * [Using the Default Search Analyzer](#using-the-default-search-analyzer) + * [Using the Default Exact Analyzer](#using-the-default-exact-analyzer) + * [Using the Default Analyzer](#using-the-default-analyzer) + * [Disabling indexing for index-field](#disabling-indexing-for-index-field) + * [Creating custom analyzers](#creating-custom-analyzers) + * [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + * [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + * [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) + * [Viewing the indexed terms](#viewing-the-indexed-terms) @@ -77,7 +77,7 @@ enabling [Full-text search](../../indexes/querying/searching.mdx). ### Analyzers at query time When running a [Full-text search with a dynamic query](../../client-api/session/querying/text-search/full-text-search.mdx), -the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). +the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](#using-the-default-search-analyzer). When running a [Full-text search on a static-index](../../indexes/querying/query-index.mdx), the **same analyzer** used to tokenize field content at indexing time is typically applied @@ -85,10 +85,10 @@ to process the terms provided in the full-text search query before they are sent There are two exceptions to this rule: - 1. When setting the [NGramAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, + 1. When setting the [NGramAnalyzer](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, it tokenizes the index field at indexing time. However, at query time, when performing a full-text search on that field, - the default [RavenStandardAnalyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. + the default [RavenStandardAnalyzer](#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. Currently, for query time, you cannot specify a different analyzer than the one defined in the index definition, so to address this issue, you have two options: @@ -103,8 +103,8 @@ There are two exceptions to this rule: ### Full-text search -In most cases, Lucene's [StandardAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. -For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +In most cases, Lucene's [StandardAnalyzer](#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. +For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](#creating-custom-analyzers). It is straightforward and may already be available as a contrib package for Lucene. You can also configure a specific collation for an index field to sort based on culture specific rules. @@ -126,13 +126,13 @@ Learn more in [Sorting and Collation](../../indexes/sorting-and-collation.mdx#co * **KeywordAnalyzer** * **NGramAnalyzer** -* If needed, you can create your own [Customized Analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +* If needed, you can create your own [Customized Analyzers](#creating-custom-analyzers). * To assign the analyzer of your choice to a specific index-field, - see: [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). + see: [Setting analyzer for index-field](#setting-analyzer-for-index-field). * When no analyzer is explicitly assigned to an index-field in the index definition, - RavenDB will use its [Default Analyzers](../../indexes/using-analyzers.mdx#ravendb) to process and tokenize the content of a field. + RavenDB will use its [Default Analyzers](#ravendb) to process and tokenize the content of a field. All examples below use the following text: @@ -177,7 +177,7 @@ All examples below use the following text: be aware that analyzers removing common stop words may treat IT as a stop word and exclude it from the resulting terms. This can also affect acronyms such as WHO (World Health Organization) or names such as "The Who" or "The IT Crowd". * To avoid excluding acronyms, you can either spell out the full title instead of abbreviating it - or use an [Analyzer that doesn't remove stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words). + or use an [Analyzer that doesn't remove stop words](#analyzers-that-do-not-remove-common-stop-words). @@ -272,7 +272,7 @@ All examples below use the following text: In RavenDB, the analyzer configured in the index definition is typically used both at indexing time and query time (the same analyzer). However, the `NGramAnalyzer` is an exception to this rule. - Refer to section [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) to learn about the different behaviors. + Refer to section [Analyzers at query time](#analyzers-at-query-time) to learn about the different behaviors. @@ -284,10 +284,10 @@ All examples below use the following text: use the `Analyzers.Add()` method within the index definition for that field. * Either: - * Specify an analyzer from the [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb), - * Or specify your own custom analyzer (see [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers)). + * Specify an analyzer from the [Analyzers available in RavenDB](#analyzers-available-in-ravendb), + * Or specify your own custom analyzer (see [Creating custom analyzers](#creating-custom-analyzers)). -* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendb). +* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](#ravendb). * An analyzer may also be set from the Edit Index view in the Studio, see [Index field options](../../studio/database/indexes/create-map-index.mdx#index-field-options). @@ -356,14 +356,14 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); depending on the specified Indexing Behavior. * The **Default Analyzers** are: - * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). - * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer). - * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer). + * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](#using-the-default-search-analyzer). + * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](#using-the-default-exact-analyzer). + * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](#using-the-default-analyzer). * The available **Indexing Behavior** values are: * `FieldIndexing.Exact` * `FieldIndexing.Search` - * `FieldIndexing.No` - This behavior [disables field indexing](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field). + * `FieldIndexing.No` - This behavior [disables field indexing](#disabling-indexing-for-index-field). * See the detailed explanation for each scenario below: @@ -548,9 +548,9 @@ public class BlogPosts_ByTitle : AbstractIndexCreationTask * **Ways to create**: There are three ways to create a custom analyzer and add it to your server: - 1. [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - 2. [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - 3. [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) + 1. [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + 2. [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + 3. [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) diff --git a/docs/indexes/content/_using-analyzers-java.mdx b/docs/indexes/content/_using-analyzers-java.mdx index 3b83f9c11d..c15959e44e 100644 --- a/docs/indexes/content/_using-analyzers-java.mdx +++ b/docs/indexes/content/_using-analyzers-java.mdx @@ -16,13 +16,13 @@ The **Tokenization** process uses an object called an Analyzer underneath. The indexing process and its results can be controlled by various field options and Analyzers. * In this article: - * [Understanding Analyzers](../../indexes/using-analyzers.mdx#understanding-analyzers) - * [RavenDB Default Analyzer](../../indexes/using-analyzers.mdx#ravendb-default-analyzer) - * [Full-Text Search](../../indexes/using-analyzers.mdx#full-text-search) - * [Using Non-Default Analyzer](../../indexes/using-analyzers.mdx#using-non-default-analyzer) - * [Creating Own Analyzer](../../indexes/using-analyzers.mdx#creating-own-analyzer) - * [Manipulating Field Indexing Behavior](../../indexes/using-analyzers.mdx#manipulating-field-indexing-behavior) - * [Ordering When Field is Searchable](../../indexes/using-analyzers.mdx#ordering-when-field-is-searchable) + * [Understanding Analyzers](#understanding-analyzers) + * [RavenDB Default Analyzer](#ravendb-default-analyzer) + * [Full-Text Search](#full-text-search) + * [Using Non-Default Analyzer](#using-non-default-analyzer) + * [Creating Own Analyzer](#creating-own-analyzer) + * [Manipulating Field Indexing Behavior](#manipulating-field-indexing-behavior) + * [Ordering When Field is Searchable](#ordering-when-field-is-searchable) diff --git a/docs/indexes/content/_using-analyzers-nodejs.mdx b/docs/indexes/content/_using-analyzers-nodejs.mdx index d07293d2c1..053c2c8ea0 100644 --- a/docs/indexes/content/_using-analyzers-nodejs.mdx +++ b/docs/indexes/content/_using-analyzers-nodejs.mdx @@ -23,26 +23,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; giving you full flexibility in configuring your indexes. * In this article: - * [Understanding the role of analyzers](../../indexes/using-analyzers.mdx#understanding-the-role-of-analyzers) - * [Analyzers in the index definition](../../indexes/using-analyzers.mdx#analyzers-in-the-index-definition) - * [Analyzers at indexing time](../../indexes/using-analyzers.mdx#analyzers-at-indexing-time) - * [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) - * [Full-text search](../../indexes/using-analyzers.mdx#full-text-search) - * [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb) - * [Analyzers that remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) - * [Analyzers that do not remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words) - * [Analyzers that tokenize according to the defined number of characters](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) - * [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field) - * [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendbs-default-analyzers) - * [Using the Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) - * [Using the Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer) - * [Using the Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) - * [Disabling indexing for index-field](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field) - * [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers) - * [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - * [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - * [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) - * [Viewing the indexed terms](../../indexes/using-analyzers.mdx#viewing-the-indexed-terms) + * [Understanding the role of analyzers](#understanding-the-role-of-analyzers) + * [Analyzers in the index definition](#analyzers-in-the-index-definition) + * [Analyzers at indexing time](#analyzers-at-indexing-time) + * [Analyzers at query time](#analyzers-at-query-time) + * [Full-text search](#full-text-search) + * [Analyzers available in RavenDB](#analyzers-available-in-ravendb) + * [Analyzers that remove common stop words](#analyzers-that-remove-common-stop-words) + * [Analyzers that do not remove common stop words](#analyzers-that-do-not-remove-common-stop-words) + * [Analyzers that tokenize according to the defined number of characters](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) + * [Setting analyzer for index-field](#setting-analyzer-for-index-field) + * [RavenDB's default analyzers](#ravendbs-default-analyzers) + * [Using the Default Search Analyzer](#using-the-default-search-analyzer) + * [Using the Default Exact Analyzer](#using-the-default-exact-analyzer) + * [Using the Default Analyzer](#using-the-default-analyzer) + * [Disabling indexing for index-field](#disabling-indexing-for-index-field) + * [Creating custom analyzers](#creating-custom-analyzers) + * [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + * [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + * [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) + * [Viewing the indexed terms](#viewing-the-indexed-terms) @@ -77,7 +77,7 @@ enabling [Full-text search](../../indexes/querying/searching.mdx). ### Analyzers at query time When running a [Full-text search with a dynamic query](../../client-api/session/querying/text-search/full-text-search.mdx), -the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). +the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](#using-the-default-search-analyzer). When running a [Full-text search on a static-index](../../indexes/querying/query-index.mdx), the **same analyzer** used to tokenize field content at indexing time is typically applied @@ -85,10 +85,10 @@ to process the terms provided in the full-text search query before they are sent There are two exceptions to this rule: -1. When setting the [NGramAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, +1. When setting the [NGramAnalyzer](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, it tokenizes the index field at indexing time. However, at query time, when performing a full-text search on that field, - the default [RavenStandardAnalyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. + the default [RavenStandardAnalyzer](#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. Currently, for query time, you cannot specify a different analyzer than the one defined in the index definition, so to address this issue, you have two options: @@ -103,8 +103,8 @@ There are two exceptions to this rule: ### Full-text search -In most cases, Lucene's [StandardAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. -For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +In most cases, Lucene's [StandardAnalyzer](#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. +For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](#creating-custom-analyzers). It is straightforward and may already be available as a contrib package for Lucene. You can also configure a specific collation for an index field to sort based on culture specific rules. @@ -126,13 +126,13 @@ Learn more in [Sorting and Collation](../../indexes/sorting-and-collation.mdx#co * **KeywordAnalyzer** * **NGramAnalyzer** -* If needed, you can create your own [Customized Analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +* If needed, you can create your own [Customized Analyzers](#creating-custom-analyzers). * To assign the analyzer of your choice to a specific index-field, - see: [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). + see: [Setting analyzer for index-field](#setting-analyzer-for-index-field). * When no analyzer is explicitly assigned to an index-field in the index definition, - RavenDB will use its [Default Analyzers](../../indexes/using-analyzers.mdx#ravendb) to process and tokenize the content of a field. + RavenDB will use its [Default Analyzers](#ravendb) to process and tokenize the content of a field. All examples below use the following text: @@ -177,7 +177,7 @@ All examples below use the following text: be aware that analyzers removing common stop words may treat IT as a stop word and exclude it from the resulting terms. This can also affect acronyms such as WHO (World Health Organization) or names such as "The Who" or "The IT Crowd". * To avoid excluding acronyms, you can either spell out the full title instead of abbreviating it - or use an [Analyzer that doesn't remove stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words). + or use an [Analyzer that doesn't remove stop words](#analyzers-that-do-not-remove-common-stop-words). @@ -272,7 +272,7 @@ All examples below use the following text: In RavenDB, the analyzer configured in the index definition is typically used both at indexing time and query time (the same analyzer). However, the `NGramAnalyzer` is an exception to this rule. - Refer to section [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) to learn about the different behaviors. + Refer to section [Analyzers at query time](#analyzers-at-query-time) to learn about the different behaviors. @@ -284,10 +284,10 @@ All examples below use the following text: set the `analyze()` method within the index definition for that field. * Either: - * Specify an analyzer from the [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb), - * Or specify your own custom analyzer (see [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers)). + * Specify an analyzer from the [Analyzers available in RavenDB](#analyzers-available-in-ravendb), + * Or specify your own custom analyzer (see [Creating custom analyzers](#creating-custom-analyzers)). -* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendb). +* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](#ravendb). * An analyzer may also be set from the Edit Index view in the Studio, see [Index field options](../../studio/database/indexes/create-map-index.mdx#index-field-options). @@ -340,14 +340,14 @@ await store.maintenance depending on the specified Indexing Behavior. * The **Default Analyzers** are: - * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). - * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer). - * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer). + * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](#using-the-default-search-analyzer). + * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](#using-the-default-exact-analyzer). + * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](#using-the-default-analyzer). * The available **Indexing Behavior** values are: * `Exact` * `Search` - * `No` - This behavior [disables field indexing](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field). + * `No` - This behavior [disables field indexing](#disabling-indexing-for-index-field). * See the detailed explanation for each scenario below: @@ -522,9 +522,9 @@ class BlogPosts_ByTitle extends AbstractIndexCreationTask { * **Ways to create**: There are three ways to create a custom analyzer and add it to your server: - 1. [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - 2. [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - 3. [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) + 1. [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + 2. [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + 3. [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) diff --git a/docs/indexes/content/_using-dynamic-fields-csharp.mdx b/docs/indexes/content/_using-dynamic-fields-csharp.mdx index 5bf052d482..228f125616 100644 --- a/docs/indexes/content/_using-dynamic-fields-csharp.mdx +++ b/docs/indexes/content/_using-dynamic-fields-csharp.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -282,7 +282,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -539,7 +539,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `AllFields` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `AllFields` has an analyzer configuration, RavenDB uses it as a fallback. @@ -558,7 +558,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -935,7 +935,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/docs/indexes/content/_using-dynamic-fields-java.mdx b/docs/indexes/content/_using-dynamic-fields-java.mdx index d54ef6bea8..56e198d91a 100644 --- a/docs/indexes/content/_using-dynamic-fields-java.mdx +++ b/docs/indexes/content/_using-dynamic-fields-java.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -276,7 +276,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -523,7 +523,7 @@ or `FieldIndexing.Search` in the `CreateFieldOptions` (`AbstractIndexCreationTas At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -542,7 +542,7 @@ or `FieldIndexing.Search` in the `CreateFieldOptions` (`AbstractIndexCreationTas The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -910,7 +910,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/docs/indexes/content/_using-dynamic-fields-nodejs.mdx b/docs/indexes/content/_using-dynamic-fields-nodejs.mdx index c14184c2b5..3e315a05a8 100644 --- a/docs/indexes/content/_using-dynamic-fields-nodejs.mdx +++ b/docs/indexes/content/_using-dynamic-fields-nodejs.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`createField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`createField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -247,7 +247,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -459,7 +459,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -478,7 +478,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -722,7 +722,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/docs/indexes/content/_using-dynamic-fields-php.mdx b/docs/indexes/content/_using-dynamic-fields-php.mdx index 6992310715..4853440cda 100644 --- a/docs/indexes/content/_using-dynamic-fields-php.mdx +++ b/docs/indexes/content/_using-dynamic-fields-php.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -293,7 +293,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -569,7 +569,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -588,7 +588,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -981,7 +981,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/docs/indexes/content/_using-dynamic-fields-python.mdx b/docs/indexes/content/_using-dynamic-fields-python.mdx index 6862d18067..4b11f90065 100644 --- a/docs/indexes/content/_using-dynamic-fields-python.mdx +++ b/docs/indexes/content/_using-dynamic-fields-python.mdx @@ -19,17 +19,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -277,7 +277,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -520,7 +520,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -539,7 +539,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -897,7 +897,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/docs/indexes/content/_using-term-vectors-csharp.mdx b/docs/indexes/content/_using-term-vectors-csharp.mdx index bd120be8c4..4774ed598c 100644 --- a/docs/indexes/content/_using-term-vectors-csharp.mdx +++ b/docs/indexes/content/_using-term-vectors-csharp.mdx @@ -16,9 +16,9 @@ import CodeBlock from '@theme/CodeBlock'; stored term vectors to accomplish their goals. * In this page: - * [Creating an index and enabling Term Vectors on a field](../../indexes/using-term-vectors.mdx#creating-an-index-and-enabling-term-vectors-on-a-field) - * [Using the API](../../indexes/using-term-vectors.mdx#using-the-api) - * [Using Studio](../../indexes/using-term-vectors.mdx#using-studio) + * [Creating an index and enabling Term Vectors on a field](#creating-an-index-and-enabling-term-vectors-on-a-field) + * [Using the API](#using-the-api) + * [Using Studio](#using-studio) ## Creating an index and enabling Term Vectors on a field diff --git a/docs/indexes/content/_what-are-indexes-csharp.mdx b/docs/indexes/content/_what-are-indexes-csharp.mdx index c282d6023f..88835b1927 100644 --- a/docs/indexes/content/_what-are-indexes-csharp.mdx +++ b/docs/indexes/content/_what-are-indexes-csharp.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/docs/indexes/content/_what-are-indexes-java.mdx b/docs/indexes/content/_what-are-indexes-java.mdx index c659762888..37e52f7aaf 100644 --- a/docs/indexes/content/_what-are-indexes-java.mdx +++ b/docs/indexes/content/_what-are-indexes-java.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/docs/indexes/content/_what-are-indexes-nodejs.mdx b/docs/indexes/content/_what-are-indexes-nodejs.mdx index 4d8a0c4a8f..4b718920ec 100644 --- a/docs/indexes/content/_what-are-indexes-nodejs.mdx +++ b/docs/indexes/content/_what-are-indexes-nodejs.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/docs/indexes/content/_what-are-indexes-php.mdx b/docs/indexes/content/_what-are-indexes-php.mdx index 7b2a5a27bc..e002fbca04 100644 --- a/docs/indexes/content/_what-are-indexes-php.mdx +++ b/docs/indexes/content/_what-are-indexes-php.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/docs/indexes/content/_what-are-indexes-python.mdx b/docs/indexes/content/_what-are-indexes-python.mdx index d7ac45c30f..51e49901cf 100644 --- a/docs/indexes/content/_what-are-indexes-python.mdx +++ b/docs/indexes/content/_what-are-indexes-python.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/docs/indexes/index-administration.mdx b/docs/indexes/index-administration.mdx index 6e3ea9564d..f6da1b57f9 100644 --- a/docs/indexes/index-administration.mdx +++ b/docs/indexes/index-administration.mdx @@ -19,17 +19,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; or via [Maintenance operations](../client-api/operations/what-are-operations.mdx#maintenance-operations) in the Client API. * In this article: - * [Index management operations](../indexes/index-administration.mdx#index-management-operations) - * [Pause & resume index](../indexes/index-administration.mdx#pause--resume-index) - * [Pause & resume indexing](../indexes/index-administration.mdx#pause--resume-indexing) - * [Disable & enable index](../indexes/index-administration.mdx#disable--enable-index) - * [Disable & enable indexing](../indexes/index-administration.mdx#disable--enable-indexing) - * [Reset index](../indexes/index-administration.mdx#reset-index) - * [Delete index](../indexes/index-administration.mdx#delete-index) - * [Set index lock mode](../indexes/index-administration.mdx#set-index-lock-mode) - * [Set index priority](../indexes/index-administration.mdx#set-index-priority) - * [Index states](../indexes/index-administration.mdx#index-states) - * [Customize indexing configuration](../indexes/index-administration.mdx#customize-indexing-configuration) + * [Index management operations](#index-management-operations) + * [Pause & resume index](#pause--resume-index) + * [Pause & resume indexing](#pause--resume-indexing) + * [Disable & enable index](#disable--enable-index) + * [Disable & enable indexing](#disable--enable-indexing) + * [Reset index](#reset-index) + * [Delete index](#delete-index) + * [Set index lock mode](#set-index-lock-mode) + * [Set index priority](#set-index-priority) + * [Index states](#index-states) + * [Customize indexing configuration](#customize-indexing-configuration) ## Index management operations diff --git a/docs/indexes/index-throttling.mdx b/docs/indexes/index-throttling.mdx index da26f74a7d..bd9121f263 100644 --- a/docs/indexes/index-throttling.mdx +++ b/docs/indexes/index-throttling.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Indexing is triggered normally when items are added or modified, but RavenDB suspends index procession by the set interval. * The gaps in indexing activity and the procession of - [larger batches](../indexes/index-throttling.mdx#throttling-and-batches) + [larger batches](#throttling-and-batches) can reduce overall indexing CPU utilization. * Indexing can be throttled server-wide, per-database, and per-index. * Index throttling applies to the procession of **existing** indexes. @@ -27,11 +27,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * [Why Use Index Throttling?](../indexes/index-throttling.mdx#why-use-index-throttling?) - * [Index Throttling and Batches](../indexes/index-throttling.mdx#throttling-and-batches) - * [Setting Index Throttling](../indexes/index-throttling.mdx#setting-index-throttling) - * [Server-Wide](../indexes/index-throttling.mdx#server-wide-index-throttling) - * [Per-Database](../indexes/index-throttling.mdx#index-throttling-per-database) - * [Per-Index](../indexes/index-throttling.mdx#index-throttling-in-an-index-definition) + * [Index Throttling and Batches](#throttling-and-batches) + * [Setting Index Throttling](#setting-index-throttling) + * [Server-Wide](#server-wide-index-throttling) + * [Per-Database](#index-throttling-per-database) + * [Per-Index](#index-throttling-in-an-index-definition) ## Why Use Index Throttling? @@ -81,7 +81,7 @@ In special cases, throttled indexes' batches are processed without delay. Enable or disable index throttling for a specific database using the designated database configuration key. Setting this property overrides the -[Server-Wide](../indexes/index-throttling.mdx#server-wide-index-throttling) default. +[Server-Wide](#server-wide-index-throttling) default. * **From Studio**: @@ -107,8 +107,8 @@ Setting this property overrides the ### Index Throttling in an Index Definition -Setting throttling in an index definition overrides [server-wide](../indexes/index-throttling.mdx#server-wide-index-throttling) -and [database](../indexes/index-throttling.mdx#index-throttling-per-database) settings configuration. +Setting throttling in an index definition overrides [server-wide](#server-wide-index-throttling) +and [database](#index-throttling-per-database) settings configuration. * **From Code**: diff --git a/docs/indexes/querying/content/_distinct-csharp.mdx b/docs/indexes/querying/content/_distinct-csharp.mdx index 0836aaa25c..675c8af830 100644 --- a/docs/indexes/querying/content/_distinct-csharp.mdx +++ b/docs/indexes/querying/content/_distinct-csharp.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with Distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with Distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with Distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and alternative approaches](../../../indexes/querying/distinct.mdx#performance-cost-and-alternative-approaches) + * [Sample query with Distinct](#sample-query-with-distinct) + * [Paging with Distinct](#paging-with-distinct) + * [Count with Distinct](#count-with-distinct) + * [Performance cost and alternative approaches](#performance-cost-and-alternative-approaches) ## Sample query with Distinct diff --git a/docs/indexes/querying/content/_distinct-java.mdx b/docs/indexes/querying/content/_distinct-java.mdx index e94fc97813..ee344b2092 100644 --- a/docs/indexes/querying/content/_distinct-java.mdx +++ b/docs/indexes/querying/content/_distinct-java.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and an alternative approach](../../../indexes/querying/distinct.mdx#performance-cost-and-an-alternative-approach) + * [Sample query with distinct](#sample-query-with-distinct) + * [Paging with distinct](#paging-with-distinct) + * [Count with distinct](#count-with-distinct) + * [Performance cost and an alternative approach](#performance-cost-and-an-alternative-approach) ## Sample query with Distinct diff --git a/docs/indexes/querying/content/_distinct-nodejs.mdx b/docs/indexes/querying/content/_distinct-nodejs.mdx index 90dcd69923..edd0e1f1b0 100644 --- a/docs/indexes/querying/content/_distinct-nodejs.mdx +++ b/docs/indexes/querying/content/_distinct-nodejs.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and an alternative approach](../../../indexes/querying/distinct.mdx#performance-cost-and-an-alternative-approach) + * [Sample query with distinct](#sample-query-with-distinct) + * [Paging with distinct](#paging-with-distinct) + * [Count with distinct](#count-with-distinct) + * [Performance cost and an alternative approach](#performance-cost-and-an-alternative-approach) ## Sample query with distinct diff --git a/docs/indexes/querying/content/_exploration-queries-csharp.mdx b/docs/indexes/querying/content/_exploration-queries-csharp.mdx index acc906dd9e..a91c0396fd 100644 --- a/docs/indexes/querying/content/_exploration-queries-csharp.mdx +++ b/docs/indexes/querying/content/_exploration-queries-csharp.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. @@ -28,19 +28,19 @@ import CodeBlock from '@theme/CodeBlock'; * **Limit** the number of records that an exploration query filters. * Use [where](../../../querying/filtering-query-results/filter-query-results.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) diff --git a/docs/indexes/querying/content/_exploration-queries-nodejs.mdx b/docs/indexes/querying/content/_exploration-queries-nodejs.mdx index 98de0bd4e5..d2e5891f17 100644 --- a/docs/indexes/querying/content/_exploration-queries-nodejs.mdx +++ b/docs/indexes/querying/content/_exploration-queries-nodejs.mdx @@ -24,20 +24,20 @@ import CodeBlock from '@theme/CodeBlock'; * **Limit** the number of records that an exploration query filters. * Use [where](../../../querying/filtering-query-results/filter-query-results.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) + * [Syntax](#syntax) ## `filter` @@ -51,7 +51,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../querying/filtering-query-results/filter-query-results.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/docs/indexes/querying/content/_exploration-queries-php.mdx b/docs/indexes/querying/content/_exploration-queries-php.mdx index 6c1c3b3b17..63436f24a3 100644 --- a/docs/indexes/querying/content/_exploration-queries-php.mdx +++ b/docs/indexes/querying/content/_exploration-queries-php.mdx @@ -16,30 +16,30 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. We recommend that you - - * [Limit](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + * [Limit](#limit-the-query-and-prefer--for-recurring-queries) the number of records that an exploration query filters. * Use [where](../../../querying/filtering-query-results/filter-query-results.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) @@ -52,7 +52,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../querying/filtering-query-results/filter-query-results.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/docs/indexes/querying/content/_exploration-queries-python.mdx b/docs/indexes/querying/content/_exploration-queries-python.mdx index e53f7bb9d6..1489409c04 100644 --- a/docs/indexes/querying/content/_exploration-queries-python.mdx +++ b/docs/indexes/querying/content/_exploration-queries-python.mdx @@ -16,30 +16,30 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. We recommend that you - - * [Limit](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + * [Limit](#limit-the-query-and-prefer--for-recurring-queries) the number of records that an exploration query filters. * Use [where](../../../querying/filtering-query-results/filter-query-results.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) @@ -52,7 +52,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../querying/filtering-query-results/filter-query-results.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/docs/indexes/querying/content/_faceted-search-csharp.mdx b/docs/indexes/querying/content/_faceted-search-csharp.mdx index 89fe73faae..25f47739eb 100644 --- a/docs/indexes/querying/content/_faceted-search-csharp.mdx +++ b/docs/indexes/querying/content/_faceted-search-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/docs/indexes/querying/content/_faceted-search-nodejs.mdx b/docs/indexes/querying/content/_faceted-search-nodejs.mdx index ece8bbc9d4..c5b4e2de9d 100644 --- a/docs/indexes/querying/content/_faceted-search-nodejs.mdx +++ b/docs/indexes/querying/content/_faceted-search-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/docs/indexes/querying/content/_faceted-search-php.mdx b/docs/indexes/querying/content/_faceted-search-php.mdx index 2e7f0723b8..780a25b773 100644 --- a/docs/indexes/querying/content/_faceted-search-php.mdx +++ b/docs/indexes/querying/content/_faceted-search-php.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/docs/indexes/querying/content/_faceted-search-python.mdx b/docs/indexes/querying/content/_faceted-search-python.mdx index dd57baf923..fe86eb7505 100644 --- a/docs/indexes/querying/content/_faceted-search-python.mdx +++ b/docs/indexes/querying/content/_faceted-search-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/docs/indexes/querying/content/_highlighting-csharp.mdx b/docs/indexes/querying/content/_highlighting-csharp.mdx index 15085cc628..27f4f5c2a5 100644 --- a/docs/indexes/querying/content/_highlighting-csharp.mdx +++ b/docs/indexes/querying/content/_highlighting-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/docs/indexes/querying/content/_highlighting-nodejs.mdx b/docs/indexes/querying/content/_highlighting-nodejs.mdx index 6d8abe3ba6..3157af960e 100644 --- a/docs/indexes/querying/content/_highlighting-nodejs.mdx +++ b/docs/indexes/querying/content/_highlighting-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/docs/indexes/querying/content/_highlighting-php.mdx b/docs/indexes/querying/content/_highlighting-php.mdx index 2fe7124c18..d86dbd47bd 100644 --- a/docs/indexes/querying/content/_highlighting-php.mdx +++ b/docs/indexes/querying/content/_highlighting-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/docs/indexes/querying/content/_highlighting-python.mdx b/docs/indexes/querying/content/_highlighting-python.mdx index 543a4c0b07..134d5578cd 100644 --- a/docs/indexes/querying/content/_highlighting-python.mdx +++ b/docs/indexes/querying/content/_highlighting-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/docs/indexes/querying/content/_include-explanations-csharp.mdx b/docs/indexes/querying/content/_include-explanations-csharp.mdx index d8d84b9af2..dd06e172b1 100644 --- a/docs/indexes/querying/content/_include-explanations-csharp.mdx +++ b/docs/indexes/querying/content/_include-explanations-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations when querying Map index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-index) - * [Include explanations when querying Map-Reduce index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-reduce-index) - * [Syntax](../../../indexes/querying/include-explanations.mdx#syntax) + * [Include explanations when querying Map index](#include-explanations-when-querying-map-index) + * [Include explanations when querying Map-Reduce index](#include-explanations-when-querying-map-reduce-index) + * [Syntax](#syntax) ## Include explanations when querying Map index diff --git a/docs/indexes/querying/content/_include-explanations-nodejs.mdx b/docs/indexes/querying/content/_include-explanations-nodejs.mdx index b843b7cc79..df30ef33c8 100644 --- a/docs/indexes/querying/content/_include-explanations-nodejs.mdx +++ b/docs/indexes/querying/content/_include-explanations-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations when querying Map index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-index) - * [Include explanations when querying Map-Reduce index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-reduce-index) - * [Syntax](../../../indexes/querying/include-explanations.mdx#syntax) + * [Include explanations when querying Map index](#include-explanations-when-querying-map-index) + * [Include explanations when querying Map-Reduce index](#include-explanations-when-querying-map-reduce-index) + * [Syntax](#syntax) ## Include explanations when querying Map index diff --git a/docs/indexes/querying/content/_intersection-csharp.mdx b/docs/indexes/querying/content/_intersection-csharp.mdx index 0651af1f31..a0a51e7673 100644 --- a/docs/indexes/querying/content/_intersection-csharp.mdx +++ b/docs/indexes/querying/content/_intersection-csharp.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/docs/indexes/querying/content/_intersection-java.mdx b/docs/indexes/querying/content/_intersection-java.mdx index 199fb9551a..f2bfb578c3 100644 --- a/docs/indexes/querying/content/_intersection-java.mdx +++ b/docs/indexes/querying/content/_intersection-java.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/docs/indexes/querying/content/_intersection-nodejs.mdx b/docs/indexes/querying/content/_intersection-nodejs.mdx index 78a9d6f52e..4884310716 100644 --- a/docs/indexes/querying/content/_intersection-nodejs.mdx +++ b/docs/indexes/querying/content/_intersection-nodejs.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/docs/indexes/querying/content/_intersection-php.mdx b/docs/indexes/querying/content/_intersection-php.mdx index 60746172df..2e01c264f2 100644 --- a/docs/indexes/querying/content/_intersection-php.mdx +++ b/docs/indexes/querying/content/_intersection-php.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/docs/indexes/querying/content/_intersection-python.mdx b/docs/indexes/querying/content/_intersection-python.mdx index 331c25bb18..8911d37bfa 100644 --- a/docs/indexes/querying/content/_intersection-python.mdx +++ b/docs/indexes/querying/content/_intersection-python.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/docs/indexes/querying/content/_morelikethis-csharp.mdx b/docs/indexes/querying/content/_morelikethis-csharp.mdx index a92a5c5880..022c7c44a7 100644 --- a/docs/indexes/querying/content/_morelikethis-csharp.mdx +++ b/docs/indexes/querying/content/_morelikethis-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/docs/indexes/querying/content/_morelikethis-java.mdx b/docs/indexes/querying/content/_morelikethis-java.mdx index 6470ebb953..ece0a855c1 100644 --- a/docs/indexes/querying/content/_morelikethis-java.mdx +++ b/docs/indexes/querying/content/_morelikethis-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/docs/indexes/querying/content/_morelikethis-nodejs.mdx b/docs/indexes/querying/content/_morelikethis-nodejs.mdx index dea48c1f54..7dc0a3767e 100644 --- a/docs/indexes/querying/content/_morelikethis-nodejs.mdx +++ b/docs/indexes/querying/content/_morelikethis-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/docs/indexes/querying/content/_morelikethis-php.mdx b/docs/indexes/querying/content/_morelikethis-php.mdx index 7007d3db07..b33c51237a 100644 --- a/docs/indexes/querying/content/_morelikethis-php.mdx +++ b/docs/indexes/querying/content/_morelikethis-php.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/docs/indexes/querying/content/_morelikethis-python.mdx b/docs/indexes/querying/content/_morelikethis-python.mdx index 88b86d0cba..73889e607f 100644 --- a/docs/indexes/querying/content/_morelikethis-python.mdx +++ b/docs/indexes/querying/content/_morelikethis-python.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/docs/indexes/querying/content/_paging-csharp.mdx b/docs/indexes/querying/content/_paging-csharp.mdx index 4b128ad45a..a873782754 100644 --- a/docs/indexes/querying/content/_paging-csharp.mdx +++ b/docs/indexes/querying/content/_paging-csharp.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/docs/indexes/querying/content/_paging-java.mdx b/docs/indexes/querying/content/_paging-java.mdx index d9bc165120..512febbae7 100644 --- a/docs/indexes/querying/content/_paging-java.mdx +++ b/docs/indexes/querying/content/_paging-java.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/docs/indexes/querying/content/_paging-nodejs.mdx b/docs/indexes/querying/content/_paging-nodejs.mdx index 26517ec810..2c0dac0d11 100644 --- a/docs/indexes/querying/content/_paging-nodejs.mdx +++ b/docs/indexes/querying/content/_paging-nodejs.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/docs/indexes/querying/content/_paging-php.mdx b/docs/indexes/querying/content/_paging-php.mdx index 9be23c6086..b3d9ce0390 100644 --- a/docs/indexes/querying/content/_paging-php.mdx +++ b/docs/indexes/querying/content/_paging-php.mdx @@ -24,14 +24,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no-paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no-paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/docs/indexes/querying/content/_paging-python.mdx b/docs/indexes/querying/content/_paging-python.mdx index 9aa0ac531e..e630a5b1f2 100644 --- a/docs/indexes/querying/content/_paging-python.mdx +++ b/docs/indexes/querying/content/_paging-python.mdx @@ -24,14 +24,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/docs/indexes/querying/content/_projections-csharp.mdx b/docs/indexes/querying/content/_projections-csharp.mdx index ccae221f1e..4ce2108f96 100644 --- a/docs/indexes/querying/content/_projections-csharp.mdx +++ b/docs/indexes/querying/content/_projections-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about Projections and for dynamic-queries examples. * In this page: - * [Projection Methods](../../../indexes/querying/projections.mdx#select): - * [Select](../../../indexes/querying/projections.mdx#select) - * [ProjectInto](../../../indexes/querying/projections.mdx#projectinto) - * [SelectFields](../../../indexes/querying/projections.mdx#selectfields) - * [Projection behavior with a static-index](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) - * [OfType](../../../indexes/querying/projections.mdx#oftype) + * [Projection Methods](#select): + * [Select](#select) + * [ProjectInto](#projectinto) + * [SelectFields](#selectfields) + * [Projection behavior with a static-index](#projection-behavior-with-a-static-index) + * [OfType](#oftype) ## Select @@ -109,14 +109,14 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * In the above example, the fields to return by the projection that are specified in the `Select` method (`x.FirstName` & `x.LastName`) are recognized by the compiler as fields of the `IndexEntry` class. - * If you wish to specify fields from the original 'Employee' class type then follow [this example](../../../indexes/querying/projections.mdx#oftype) that uses `OfType`. + * If you wish to specify fields from the original 'Employee' class type then follow [this example](#oftype) that uses `OfType`. * **Source of projection fields**: * Since the index-fields in this example are not [Stored in the index](../../../indexes/storing-data-in-index.mdx), and no projection behavior was defined, resulting values for `FirstName` & `LastName` will be retrieved from the matching Employee document in the storage. - * This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. + * This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. @@ -196,7 +196,7 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * In this example, the projected fields (`FirstName` and `LastName`) are stored in the index, so by default, the resulting values will come directly from the index and Not from the Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. diff --git a/docs/indexes/querying/content/_projections-java.mdx b/docs/indexes/querying/content/_projections-java.mdx index 4642c7bbb6..f9f6420f82 100644 --- a/docs/indexes/querying/content/_projections-java.mdx +++ b/docs/indexes/querying/content/_projections-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; There are couple of ways to perform projections in RavenDB: -- projections using [SelectFields](../../../indexes/querying/projections.mdx#selectfields) -- using [OfType](../../../indexes/querying/projections.mdx#oftype) +- projections using [SelectFields](#selectfields) +- using [OfType](#oftype) ## What are Projections and When to Use Them diff --git a/docs/indexes/querying/content/_projections-nodejs.mdx b/docs/indexes/querying/content/_projections-nodejs.mdx index 23eebdd1ee..7335bf9b8b 100644 --- a/docs/indexes/querying/content/_projections-nodejs.mdx +++ b/docs/indexes/querying/content/_projections-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about Projections and for dynamic-queries examples. * In this page: - * [SelectFields](../../../indexes/querying/projections.mdx#selectfields) - * [Projection behavior with a static-index](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) - * [ofType](../../../indexes/querying/projections.mdx#oftype) + * [SelectFields](#selectfields) + * [Projection behavior with a static-index](#projection-behavior-with-a-static-index) + * [ofType](#oftype) ## SelectFields @@ -77,7 +77,7 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * Since the index-fields in this example are not [Stored in the index](../../../indexes/storing-data-in-index.mdx), and no projection behavior was defined, resulting values for `FirstName` & `LastName` will be retrieved from the matching Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. @@ -131,7 +131,7 @@ select FirstName, LastName * In this example, the projected fields (`FirstName` and `LastName`) are stored in the index, so by default, the resulting values will come directly from the index and not from the Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. diff --git a/docs/indexes/querying/content/_projections-php.mdx b/docs/indexes/querying/content/_projections-php.mdx index 32789feb08..da38f910ec 100644 --- a/docs/indexes/querying/content/_projections-php.mdx +++ b/docs/indexes/querying/content/_projections-php.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are Projections and When to Use Them](../../../indexes/querying/projections.mdx#what-are-projections-and-when-to-use-them) - * [`selectFields`](../../../indexes/querying/projections.mdx#selectfields) - * [Examples](../../../indexes/querying/projections.mdx#examples) - * [Projection Behavior](../../../indexes/querying/projections.mdx#projection-behavior) - * [Projections and the Session](../../../indexes/querying/projections.mdx#projections-and-the-session) + * [What are Projections and When to Use Them](#what-are-projections-and-when-to-use-them) + * [`selectFields`](#selectfields) + * [Examples](#examples) + * [Projection Behavior](#projection-behavior) + * [Projections and the Session](#projections-and-the-session) ## What are Projections and When to Use Them diff --git a/docs/indexes/querying/content/_projections-python.mdx b/docs/indexes/querying/content/_projections-python.mdx index b2b3ba66f2..c39e74720e 100644 --- a/docs/indexes/querying/content/_projections-python.mdx +++ b/docs/indexes/querying/content/_projections-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are Projections and When to Use Them](../../../indexes/querying/projections.mdx#what-are-projections-and-when-to-use-them) - * [`select_fields`](../../../indexes/querying/projections.mdx#select_fields) - * [Examples](../../../indexes/querying/projections.mdx#examples) - * [Projection Behavior](../../../indexes/querying/projections.mdx#projection-behavior) - * [Projections and the Session](../../../indexes/querying/projections.mdx#projections-and-the-session) - * [Syntax](../../../indexes/querying/projections.mdx#syntax) + * [What are Projections and When to Use Them](#what-are-projections-and-when-to-use-them) + * [`select_fields`](#select_fields) + * [Examples](#examples) + * [Projection Behavior](#projection-behavior) + * [Projections and the Session](#projections-and-the-session) + * [Syntax](#syntax) ## What are Projections and When to Use Them diff --git a/docs/indexes/querying/content/_query-index-csharp.mdx b/docs/indexes/querying/content/_query-index-csharp.mdx index f1bb8e2d6a..b3673bfc65 100644 --- a/docs/indexes/querying/content/_query-index-csharp.mdx +++ b/docs/indexes/querying/content/_query-index-csharp.mdx @@ -16,9 +16,9 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../querying/rql/what-is-rql.mdx). * In this page: - * [Query an index by `Query`](../../../indexes/querying/query-index.mdx#query-an-index-by-query) (using LINQ) - * [Query an index by `DocumentQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-documentquery) (low-level API) - * [Query an index by `RawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) (using RQL) + * [Query an index by `Query`](#query-an-index-by-query) (using LINQ) + * [Query an index by `DocumentQuery`](#query-an-index-by-documentquery) (low-level API) + * [Query an index by `RawQuery`](#query-an-index-by-rawquery) (using RQL) ## Query an index by `Query` @@ -462,8 +462,8 @@ where LastName == "King" ## Query an index by `RawQuery` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../querying/rql/what-is-rql.mdx) when sent to the server. diff --git a/docs/indexes/querying/content/_query-index-nodejs.mdx b/docs/indexes/querying/content/_query-index-nodejs.mdx index 6a1b69f333..d05dbeeed5 100644 --- a/docs/indexes/querying/content/_query-index-nodejs.mdx +++ b/docs/indexes/querying/content/_query-index-nodejs.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../querying/rql/what-is-rql.mdx). * In this page: - * [Query an index by `Query`](../../../indexes/querying/query-index.mdx#query-an-index-by-query) (using API) - * [Query an index by `RawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) (using RQL) + * [Query an index by `Query`](#query-an-index-by-query) (using API) + * [Query an index by `RawQuery`](#query-an-index-by-rawquery) (using RQL) ## Query an index by `Query` @@ -273,7 +273,7 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `RawQuery` -* Queries defined with [query](../query-index.mdx#sessionquery) are translated by the RavenDB client to [RQL](../../../querying/rql/what-is-rql.mdx) when sent to the server. +* Queries defined with [query](#sessionquery) are translated by the RavenDB client to [RQL](../../../querying/rql/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. diff --git a/docs/indexes/querying/content/_query-index-php.mdx b/docs/indexes/querying/content/_query-index-php.mdx index b699178f41..0cff7695c5 100644 --- a/docs/indexes/querying/content/_query-index-php.mdx +++ b/docs/indexes/querying/content/_query-index-php.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; * Querying can be enhanced using these [extension methods](../../../querying/overview.mdx#custom-methods). * In this page: - * [Query index - no filtering](../../../indexes/querying/query-index.mdx#query-index---no-filtering) - * [Query index - with filtering](../../../indexes/querying/query-index.mdx#query-index---with-filtering) - * [Query index - with paging](../../../indexes/querying/query-index.mdx#query-index---with-paging) - * [Query an index by `documentQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-documentquery) - * [Query an index by `rawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) + * [Query index - no filtering](#query-index---no-filtering) + * [Query index - with filtering](#query-index---with-filtering) + * [Query index - with paging](#query-index---with-paging) + * [Query an index by `documentQuery`](#query-an-index-by-documentquery) + * [Query an index by `rawQuery`](#query-an-index-by-rawquery) ## Query index - no filtering @@ -442,8 +442,8 @@ where LastName == "King" ## Query an index by `rawQuery` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../querying/rql/what-is-rql.mdx) when sent to the server. diff --git a/docs/indexes/querying/content/_query-index-python.mdx b/docs/indexes/querying/content/_query-index-python.mdx index 3448986786..6c829783c1 100644 --- a/docs/indexes/querying/content/_query-index-python.mdx +++ b/docs/indexes/querying/content/_query-index-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../querying/rql/what-is-rql.mdx). * In this page: - * [Query an index by `query_index_type` and `query_index`](../../../indexes/querying/query-index.mdx#query-an-index-by-query_index_type-and-query_index) - * [Query an index by `raw_query`](../../../indexes/querying/query-index.mdx#query-an-index-by-raw_query) (using RQL) + * [Query an index by `query_index_type` and `query_index`](#query-an-index-by-query_index_type-and-query_index) + * [Query an index by `raw_query`](#query-an-index-by-raw_query) (using RQL) ## Query an index by `query_index_type` and `query_index` @@ -247,8 +247,8 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `raw_query` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../querying/rql/what-is-rql.mdx) when sent to the server. diff --git a/docs/indexes/querying/content/_searching-csharp.mdx b/docs/indexes/querying/content/_searching-csharp.mdx index 4c7985689a..a435b87861 100644 --- a/docs/indexes/querying/content/_searching-csharp.mdx +++ b/docs/indexes/querying/content/_searching-csharp.mdx @@ -19,15 +19,15 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) - * [Searching with wildcards](../../../indexes/querying/searching.mdx#searching-with-wildcards) - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) + * [Searching with wildcards](#searching-with-wildcards) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) @@ -409,9 +409,9 @@ where search(AllValues, "tofu") [analyzer](../../../indexes/using-analyzers.mdx) used in the index. * Note the different behavior in the following cases, as described below: - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) * When using [Corax](../../../indexes/search-engine/corax.mdx) as the search engine, this behavior will only apply to indexes that are newly created or have been reset. diff --git a/docs/indexes/querying/content/_searching-nodejs.mdx b/docs/indexes/querying/content/_searching-nodejs.mdx index aa8dce914e..505d41f098 100644 --- a/docs/indexes/querying/content/_searching-nodejs.mdx +++ b/docs/indexes/querying/content/_searching-nodejs.mdx @@ -20,15 +20,15 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) - * [Searching with wildcards](../../../indexes/querying/searching.mdx#searching-with-wildcards) - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) + * [Searching with wildcards](#searching-with-wildcards) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) @@ -262,9 +262,9 @@ where search(AllValues, "tofu") [analyzer](../../../indexes/using-analyzers.mdx) used in the index. * Note the different behavior in the following cases, as described below: - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) * When using [Corax](../../../indexes/search-engine/corax.mdx) as the search engine, this behavior will only apply to indexes that are newly created or have been reset. diff --git a/docs/indexes/querying/content/_searching-php.mdx b/docs/indexes/querying/content/_searching-php.mdx index 510a6f8752..3409ce29a8 100644 --- a/docs/indexes/querying/content/_searching-php.mdx +++ b/docs/indexes/querying/content/_searching-php.mdx @@ -20,11 +20,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) diff --git a/docs/indexes/querying/content/_searching-python.mdx b/docs/indexes/querying/content/_searching-python.mdx index 88c6aa452f..77adcfe80e 100644 --- a/docs/indexes/querying/content/_searching-python.mdx +++ b/docs/indexes/querying/content/_searching-python.mdx @@ -20,11 +20,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) diff --git a/docs/indexes/querying/content/_spatial-csharp.mdx b/docs/indexes/querying/content/_spatial-csharp.mdx index af1341ff81..9d948500cc 100644 --- a/docs/indexes/querying/content/_spatial-csharp.mdx +++ b/docs/indexes/querying/content/_spatial-csharp.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/docs/indexes/querying/content/_spatial-nodejs.mdx b/docs/indexes/querying/content/_spatial-nodejs.mdx index 066a9fdc5e..cf4a055849 100644 --- a/docs/indexes/querying/content/_spatial-nodejs.mdx +++ b/docs/indexes/querying/content/_spatial-nodejs.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/docs/indexes/querying/content/_spatial-php.mdx b/docs/indexes/querying/content/_spatial-php.mdx index 9a183fb5f4..f01f2bf755 100644 --- a/docs/indexes/querying/content/_spatial-php.mdx +++ b/docs/indexes/querying/content/_spatial-php.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/docs/indexes/querying/content/_spatial-python.mdx b/docs/indexes/querying/content/_spatial-python.mdx index 40b3108c0d..ec83d3c919 100644 --- a/docs/indexes/querying/content/_spatial-python.mdx +++ b/docs/indexes/querying/content/_spatial-python.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/docs/indexes/querying/content/_suggestions-csharp.mdx b/docs/indexes/querying/content/_suggestions-csharp.mdx index 2b0a8bfa50..d482d02803 100644 --- a/docs/indexes/querying/content/_suggestions-csharp.mdx +++ b/docs/indexes/querying/content/_suggestions-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/docs/indexes/querying/content/_suggestions-nodejs.mdx b/docs/indexes/querying/content/_suggestions-nodejs.mdx index ac05e8c401..b0b1f7b335 100644 --- a/docs/indexes/querying/content/_suggestions-nodejs.mdx +++ b/docs/indexes/querying/content/_suggestions-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/docs/indexes/querying/content/_suggestions-php.mdx b/docs/indexes/querying/content/_suggestions-php.mdx index 96373c2477..067caf9f40 100644 --- a/docs/indexes/querying/content/_suggestions-php.mdx +++ b/docs/indexes/querying/content/_suggestions-php.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/docs/indexes/querying/content/_suggestions-python.mdx b/docs/indexes/querying/content/_suggestions-python.mdx index 3943dfab03..36d78c20a9 100644 --- a/docs/indexes/querying/content/_suggestions-python.mdx +++ b/docs/indexes/querying/content/_suggestions-python.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/docs/indexes/rolling-index-deployment.mdx b/docs/indexes/rolling-index-deployment.mdx index 9d163911d6..0c395808b6 100644 --- a/docs/indexes/rolling-index-deployment.mdx +++ b/docs/indexes/rolling-index-deployment.mdx @@ -24,14 +24,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Why Rolling Index Deployment](../indexes/rolling-index-deployment.mdx#why-rolling-index-deployment) - * [How Does It Work](../indexes/rolling-index-deployment.mdx#how-does-it-work) - * [The Rolling Procedure](../indexes/rolling-index-deployment.mdx#the-rolling-procedure) - * [Deployment Concurrency and Order](../indexes/rolling-index-deployment.mdx#deployment-concurrency-and-order) - * [Setting Indexing Deployment Mode](../indexes/rolling-index-deployment.mdx#setting-indexing-deployment-mode) - * [Server-Wide Deployment Mode](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) - * [Database Deployment Mode](../indexes/rolling-index-deployment.mdx#database-deployment-mode) - * [Deployment Mode in an Index Definition](../indexes/rolling-index-deployment.mdx#deployment-mode-in-an-index-definition) + * [Why Rolling Index Deployment](#why-rolling-index-deployment) + * [How Does It Work](#how-does-it-work) + * [The Rolling Procedure](#the-rolling-procedure) + * [Deployment Concurrency and Order](#deployment-concurrency-and-order) + * [Setting Indexing Deployment Mode](#setting-indexing-deployment-mode) + * [Server-Wide Deployment Mode](#server-wide-deployment-mode) + * [Database Deployment Mode](#database-deployment-mode) + * [Deployment Mode in an Index Definition](#deployment-mode-in-an-index-definition) ## Why Rolling Index Deployment @@ -105,7 +105,7 @@ Nodes are assigned with the indexing of each database in a linear order, one nod Enable or disable rolling for a specific database using database configuration keys. Setting these properties overrides the -[Server-Wide](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) default. +[Server-Wide](#server-wide-deployment-mode) default. * From Studio: @@ -133,8 +133,8 @@ Setting these properties overrides the ### Deployment Mode in an Index Definition Enable or disable rolling for a specific index using the index-definition `DeploymentMode` property. -Setting this property overrides [server-wide](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) -and [database](../indexes/rolling-index-deployment.mdx#database-deployment-mode) settings configuration. +Setting this property overrides [server-wide](#server-wide-deployment-mode) +and [database](#database-deployment-mode) settings configuration. * `DeploymentMode = IndexDeploymentMode.Rolling` * `DeploymentMode = IndexDeploymentMode.Parallel` diff --git a/docs/indexes/search-engine/corax.mdx b/docs/indexes/search-engine/corax.mdx index 7c354c5a29..c3d847729d 100644 --- a/docs/indexes/search-engine/corax.mdx +++ b/docs/indexes/search-engine/corax.mdx @@ -36,21 +36,21 @@ import Panel from '@site/src/components/Panel'; * _Community_, _Developer_, and servers without a license default to **Corax**. * All other license types, such as _Professional_ and _Enterprise_, default to **Lucene**. - Explicitly [selecting the search engine](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) overrides this license-based default. + Explicitly [selecting the search engine](#selecting-the-search-engine) overrides this license-based default. --- * In this article: - * [Selecting the search engine](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) - * [Server wide](../../indexes/search-engine/corax.mdx#select-search-engine-server-wide) - * [Per database](../../indexes/search-engine/corax.mdx#select-search-engine-per-database) - * [Per static index](../../indexes/search-engine/corax.mdx#select-search-engine-per-static-index) - * [Unsupported features](../../indexes/search-engine/corax.mdx#unsupported-features) - * [Handling complex JSON objects](../../indexes/search-engine/corax.mdx#handling-complex-json-objects) - * [Compound fields](../../indexes/search-engine/corax.mdx#compound-fields) - * [Limits](../../indexes/search-engine/corax.mdx#limits) - * [Index training: Compression dictionaries](../../indexes/search-engine/corax.mdx#index-training-compression-dictionaries) - * [Configuration options](../../indexes/search-engine/corax.mdx#configuration-options) + * [Selecting the search engine](#selecting-the-search-engine) + * [Server wide](#select-search-engine-server-wide) + * [Per database](#select-search-engine-per-database) + * [Per static index](#select-search-engine-per-static-index) + * [Unsupported features](#unsupported-features) + * [Handling complex JSON objects](#handling-complex-json-objects) + * [Compound fields](#compound-fields) + * [Limits](#limits) + * [Index training: Compression dictionaries](#index-training-compression-dictionaries) + * [Configuration options](#configuration-options) @@ -58,11 +58,11 @@ import Panel from '@site/src/components/Panel'; You can select the search engine at the following scopes: - * [Server-wide](../../indexes/search-engine/corax.mdx#select-search-engine-server-wide), + * [Server-wide](#select-search-engine-server-wide), for all databases hosted by the server. - * [Per database](../../indexes/search-engine/corax.mdx#select-search-engine-per-database), + * [Per database](#select-search-engine-per-database), overriding the server-wide setting for a specific database. - * [Per static index](../../indexes/search-engine/corax.mdx#select-search-engine-per-static-index), + * [Per static index](#select-search-engine-per-static-index), overriding the server-wide and database-level settings for a specific static index. Per-index search engine selection is available only for **static** indexes. @@ -74,7 +74,7 @@ Use these configuration options to select the search engine: * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) Selects either `Lucene` or `Corax` for **static indexes**. This option can be set **server-wide**, **per database**, or **per index**. - * For additional Corax configuration options, see [Configuration options](../../indexes/search-engine/corax.mdx#configuration-options). + * For additional Corax configuration options, see [Configuration options](#configuration-options). --- @@ -241,7 +241,7 @@ The following Corax limitations currently apply. #### Complex JSON properties: Complex JSON properties cannot currently be indexed and searched by Corax. -Read more about this in [Handling complex JSON objects](../../indexes/search-engine/corax.mdx#handling-complex-json-objects) below. +Read more about this in [Handling complex JSON objects](#handling-complex-json-objects) below. #### Unsupported `where` methods: @@ -306,14 +306,14 @@ but `Location` itself is not a simple searchable value. * **Corax** does not support indexing the whole complex JSON object as a single text value, because indexing an entire object as text is usually not useful for search. The exact behavior depends on whether the index is an auto-index or a static index; - see [How Corax handles complex fields while indexing](../../indexes/search-engine/corax.mdx#how-corax-handles-complex-fields-while-indexing) below. + see [How Corax handles complex fields while indexing](#how-corax-handles-complex-fields-while-indexing) below. To work with complex objects, use one of the following approaches: - 1. [Index simple properties from the object](../../indexes/search-engine/corax.mdx#1-index-simple-properties-from-the-object) - 2. [Store the complex field for projection only](../../indexes/search-engine/corax.mdx#2-store-the-complex-field-for-projection-only) - 3. [Serialize the complex object explicitly](../../indexes/search-engine/corax.mdx#3-serialize-the-complex-object-explicitly) - 4. [Use Lucene to index the whole object as JSON text](../../indexes/search-engine/corax.mdx#4-use-lucene-to-index-the-whole-object-as-json-text) + 1. [Index simple properties from the object](#1-index-simple-properties-from-the-object) + 2. [Store the complex field for projection only](#2-store-the-complex-field-for-projection-only) + 3. [Serialize the complex object explicitly](#3-serialize-the-complex-object-explicitly) + 4. [Use Lucene to index the whole object as JSON text](#4-use-lucene-to-index-the-whole-object-as-json-text) --- @@ -690,7 +690,7 @@ The index-fields and their terms are visible in the "Terms view": * Compound fields have additional constraints, including exactly **2 fields** per compound field and a **255-byte limit** per participating field value. - Learn more in [Compound fields: Constraints and value limits](../../indexes/search-engine/corax.mdx#constraints-and-value-limits). + Learn more in [Compound fields: Constraints and value limits](#constraints-and-value-limits). diff --git a/docs/integrations/akka.net-persistence/events-and-snapshots.mdx b/docs/integrations/akka.net-persistence/events-and-snapshots.mdx index f073e94239..9dbcfab19f 100644 --- a/docs/integrations/akka.net-persistence/events-and-snapshots.mdx +++ b/docs/integrations/akka.net-persistence/events-and-snapshots.mdx @@ -30,11 +30,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; see [Integrating with Akka.NET persistence](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx). * In this page: - * [Storing events](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-events) - * [Storing snapshots](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-snapshots) - * [Storing guidelines](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-guidelines) - * [Global consistency](../../integrations/akka.net-persistence/events-and-snapshots.mdx#global-consistency) - * [Sample application](../../integrations/akka.net-persistence/events-and-snapshots.mdx#sample-application) + * [Storing events](#storing-events) + * [Storing snapshots](#storing-snapshots) + * [Storing guidelines](#storing-guidelines) + * [Global consistency](#global-consistency) + * [Sample application](#sample-application) ## Storing events diff --git a/docs/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx b/docs/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx index 27c51282ff..795e7a4278 100644 --- a/docs/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx +++ b/docs/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx @@ -18,13 +18,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This article provides guidance on integrating RavenDB with Akka.Persistence. * In this page: - * [Overview](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#overview) - * [Akka.Persistence.RavenDB](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#akkapersistenceravendb) - * [Installing the RavenDB persistence plugin](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#installing-the-ravendb-persistence-plugin) - * [Configuring the RavenDB persistence plugin with HOCON](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuring-the-ravendb-persistence-plugin-with-hocon) - * [Configuration keys](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuration-keys) - * [Configuring the RavenDB persistence plugin with Hosting](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuring-the-ravendb-persistence-plugin-with-hosting) - * [Syntax](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#syntax) + * [Overview](#overview) + * [Akka.Persistence.RavenDB](#akkapersistenceravendb) + * [Installing the RavenDB persistence plugin](#installing-the-ravendb-persistence-plugin) + * [Configuring the RavenDB persistence plugin with HOCON](#configuring-the-ravendb-persistence-plugin-with-hocon) + * [Configuration keys](#configuration-keys) + * [Configuring the RavenDB persistence plugin with Hosting](#configuring-the-ravendb-persistence-plugin-with-hosting) + * [Syntax](#syntax) ## Overview @@ -119,7 +119,7 @@ the configuration provided via Hosting takes precedence and will override the co Provide different values for each store as needed. * The following is a sample HOCON configuration under the `` section. - See the full description of each configuration key [below](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuration-keys). + See the full description of each configuration key [below](#configuration-keys). @@ -255,7 +255,7 @@ Default: `false` * Using Hosting, you can easily set up the RavenDB plugin during your application's startup. * Use method `WithRavenDbPersistence` to configure all relevant parameters. - See the available parameters and method overloads in the syntax section [below](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#syntax). + See the available parameters and method overloads in the syntax section [below](#syntax). * The following example shows a basic configuration using Hosting: diff --git a/docs/integrations/akka.net-persistence/queries.mdx b/docs/integrations/akka.net-persistence/queries.mdx index 46c08685b5..cd9702e67e 100644 --- a/docs/integrations/akka.net-persistence/queries.mdx +++ b/docs/integrations/akka.net-persistence/queries.mdx @@ -23,13 +23,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; Just include `Akka.Persistence.RavenDb.Query` in your application. * In this page: - * [Interface types](../../integrations/akka.net-persistence/queries.mdx#interface-types) - * [Supported interfaces](../../integrations/akka.net-persistence/queries.mdx#supported-interfaces) - * [IPersistenceIdsQuery & ICurrentPersistenceIdsQuery](../../integrations/akka.net-persistence/queries.mdx#ipersistenceidsquery--icurrentpersistenceidsquery) - * [IEventsByPersistenceIdQuery & ICurrentEventsByPersistenceIdQuery](../../integrations/akka.net-persistence/queries.mdx#ieventsbypersistenceidquery--icurrenteventsbypersistenceidquery) - * [IEventsByTagQuery & ICurrentEventsByTagQuery](../../integrations/akka.net-persistence/queries.mdx#ieventsbytagquery--icurrenteventsbytagquery) - * [IAllEventsQuery & ICurrentAllEventsQuery](../../integrations/akka.net-persistence/queries.mdx#ialleventsquery--icurrentalleventsquery) - * [Inner implementation details](../../integrations/akka.net-persistence/queries.mdx#inner-implementation-details) + * [Interface types](#interface-types) + * [Supported interfaces](#supported-interfaces) + * [IPersistenceIdsQuery & ICurrentPersistenceIdsQuery](#ipersistenceidsquery--icurrentpersistenceidsquery) + * [IEventsByPersistenceIdQuery & ICurrentEventsByPersistenceIdQuery](#ieventsbypersistenceidquery--icurrenteventsbypersistenceidquery) + * [IEventsByTagQuery & ICurrentEventsByTagQuery](#ieventsbytagquery--icurrenteventsbytagquery) + * [IAllEventsQuery & ICurrentAllEventsQuery](#ialleventsquery--icurrentalleventsquery) + * [Inner implementation details](#inner-implementation-details) ## Interface types diff --git a/docs/integrations/postgresql-protocol/overview.mdx b/docs/integrations/postgresql-protocol/overview.mdx index 191752aea2..3ffc17d1fd 100644 --- a/docs/integrations/postgresql-protocol/overview.mdx +++ b/docs/integrations/postgresql-protocol/overview.mdx @@ -28,11 +28,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Enabling PostgreSQL support](../../integrations/postgresql-protocol/overview.mdx#enabling-postgresql-support) - * [License](../../integrations/postgresql-protocol/overview.mdx#license) - * [Settings](../../integrations/postgresql-protocol/overview.mdx#settings) - * [PostgreSQL Port](../../integrations/postgresql-protocol/overview.mdx#postgresql-port) - * [Security](../../integrations/postgresql-protocol/overview.mdx#security) + * [Enabling PostgreSQL support](#enabling-postgresql-support) + * [License](#license) + * [Settings](#settings) + * [PostgreSQL Port](#postgresql-port) + * [Security](#security) ## Enabling PostgreSQL support diff --git a/docs/integrations/postgresql-protocol/power-bi.mdx b/docs/integrations/postgresql-protocol/power-bi.mdx index 2d4b3d4272..6993807b3b 100644 --- a/docs/integrations/postgresql-protocol/power-bi.mdx +++ b/docs/integrations/postgresql-protocol/power-bi.mdx @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; must explicitly enable **Power BI** Support. * In this page: - * [Using RavenDB From Power BI Desktop](../../integrations/postgresql-protocol/power-bi.mdx#using-ravendb-from-power-bi-desktop) - * [Connect to RavenDB](../../integrations/postgresql-protocol/power-bi.mdx#connect-to-ravendb) - * [Retrieve Collections Data](../../integrations/postgresql-protocol/power-bi.mdx#retrieve-collections-data) - * [Query RavenDB Using RQL](../../integrations/postgresql-protocol/power-bi.mdx#query-ravendb-using-rql) + * [Using RavenDB From Power BI Desktop](#using-ravendb-from-power-bi-desktop) + * [Connect to RavenDB](#connect-to-ravendb) + * [Retrieve Collections Data](#retrieve-collections-data) + * [Query RavenDB Using RQL](#query-ravendb-using-rql) ## Using RavenDB From Power BI Desktop diff --git a/docs/integrations/terraform.mdx b/docs/integrations/terraform.mdx index 38c9a2e94c..74beb695c5 100644 --- a/docs/integrations/terraform.mdx +++ b/docs/integrations/terraform.mdx @@ -30,13 +30,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; and concisely and can always be used to review and easily modify it. * In this page: - * [Prerequisites](../integrations/terraform.mdx#prerequisites) - * [Prepare Terraform Configuration](../integrations/terraform.mdx#prepare-terraform-configuration) - * [Provider](../integrations/terraform.mdx#provider) - * [Terraform Local Parameters](../integrations/terraform.mdx#terraform-local-parameters) - * [RavenDB Resource](../integrations/terraform.mdx#ravendb-resource) - * [Terraform Output Values](../integrations/terraform.mdx#terraform-output-values) - * [Apply Terraform Configuration](../integrations/terraform.mdx#apply-terraform-configuration) + * [Prerequisites](#prerequisites) + * [Prepare Terraform Configuration](#prepare-terraform-configuration) + * [Provider](#provider) + * [Terraform Local Parameters](#terraform-local-parameters) + * [RavenDB Resource](#ravendb-resource) + * [Terraform Output Values](#terraform-output-values) + * [Apply Terraform Configuration](#apply-terraform-configuration) ## Prerequisites @@ -46,7 +46,7 @@ To deploy RavenDB using Terraform, you need: * Find [here](https://ravendb.net/buy) what features are supported by each RavenDB license, and acquire the product that suits your needs. * The license you acquire will be provided to RavenDB via the - [Terraform configuration file](../integrations/terraform.mdx#prepare-terraform-configuration) + [Terraform configuration file](#prepare-terraform-configuration) to validate your product and determine which of its features would be enabled. * **Hosts** @@ -59,7 +59,7 @@ To deploy RavenDB using Terraform, you need: * **Terraform Configuration File** * Learn [here](https://www.terraform.io/docs/language/index.html) the basics of Terraform's configuration language. - * Read [below](../integrations/terraform.mdx#prepare-terraform-configuration) + * Read [below](#prepare-terraform-configuration) how to set the configuration file to provision RavenDB. * **Terraform Application** @@ -93,7 +93,7 @@ Use the `provider` object to **set RavenDB as the provider**. Note that the **version number** relates to the RavenDB Terraform Provider version, **not** to the RavenDB Product version (that is -defined in the [resource](../integrations/terraform.mdx#ravendb-resource) +defined in the [resource](#ravendb-resource) block's **package** field). diff --git a/docs/licensing/activate-license.mdx b/docs/licensing/activate-license.mdx index 6913a03ebe..d06ad485aa 100644 --- a/docs/licensing/activate-license.mdx +++ b/docs/licensing/activate-license.mdx @@ -25,8 +25,8 @@ import ContentFrame from "@site/src/components/ContentFrame"; * You can activate your license using configuration keys, or via Studio. * In this article: - * [Activate your license using a configuration key](../licensing/activate-license.mdx#activate-your-license-using-a-configuration-key) - * [Activate your license via Studio](../licensing/activate-license.mdx#activate-your-license-via-studio) + * [Activate your license using a configuration key](#activate-your-license-using-a-configuration-key) + * [Activate your license via Studio](#activate-your-license-via-studio) diff --git a/docs/licensing/configuration.mdx b/docs/licensing/configuration.mdx index 0331ce4921..b4708ffcb3 100644 --- a/docs/licensing/configuration.mdx +++ b/docs/licensing/configuration.mdx @@ -23,16 +23,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Learn how to set these keys in the [configuration overview](../server/configuration/configuration-options.mdx). * On this page: - * [License](../licensing/configuration.mdx#license) - * [License.Path](../licensing/configuration.mdx#licensepath) - * [License.Eula.Accepted](../licensing/configuration.mdx#licenseeulaaccepted) - * [License.CanActivate](../licensing/configuration.mdx#licensecanactivate) - * [License.CanForceUpdate](../licensing/configuration.mdx#licensecanforceupdate) - * [License.CanRenewLicense / License.CanRenew](../licensing/configuration.mdx#licensecanrenewlicense--licensecanrenew) - * [License.SkipLeasingErrorsLogging](../licensing/configuration.mdx#licenseskipleasingerrorslogging) - * [License.DisableAutoUpdate](../licensing/configuration.mdx#licensedisableautoupdate) - * [License.DisableAutoUpdateFromApi](../licensing/configuration.mdx#licensedisableautoupdatefromapi) - * [License.DisableLicenseSupportCheck](../licensing/configuration.mdx#licensedisablelicensesupportcheck) + * [License](#license) + * [License.Path](#licensepath) + * [License.Eula.Accepted](#licenseeulaaccepted) + * [License.CanActivate](#licensecanactivate) + * [License.CanForceUpdate](#licensecanforceupdate) + * [License.CanRenewLicense / License.CanRenew](#licensecanrenewlicense--licensecanrenew) + * [License.SkipLeasingErrorsLogging](#licenseskipleasingerrorslogging) + * [License.DisableAutoUpdate](#licensedisableautoupdate) + * [License.DisableAutoUpdateFromApi](#licensedisableautoupdatefromapi) + * [License.DisableLicenseSupportCheck](#licensedisablelicensesupportcheck) @@ -146,8 +146,8 @@ Disable all license updates: from a string, from a path, and from the License Se EXPERT ONLY. Disable automatic updates of the license from the License Server at `api.ravendb.net`. Can still update the license by either: -* Setting the [License](../licensing/configuration.mdx#license) configuration key -* Setting the [License.Path](../licensing/configuration.mdx#licensepath) configuration key +* Setting the [License](#license) configuration key +* Setting the [License.Path](#licensepath) configuration key * Replacing the _license.json_ file on disk - **Type**: `bool` diff --git a/docs/licensing/faq.mdx b/docs/licensing/faq.mdx index f1d4437909..5d1e1e45cc 100644 --- a/docs/licensing/faq.mdx +++ b/docs/licensing/faq.mdx @@ -18,13 +18,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Below are answers to frequently asked questions about RavenDB licensing. * On this page: - * [RavenDB 5.x license doesn't work with RavenDB 6.x](../licensing/faq.mdx#ravendb-5x-license-doesnt-work-with-ravendb-6x) - * [The license is about to expire, what happens then?](../licensing/faq.mdx#the-license-is-about-to-expire-what-happens-then) - * [Community license enforces an upgrade when opening Studio](../licensing/faq.mdx#community-license-enforces-an-upgrade-when-opening-studio) - * [Trying to activate a license generates LicenseExpiredException](../licensing/faq.mdx#trying-to-activate-a-license-generates-licenseexpiredexception) - * [Validating a license on an RHEL 9 machine fails with InvalidDataException](../licensing/faq.mdx#validating-a-license-on-an-rhel-9-machine-fails-with-invaliddataexception) - * [ISV license cannot be upgraded via online tool](../licensing/faq.mdx#isv-license-cannot-be-upgraded-via-online-tool) - * [Developer license fails activation when using a long-period certificate](../licensing/faq.mdx#developer-license-fails-activation-when-using-a-long-period-certificate) + * [RavenDB 5.x license doesn't work with RavenDB 6.x](#ravendb-5x-license-doesnt-work-with-ravendb-6x) + * [The license is about to expire, what happens then?](#the-license-is-about-to-expire-what-happens-then) + * [Community license enforces an upgrade when opening Studio](#community-license-enforces-an-upgrade-when-opening-studio) + * [Trying to activate a license generates LicenseExpiredException](#trying-to-activate-a-license-generates-licenseexpiredexception) + * [Validating a license on an RHEL 9 machine fails with InvalidDataException](#validating-a-license-on-an-rhel-9-machine-fails-with-invaliddataexception) + * [ISV license cannot be upgraded via online tool](#isv-license-cannot-be-upgraded-via-online-tool) + * [Developer license fails activation when using a long-period certificate](#developer-license-fails-activation-when-using-a-long-period-certificate) diff --git a/docs/licensing/force-update.mdx b/docs/licensing/force-update.mdx index f6291e693d..f9ac33e321 100644 --- a/docs/licensing/force-update.mdx +++ b/docs/licensing/force-update.mdx @@ -29,7 +29,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; This option, too, is only available if there is an active connection to the License server. * In this article: - * [Force license update from Studio](../licensing/force-update.mdx#force-license-update-from-studio) + * [Force license update from Studio](#force-license-update-from-studio) diff --git a/docs/licensing/license-under-docker.mdx b/docs/licensing/license-under-docker.mdx index 3e01ed3e1f..b9f27395df 100644 --- a/docs/licensing/license-under-docker.mdx +++ b/docs/licensing/license-under-docker.mdx @@ -25,12 +25,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; * A `RAVEN_License` environment variable can be set. * In this article: - * [Prerequisites](../licensing/license-under-docker.mdx#prerequisites) - * [Licensing a RavenDB docker image](../licensing/license-under-docker.mdx#licensing-a-ravendb-docker-image) - * [Passing a Path to the License File via CLI](../licensing/license-under-docker.mdx#passing-a-path-to-the-license-file-via-cli) - * [Passing a License via `settings.json`](../licensing/license-under-docker.mdx#passing-a-license-via-settingsjson) - * [Setting a `RAVEN_License` Environment Variable](../licensing/license-under-docker.mdx#setting-a-raven_license-environment-variable) - * [Licensing RavenDB under Linux](../licensing/license-under-docker.mdx#licensing-ravendb-under-linux) + * [Prerequisites](#prerequisites) + * [Licensing a RavenDB docker image](#licensing-a-ravendb-docker-image) + * [Passing a Path to the License File via CLI](#passing-a-path-to-the-license-file-via-cli) + * [Passing a License via `settings.json`](#passing-a-license-via-settingsjson) + * [Setting a `RAVEN_License` Environment Variable](#setting-a-raven_license-environment-variable) + * [Licensing RavenDB under Linux](#licensing-ravendb-under-linux) @@ -85,7 +85,7 @@ To verify that the server is licensed, run it as shown above, create a new datab Provide the license as a property of the `settings.json` configuration file in one of the following ways. * Add the **full license text** to `settings.json` as the value of the "License" key, [as explained here](../licensing/configuration.mdx). - Mount `settings.json` as [explained above](../licensing/license-under-docker.mdx#passing-a-path-to-the-license-file-via-cli), using the location of `settings.json` instead of the location of a license file. + Mount `settings.json` as [explained above](#passing-a-path-to-the-license-file-via-cli), using the location of `settings.json` instead of the location of a license file. * **Or**, add the **license path** to `settings.json` as the value of the “License.Path” key and mount the license directory. diff --git a/docs/licensing/overview.mdx b/docs/licensing/overview.mdx index cfcd8a1a4d..0afdfda8ca 100644 --- a/docs/licensing/overview.mdx +++ b/docs/licensing/overview.mdx @@ -31,17 +31,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; To renew your license, see [renew license](../licensing/renew-license.mdx). * In this article: - * [License types](../licensing/overview.mdx#license-types) - * [Developer license](../licensing/overview.mdx#developer-license) - * [Community license](../licensing/overview.mdx#community-license) - * [Professional license](../licensing/overview.mdx#professional-license) - * [Enterprise license](../licensing/overview.mdx#enterprise-license) - * [RavenDB AI license](../licensing/overview.mdx#ravendb-ai-license) - * [ISV licenses](../licensing/overview.mdx#isv-licenses) - * [ISV Bank-of-Cores license](../licensing/overview.mdx#isv-bank-of-cores-license) - * [Licensing an Embedded server](../licensing/overview.mdx#licensing-an-embedded-server) - * [TestDriver server license](../licensing/overview.mdx#testdriver-server-license) - * [Studio license management](../licensing/overview.mdx#studio-license-management) + * [License types](#license-types) + * [Developer license](#developer-license) + * [Community license](#community-license) + * [Professional license](#professional-license) + * [Enterprise license](#enterprise-license) + * [RavenDB AI license](#ravendb-ai-license) + * [ISV licenses](#isv-licenses) + * [ISV Bank-of-Cores license](#isv-bank-of-cores-license) + * [Licensing an Embedded server](#licensing-an-embedded-server) + * [TestDriver server license](#testdriver-server-license) + * [Studio license management](#studio-license-management) diff --git a/docs/licensing/renew-license.mdx b/docs/licensing/renew-license.mdx index 35c02beccd..368f352da6 100644 --- a/docs/licensing/renew-license.mdx +++ b/docs/licensing/renew-license.mdx @@ -26,10 +26,10 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Non-commercial licenses (Developer and Community) can be renewed via Studio. * In this article: - * [Renew commercial licenses](../licensing/renew-license.mdx#renew-commercial-licenses) - * [Automatic renewal](../licensing/renew-license.mdx#automatic-renewal) - * [Manual renewal](../licensing/renew-license.mdx#manual-renewal) - * [Renew Developer & Community licenses](../licensing/renew-license.mdx#renew-developer-community-licenses) + * [Renew commercial licenses](#renew-commercial-licenses) + * [Automatic renewal](#automatic-renewal) + * [Manual renewal](#manual-renewal) + * [Renew Developer & Community licenses](#renew-developer-community-licenses) diff --git a/docs/licensing/replace-license.mdx b/docs/licensing/replace-license.mdx index 1224a3170c..ccec60bdde 100644 --- a/docs/licensing/replace-license.mdx +++ b/docs/licensing/replace-license.mdx @@ -23,12 +23,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; * A new license will be sent to the email address you provided [while obtaining it](https://ravendb.net/buy). * To upgrade RavenDB from a version older than `6.x` to version `6.x` and above, you must upgrade your current license before applying it to your new RavenDB. - Learn [below](../licensing/replace-license.mdx#upgrade-a-license-older-than-6-x) how to do this. + Learn [below](#upgrade-a-license-older-than-6-x) how to do this. * In this article: - * [Replace your license using a configuration key](../licensing/replace-license.mdx#replace-your-license-using-a-configuration-key) - * [Replace your license via Studio](../licensing/replace-license.mdx#replace-your-license-via-studio) - * [Upgrade a license older than 6.x](../licensing/replace-license.mdx#upgrade-a-license-older-than-6-x) + * [Replace your license using a configuration key](#replace-your-license-using-a-configuration-key) + * [Replace your license via Studio](#replace-your-license-via-studio) + * [Upgrade a license older than 6.x](#upgrade-a-license-older-than-6-x) @@ -71,7 +71,7 @@ You can upgrade your license in a few seconds using our online [License upgrade ![Replace license tool](./assets/replace-license_replace-license-tool.png) A new license will be sent to the email address you registered your current license with. -[Replace](../licensing/replace-license.mdx#replace-your-license-via-studio) your current license with the new one. +[Replace](#replace-your-license-via-studio) your current license with the new one. diff --git a/docs/migration/client-api/client-migration.mdx b/docs/migration/client-api/client-migration.mdx index ded37b1a97..2bfc4a207a 100644 --- a/docs/migration/client-api/client-migration.mdx +++ b/docs/migration/client-api/client-migration.mdx @@ -16,7 +16,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: - * [Client migration to RavenDB `7.x`](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7x) + * [Client migration to RavenDB `7.x`](#client-migration-to-ravendb-7x) ## Client migration to RavenDB 7.x diff --git a/docs/migration/client-api/previous-versions-client-breaking-changes.mdx b/docs/migration/client-api/previous-versions-client-breaking-changes.mdx index 7b3b533f17..b4a8632982 100644 --- a/docs/migration/client-api/previous-versions-client-breaking-changes.mdx +++ b/docs/migration/client-api/previous-versions-client-breaking-changes.mdx @@ -19,24 +19,24 @@ This page lists client breaking changes introduced in RavenDB versions earlier t Each breaking change indicates a behavior change or a function that is no longer available in the specified version. * In this article: - * [RavenDB 7.0 client breaking changes](../../migration/client-api/previous-versions-client-breaking-changes.mdx#ravendb-7-0-client-breaking-changes) - * [Subscription creation overload modification](../../migration/client-api/previous-versions-client-breaking-changes.mdx#subscription-creation-overload-modification) - * [HTTP-Compression algorithm is now `Zstd` by default](../../migration/client-api/previous-versions-client-breaking-changes.mdx#http-compression-algorithm-is-now-zstd-by-default) - * [Bulk-insert Compression is now Enabled by default](../../migration/client-api/previous-versions-client-breaking-changes.mdx#bulk-insert-compression-is-now-enabled-by-default) - * [Removed irrelevant `SingleNodeBatchCommand` parameters](../../migration/client-api/previous-versions-client-breaking-changes.mdx#removed-irrelevant-singlenodebatchcommand-parameters) - * [Removed obsolete methods](../../migration/client-api/previous-versions-client-breaking-changes.mdx#removed-obsolete-methods) - * [`FromEtl` is now internal](../../migration/client-api/previous-versions-client-breaking-changes.mdx#frometl-is-now-internal) - * [RavenDB 6.2 client breaking changes](../../migration/client-api/previous-versions-client-breaking-changes.mdx#ravendb-6-2-client-breaking-changes) - * [`CounterBatchOperation` default increment Delta is 1](../../migration/client-api/previous-versions-client-breaking-changes.mdx#counterbatchoperation-default-increment-delta-is-1) - * [CmpXchg item can only be created with an index of 0](../../migration/client-api/previous-versions-client-breaking-changes.mdx#cmpxchg-item-can-only-be-created-with-an-index-of-0) - * [Dynamic Linq query cannot apply `.Any` with logical AND (`&&`)](../../migration/client-api/previous-versions-client-breaking-changes.mdx#dynamic-linq-query-cannot-apply-any-with-logical-and-) - * [`LoadDocument` must be provided with a collection name String](../../migration/client-api/previous-versions-client-breaking-changes.mdx#loaddocument-must-be-provided-with-a-collection-name-string) - * [Tracking operations using the Changes API now requires Node Tag](../../migration/client-api/previous-versions-client-breaking-changes.mdx#tracking-operations-using-the-changes-api-now-requires-node-tag) - * [Consistency in `null` handling](../../migration/client-api/previous-versions-client-breaking-changes.mdx#consistency-in-null-handling) - * [RavenDB 6.0 client breaking changes](../../migration/client-api/previous-versions-client-breaking-changes.mdx#ravendb-6-0-client-breaking-changes) - * [6.0 Breaking changes](../../migration/client-api/previous-versions-client-breaking-changes.mdx#60-breaking-changes) - * [6.0 Breaking changes in a sharded database](../../migration/client-api/previous-versions-client-breaking-changes.mdx#60-breaking-changes-in-a-sharded-database) - * [Additional 6.0 breaking changes](../../migration/client-api/previous-versions-client-breaking-changes.mdx#additional-60-breaking-changes) + * [RavenDB 7.0 client breaking changes](#ravendb-7-0-client-breaking-changes) + * [Subscription creation overload modification](#subscription-creation-overload-modification) + * [HTTP-Compression algorithm is now `Zstd` by default](#http-compression-algorithm-is-now-zstd-by-default) + * [Bulk-insert Compression is now Enabled by default](#bulk-insert-compression-is-now-enabled-by-default) + * [Removed irrelevant `SingleNodeBatchCommand` parameters](#removed-irrelevant-singlenodebatchcommand-parameters) + * [Removed obsolete methods](#removed-obsolete-methods) + * [`FromEtl` is now internal](#frometl-is-now-internal) + * [RavenDB 6.2 client breaking changes](#ravendb-6-2-client-breaking-changes) + * [`CounterBatchOperation` default increment Delta is 1](#counterbatchoperation-default-increment-delta-is-1) + * [CmpXchg item can only be created with an index of 0](#cmpxchg-item-can-only-be-created-with-an-index-of-0) + * [Dynamic Linq query cannot apply `.Any` with logical AND (`&&`)](#dynamic-linq-query-cannot-apply-any-with-logical-and-) + * [`LoadDocument` must be provided with a collection name String](#loaddocument-must-be-provided-with-a-collection-name-string) + * [Tracking operations using the Changes API now requires Node Tag](#tracking-operations-using-the-changes-api-now-requires-node-tag) + * [Consistency in `null` handling](#consistency-in-null-handling) + * [RavenDB 6.0 client breaking changes](#ravendb-6-0-client-breaking-changes) + * [6.0 Breaking changes](#60-breaking-changes) + * [6.0 Breaking changes in a sharded database](#60-breaking-changes-in-a-sharded-database) + * [Additional 6.0 breaking changes](#additional-60-breaking-changes) diff --git a/docs/migration/server/data-migration.mdx b/docs/migration/server/data-migration.mdx index 5900f184a7..105e7e40bc 100644 --- a/docs/migration/server/data-migration.mdx +++ b/docs/migration/server/data-migration.mdx @@ -24,10 +24,10 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Find a migration guide for RavenDB `5.x` and earlier versions [here](../../migration/server/legacy-versions-data-migration.mdx). * In this article: - * [Migration to RavenDB 7.x from a lower version](../../migration/server/data-migration.mdx#migration-to-ravendb-7-x-from-a-lower-version) - * [Migration and NLog](../../migration/server/data-migration.mdx#migration-and-nlog) - * [Migration and HTTP compression](../../migration/server/data-migration.mdx#migration-and-http-compression) - * [Migrating data into a sharded database](../../migration/server/data-migration.mdx#migrating-data-into-a-sharded-database) + * [Migration to RavenDB 7.x from a lower version](#migration-to-ravendb-7-x-from-a-lower-version) + * [Migration and NLog](#migration-and-nlog) + * [Migration and HTTP compression](#migration-and-http-compression) + * [Migrating data into a sharded database](#migrating-data-into-a-sharded-database) diff --git a/docs/migration/server/docker.mdx b/docs/migration/server/docker.mdx index e857630011..ee8e348052 100644 --- a/docs/migration/server/docker.mdx +++ b/docs/migration/server/docker.mdx @@ -24,11 +24,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Read [here](../../start/containers/image-usage.mdx) more about running a RavenDB Docker image. * In this article: - * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-6-0-and-up) - * [Migrating To RavenDB `6.0` And Up](../../migration/server/docker.mdx#migrating-to-ravendb-6-0-and-up) - * [Permit the `ravendb` user to access the mounted data directory](../../migration/server/docker.mdx#permit-the-ravendb-user-to-access-the-mounted-data-directory) - * [Customize the UID/GID of the RavenDB data directory owner](../../migration/server/docker.mdx#customize-the-uidgid-of-the-ravendb-data-directory-owner) - * [Migrate files and data](../../migration/server/docker.mdx#migrate-files-and-data) + * [Changes Made In RavenDB `6.0` And Up](#changes-made-in-ravendb-6-0-and-up) + * [Migrating To RavenDB `6.0` And Up](#migrating-to-ravendb-6-0-and-up) + * [Permit the `ravendb` user to access the mounted data directory](#permit-the-ravendb-user-to-access-the-mounted-data-directory) + * [Customize the UID/GID of the RavenDB data directory owner](#customize-the-uidgid-of-the-ravendb-data-directory-owner) + * [Migrate files and data](#migrate-files-and-data) diff --git a/docs/migration/server/legacy-versions-data-migration.mdx b/docs/migration/server/legacy-versions-data-migration.mdx index 7058145c32..40e19efaad 100644 --- a/docs/migration/server/legacy-versions-data-migration.mdx +++ b/docs/migration/server/legacy-versions-data-migration.mdx @@ -22,10 +22,10 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Find a migration guide for RavenDB `6.x` and above [here](../../migration/server/data-migration.mdx). * In this article: - * [Migration from RavenDB 5.x to a higher version](../../migration/server/legacy-versions-data-migration.mdx#migration-from-ravendb-5-x-to-a-higher-version) - * [Migration from RavenDB 4.x to a higher version](../../migration/server/legacy-versions-data-migration.mdx#migration-from-ravendb-4-x-to-a-higher-version) - * [Migration from RavenDB 3.x to a higher version](../../migration/server/legacy-versions-data-migration.mdx#migration-from-ravendb-3-x-to-a-higher-version) - * [Migrating data into a sharded database](../../migration/server/legacy-versions-data-migration.mdx#migrating-data-into-a-sharded-database) + * [Migration from RavenDB 5.x to a higher version](#migration-from-ravendb-5-x-to-a-higher-version) + * [Migration from RavenDB 4.x to a higher version](#migration-from-ravendb-4-x-to-a-higher-version) + * [Migration from RavenDB 3.x to a higher version](#migration-from-ravendb-3-x-to-a-higher-version) + * [Migrating data into a sharded database](#migrating-data-into-a-sharded-database) diff --git a/docs/migration/server/previous-versions-server-breaking-changes.mdx b/docs/migration/server/previous-versions-server-breaking-changes.mdx index 2d3d750e44..d1eff6a088 100644 --- a/docs/migration/server/previous-versions-server-breaking-changes.mdx +++ b/docs/migration/server/previous-versions-server-breaking-changes.mdx @@ -22,21 +22,21 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Find RavenDB `7.2` breaking changes [here](../../migration/server/server-breaking-changes.mdx). * In this article: - * [RavenDB 7.0 breaking changes](../../migration/server/previous-versions-server-breaking-changes.mdx#ravendb-7-0-breaking-changes) - * [RavenDB incorporates NLog as its logging system](../../migration/server/previous-versions-server-breaking-changes.mdx#ravendb-incorporates-nlog-as-its-logging-system) - * [Removed obsolete properties](../../migration/server/previous-versions-server-breaking-changes.mdx#removed-obsolete-properties) - * [RavenDB 6.2 breaking changes](../../migration/server/previous-versions-server-breaking-changes.mdx#ravendb-6-2-breaking-changes) - * [MSSQL connection string requires an Encrypt property](../../migration/server/previous-versions-server-breaking-changes.mdx#mssql-connection-string-requires-an-encrypt-property) - * [Corax handling of complex JSON objects in static indexes is configurable](../../migration/server/previous-versions-server-breaking-changes.mdx#corax-handling-of-complex-json-objects-in-static-indexes-is-configurable) - * [Customizable identifier parts separator](../../migration/server/previous-versions-server-breaking-changes.mdx#customizable-identifier-parts-separator) - * [RavenDB 6.0 breaking changes](../../migration/server/previous-versions-server-breaking-changes.mdx#ravendb-6-0-breaking-changes) - * [License keys](../../migration/server/previous-versions-server-breaking-changes.mdx#license-keys) - * [RavenDB for Docker](../../migration/server/previous-versions-server-breaking-changes.mdx#ravendb-for-docker) - * [Unsupported sharding features](../../migration/server/previous-versions-server-breaking-changes.mdx#unsupported-sharding-features) - * [Graph queries](../../migration/server/previous-versions-server-breaking-changes.mdx#graph-queries) - * [SQL ETL](../../migration/server/previous-versions-server-breaking-changes.mdx#sql-etl) - * [DateOnly & TimeOnly](../../migration/server/previous-versions-server-breaking-changes.mdx#dateonly--timeonly) - * [Full-text search with wildcards](../../migration/server/previous-versions-server-breaking-changes.mdx#full-text-search-with-wildcards) + * [RavenDB 7.0 breaking changes](#ravendb-7-0-breaking-changes) + * [RavenDB incorporates NLog as its logging system](#ravendb-incorporates-nlog-as-its-logging-system) + * [Removed obsolete properties](#removed-obsolete-properties) + * [RavenDB 6.2 breaking changes](#ravendb-6-2-breaking-changes) + * [MSSQL connection string requires an Encrypt property](#mssql-connection-string-requires-an-encrypt-property) + * [Corax handling of complex JSON objects in static indexes is configurable](#corax-handling-of-complex-json-objects-in-static-indexes-is-configurable) + * [Customizable identifier parts separator](#customizable-identifier-parts-separator) + * [RavenDB 6.0 breaking changes](#ravendb-6-0-breaking-changes) + * [License keys](#license-keys) + * [RavenDB for Docker](#ravendb-for-docker) + * [Unsupported sharding features](#unsupported-sharding-features) + * [Graph queries](#graph-queries) + * [SQL ETL](#sql-etl) + * [DateOnly & TimeOnly](#dateonly--timeonly) + * [Full-text search with wildcards](#full-text-search-with-wildcards) diff --git a/docs/migration/server/server-breaking-changes.mdx b/docs/migration/server/server-breaking-changes.mdx index b0f03a5781..63d6be770f 100644 --- a/docs/migration/server/server-breaking-changes.mdx +++ b/docs/migration/server/server-breaking-changes.mdx @@ -19,7 +19,7 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [Elasticsearch .NET client library version change](../../migration/server/server-breaking-changes.mdx#elasticsearch-net-client-library-version-change) + * [Elasticsearch .NET client library version change](#elasticsearch-net-client-library-version-change) diff --git a/docs/monitoring/task-errors/configuration.mdx b/docs/monitoring/task-errors/configuration.mdx index cb2e5083c1..a5f458ef87 100644 --- a/docs/monitoring/task-errors/configuration.mdx +++ b/docs/monitoring/task-errors/configuration.mdx @@ -27,11 +27,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Task errors overview](../../monitoring/task-errors/overview.mdx). * In this article: - * [Task health thresholds](../../monitoring/task-errors/configuration.mdx#task-health-thresholds) - * [ETL.ProcessHealthStatusImpairedThreshold](../../monitoring/task-errors/configuration.mdx#etlprocesshealthstatusimpairedthreshold) - * [ETL.ProcessHealthStatusFailedThreshold](../../monitoring/task-errors/configuration.mdx#etlprocesshealthstatusfailedthreshold) - * [Tuning the thresholds](../../monitoring/task-errors/configuration.mdx#tuning-the-thresholds) - * [Validation rules](../../monitoring/task-errors/configuration.mdx#validation-rules) + * [Task health thresholds](#task-health-thresholds) + * [ETL.ProcessHealthStatusImpairedThreshold](#etlprocesshealthstatusimpairedthreshold) + * [ETL.ProcessHealthStatusFailedThreshold](#etlprocesshealthstatusfailedthreshold) + * [Tuning the thresholds](#tuning-the-thresholds) + * [Validation rules](#validation-rules) diff --git a/docs/monitoring/task-errors/overview.mdx b/docs/monitoring/task-errors/overview.mdx index 791d7deb8a..03c0d7e61e 100644 --- a/docs/monitoring/task-errors/overview.mdx +++ b/docs/monitoring/task-errors/overview.mdx @@ -39,14 +39,14 @@ import ContentFrame from "@site/src/components/ContentFrame"; and [monitoring endpoints](../../server/administration/monitoring/telegraf.mdx#monitoring-endpoints). * In this article: - * [What task errors are](../../monitoring/task-errors/overview.mdx#what-task-errors-are) - * [Error types](../../monitoring/task-errors/overview.mdx#error-types) - * [Error steps](../../monitoring/task-errors/overview.mdx#error-steps) - * [Where task errors are stored](../../monitoring/task-errors/overview.mdx#where-task-errors-are-stored) - * [Task health](../../monitoring/task-errors/overview.mdx#task-health) - * [Health states](../../monitoring/task-errors/overview.mdx#health-states) - * [How health is computed](../../monitoring/task-errors/overview.mdx#how-health-is-computed) - * [Where to view and manage task errors](../../monitoring/task-errors/overview.mdx#where-to-view-and-manage-task-errors) + * [What task errors are](#what-task-errors-are) + * [Error types](#error-types) + * [Error steps](#error-steps) + * [Where task errors are stored](#where-task-errors-are-stored) + * [Task health](#task-health) + * [Health states](#health-states) + * [How health is computed](#how-health-is-computed) + * [Where to view and manage task errors](#where-to-view-and-manage-task-errors) @@ -142,7 +142,7 @@ type. Each ETL and AI task carries a health state that summarizes how well it has been processing recent batches. The health state is exposed everywhere task errors are -(see [Where to view and manage task errors](../../monitoring/task-errors/overview.mdx#where-to-view-and-manage-task-errors)) +(see [Where to view and manage task errors](#where-to-view-and-manage-task-errors)) and is used by automated monitoring to decide when a task needs attention. diff --git a/docs/monitoring/task-errors/studio-views.mdx b/docs/monitoring/task-errors/studio-views.mdx index f235b2c219..e333e313ec 100644 --- a/docs/monitoring/task-errors/studio-views.mdx +++ b/docs/monitoring/task-errors/studio-views.mdx @@ -38,15 +38,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Overview](../../monitoring/task-errors/overview.mdx) page. * In this article: - * [Task Errors view](../../monitoring/task-errors/studio-views.mdx#task-errors-view) - * [Opening the view](../../monitoring/task-errors/studio-views.mdx#opening-the-view) - * [Task filters](../../monitoring/task-errors/studio-views.mdx#task-filters) - * [Task health indicators](../../monitoring/task-errors/studio-views.mdx#task-health-indicators) - * [Task errors](../../monitoring/task-errors/studio-views.mdx#task-errors) - * [AI Task Errors view](../../monitoring/task-errors/studio-views.mdx#ai-task-errors-view) - * [Task health on the Ongoing Tasks view](../../monitoring/task-errors/studio-views.mdx#task-health-on-the-ongoing-tasks-view) - * [Collapsed view](../../monitoring/task-errors/studio-views.mdx#collapsed-view) - * [Expanded view](../../monitoring/task-errors/studio-views.mdx#expanded-view) + * [Task Errors view](#task-errors-view) + * [Opening the view](#opening-the-view) + * [Task filters](#task-filters) + * [Task health indicators](#task-health-indicators) + * [Task errors](#task-errors) + * [AI Task Errors view](#ai-task-errors-view) + * [Task health on the Ongoing Tasks view](#task-health-on-the-ongoing-tasks-view) + * [Collapsed view](#collapsed-view) + * [Expanded view](#expanded-view) @@ -68,13 +68,13 @@ showing a segment for every ETL or AI task that currently has any errors. * **B.** Click to open the Task Errors view. -* **C.** [Task filters](../../monitoring/task-errors/studio-views.mdx#task-filters) (see below). +* **C.** [Task filters](#task-filters) (see below). -* **D.** [Task health indicators](../../monitoring/task-errors/studio-views.mdx#task-health-indicators) (see below). +* **D.** [Task health indicators](#task-health-indicators) (see below). * **E.** Toggle to **group errors by task** or display them in a unified list. -* **F.** [Task errors](../../monitoring/task-errors/studio-views.mdx#task-errors) (see below). +* **F.** [Task errors](#task-errors) (see below). @@ -207,7 +207,7 @@ with the same layout, controls, and data, but applies a predefined filter to sho `Embeddings Generation` and `GenAI` task errors. All options documented under -[Task Errors view](../../monitoring/task-errors/studio-views.mdx#task-errors-view) +[Task Errors view](#task-errors-view) above apply here without change. ![AI Task Errors view](./assets/task-errors_ai-task-errors-view.png) diff --git a/docs/monitoring/tombstones/configuration.mdx b/docs/monitoring/tombstones/configuration.mdx index f54a3d0f4b..d89176aa52 100644 --- a/docs/monitoring/tombstones/configuration.mdx +++ b/docs/monitoring/tombstones/configuration.mdx @@ -21,11 +21,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Tombstones overview](../../monitoring/tombstones/overview.mdx). * In this article: - * [Tombstone cleanup settings](../../monitoring/tombstones/configuration.mdx#tombstone-cleanup-settings) - * [Tombstones.CleanupIntervalInMin](../../monitoring/tombstones/configuration.mdx#tombstonescleanupintervalinmin) - * [Pull replication hub keys](../../monitoring/tombstones/configuration.mdx#pull-replication-hub-keys) - * [Tombstones.RetentionTimeWithReplicationHubInHrs](../../monitoring/tombstones/configuration.mdx#tombstonesretentiontimewithreplicationhubinhrs) - * [Tombstones.CleanupIntervalWithReplicationHubInMin](../../monitoring/tombstones/configuration.mdx#tombstonescleanupintervalwithreplicationhubinmin) + * [Tombstone cleanup settings](#tombstone-cleanup-settings) + * [Tombstones.CleanupIntervalInMin](#tombstonescleanupintervalinmin) + * [Pull replication hub keys](#pull-replication-hub-keys) + * [Tombstones.RetentionTimeWithReplicationHubInHrs](#tombstonesretentiontimewithreplicationhubinhrs) + * [Tombstones.CleanupIntervalWithReplicationHubInMin](#tombstonescleanupintervalwithreplicationhubinmin) diff --git a/docs/monitoring/tombstones/overview.mdx b/docs/monitoring/tombstones/overview.mdx index 0fe8b633c6..7f48399bda 100644 --- a/docs/monitoring/tombstones/overview.mdx +++ b/docs/monitoring/tombstones/overview.mdx @@ -21,12 +21,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; RavenDB also keeps [compare-exchange tombstones](../../compare-exchange/delete-cmpxchg-items.mdx) for deleted compare-exchange items; these are cleaned up separately and are not covered here. * In this article: - * [Why tombstones](../../monitoring/tombstones/overview.mdx#why-tombstones) - * [Where are tombstones used?](../../monitoring/tombstones/overview.mdx#where-are-tombstones-used) - * [Tombstone cleanup](../../monitoring/tombstones/overview.mdx#tombstone-cleanup) - * [Why cleanup](../../monitoring/tombstones/overview.mdx#why-cleanup) - * [When is a tombstone removed](../../monitoring/tombstones/overview.mdx#when-is-a-tombstone-removed) - * [What blocks cleanup](../../monitoring/tombstones/overview.mdx#what-blocks-cleanup) + * [Why tombstones](#why-tombstones) + * [Where are tombstones used?](#where-are-tombstones-used) + * [Tombstone cleanup](#tombstone-cleanup) + * [Why cleanup](#why-cleanup) + * [When is a tombstone removed](#when-is-a-tombstone-removed) + * [What blocks cleanup](#what-blocks-cleanup) diff --git a/docs/monitoring/tombstones/tombstones-view.mdx b/docs/monitoring/tombstones/tombstones-view.mdx index eac50303a9..56f0028999 100644 --- a/docs/monitoring/tombstones/tombstones-view.mdx +++ b/docs/monitoring/tombstones/tombstones-view.mdx @@ -22,11 +22,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; and for each process, the number of tombstones it still has to process. * In this article: - * [Studio view](../../monitoring/tombstones/tombstones-view.mdx#studio-view) - * [Reading the Tombstones tables](../../monitoring/tombstones/tombstones-view.mdx#reading-the-tombstones-tables) - * [Per Collection table](../../monitoring/tombstones/tombstones-view.mdx#per-collection-table) - * [Per Task table](../../monitoring/tombstones/tombstones-view.mdx#per-task-table) - * [Example: a disabled index blocking cleanup](../../monitoring/tombstones/tombstones-view.mdx#example-a-disabled-index-blocking-cleanup) + * [Studio view](#studio-view) + * [Reading the Tombstones tables](#reading-the-tombstones-tables) + * [Per Collection table](#per-collection-table) + * [Per Task table](#per-task-table) + * [Example: a disabled index blocking cleanup](#example-a-disabled-index-blocking-cleanup) @@ -77,12 +77,12 @@ To open the **Tombstones** view, go to `Settings` > `Tombstones`. 6. **Per Collection - Max Etags that can be deleted** For each collection, this table shows how far cleanup can proceed for document, time series, and counter tombstones, and the process that is currently setting each limit. - See [Per Collection table](../../monitoring/tombstones/tombstones-view.mdx#per-collection-table). + See [Per Collection table](#per-collection-table). 7. **Per Task - Max Etag that can be deleted** Each process that handles tombstones has its own row. The row shows the Etag up to which the process has let cleanup proceed, and whether it is currently blocking cleanup. - See [Per Task table](../../monitoring/tombstones/tombstones-view.mdx#per-task-table). + See [Per Task table](#per-task-table). diff --git a/docs/querying/content/_customize-query-csharp.mdx b/docs/querying/content/_customize-query-csharp.mdx index 2f39aca901..273b607d49 100644 --- a/docs/querying/content/_customize-query-csharp.mdx +++ b/docs/querying/content/_customize-query-csharp.mdx @@ -16,18 +16,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more in [Subscribing to Events](../../client-api/session/how-to/subscribe-to-events.mdx). * Customization methods available: - - [BeforeQueryExecuted](../../querying/customize-query.mdx#beforequeryexecuted) - - [AfterQueryExecuted](../../querying/customize-query.mdx#afterqueryexecuted) - - [AfterStreamExecuted](../../querying/customize-query.mdx#afterstreamexecuted) - - [NoCaching](../../querying/customize-query.mdx#nocaching) - - [NoTracking](../../querying/customize-query.mdx#notracking) - - [Projection](../../querying/customize-query.mdx#projection) - - [RandomOrdering](../../querying/customize-query.mdx#randomordering) - - [Timings](../../querying/customize-query.mdx#timings) - - [WaitForNonStaleResults](../../querying/customize-query.mdx#waitfornonstaleresults) - - [WithTag](../../querying/customize-query.mdx#withtag) - -* [Methods return value](../../querying/customize-query.mdx#methods-return-value) + - [BeforeQueryExecuted](#beforequeryexecuted) + - [AfterQueryExecuted](#afterqueryexecuted) + - [AfterStreamExecuted](#afterstreamexecuted) + - [NoCaching](#nocaching) + - [NoTracking](#notracking) + - [Projection](#projection) + - [RandomOrdering](#randomordering) + - [Timings](#timings) + - [WaitForNonStaleResults](#waitfornonstaleresults) + - [WithTag](#withtag) + +* [Methods return value](#methods-return-value) diff --git a/docs/querying/content/_customize-query-java.mdx b/docs/querying/content/_customize-query-java.mdx index 8d7cdc5f59..8ac39495c8 100644 --- a/docs/querying/content/_customize-query-java.mdx +++ b/docs/querying/content/_customize-query-java.mdx @@ -9,14 +9,14 @@ import ContentFrame from "@site/src/components/ContentFrame"; The following query customization options are available in the `IDocumentQueryCustomization` interface: -- [BeforeQueryExecuted](../../querying/customize-query.mdx#beforequeryexecuted) -- [AfterQueryExecuted](../../querying/customize-query.mdx#afterqueryexecuted) -- [AfterStreamExecuted](../../querying/customize-query.mdx#afterstreamexecuted) -- [NoCaching](../../querying/customize-query.mdx#nocaching) -- [NoTracking](../../querying/customize-query.mdx#notracking) -- [ProjectionBehavior](../../querying/customize-query.mdx#projectionbehavior) -- [RandomOrdering](../../querying/customize-query.mdx#randomordering) -- [WaitForNonStaleResults](../../querying/customize-query.mdx#waitfornonstaleresults) +- [BeforeQueryExecuted](#beforequeryexecuted) +- [AfterQueryExecuted](#afterqueryexecuted) +- [AfterStreamExecuted](#afterstreamexecuted) +- [NoCaching](#nocaching) +- [NoTracking](#notracking) +- [ProjectionBehavior](#projectionbehavior) +- [RandomOrdering](#randomordering) +- [WaitForNonStaleResults](#waitfornonstaleresults) diff --git a/docs/querying/content/_customize-query-nodejs.mdx b/docs/querying/content/_customize-query-nodejs.mdx index e35917f369..7a3036eca4 100644 --- a/docs/querying/content/_customize-query-nodejs.mdx +++ b/docs/querying/content/_customize-query-nodejs.mdx @@ -18,12 +18,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Customization methods available: - [on ("beforeQueryExecuted")](../../querying/customize-query.mdx#on-("beforequeryexecuted")) - [on ("afterQueryExecuted")](../../querying/customize-query.mdx#on-("afterqueryexecuted")) - - [noCaching](../../querying/customize-query.mdx#nocaching) - - [noTracking](../../querying/customize-query.mdx#notracking) - - [projectionBehavior](../../querying/customize-query.mdx#projectionbehavior) - - [randomOrdering](../../querying/customize-query.mdx#randomordering) - - [timings](../../querying/customize-query.mdx#timings) - - [waitForNonStaleResults](../../querying/customize-query.mdx#waitfornonstaleresults) + - [noCaching](#nocaching) + - [noTracking](#notracking) + - [projectionBehavior](#projectionbehavior) + - [randomOrdering](#randomordering) + - [timings](#timings) + - [waitForNonStaleResults](#waitfornonstaleresults) diff --git a/docs/querying/content/_customize-query-php.mdx b/docs/querying/content/_customize-query-php.mdx index 97ce511d9a..dfe6138b24 100644 --- a/docs/querying/content/_customize-query-php.mdx +++ b/docs/querying/content/_customize-query-php.mdx @@ -14,15 +14,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; [subscribing to `OnBeforeQuery`](../../client-api/session/how-to/subscribe-to-events.mdx). * Available customization methods : - - [addBeforeQueryExecutedListener & removeBeforeQueryExecutedListener](../../querying/customize-query.mdx#addbeforequeryexecutedlistener-removebeforequeryexecutedlistener) - - [addAfterQueryExecutedListener & removeAfterQueryExecutedListener](../../querying/customize-query.mdx#addafterqueryexecutedlistener-removeafterqueryexecutedlistener) - - [noCaching](../../querying/customize-query.mdx#nocaching) - - [noTracking](../../querying/customize-query.mdx#notracking) - - [Projection](../../querying/customize-query.mdx#projection) - - [randomOrdering](../../querying/customize-query.mdx#randomordering) - - [waitForNonStaleResults](../../querying/customize-query.mdx#waitfornonstaleresults) + - [addBeforeQueryExecutedListener & removeBeforeQueryExecutedListener](#addbeforequeryexecutedlistener-removebeforequeryexecutedlistener) + - [addAfterQueryExecutedListener & removeAfterQueryExecutedListener](#addafterqueryexecutedlistener-removeafterqueryexecutedlistener) + - [noCaching](#nocaching) + - [noTracking](#notracking) + - [Projection](#projection) + - [randomOrdering](#randomordering) + - [waitForNonStaleResults](#waitfornonstaleresults) -* [Methods return value](../../querying/customize-query.mdx#methods-return-value) +* [Methods return value](#methods-return-value) diff --git a/docs/querying/content/_customize-query-python.mdx b/docs/querying/content/_customize-query-python.mdx index 7662784af5..dee2756bbf 100644 --- a/docs/querying/content/_customize-query-python.mdx +++ b/docs/querying/content/_customize-query-python.mdx @@ -15,17 +15,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more in [Subscribing to Events](../../client-api/session/how-to/subscribe-to-events.mdx). * Customization methods available: - - [before_query_executed](../../querying/customize-query.mdx#before_query_executed) - - [after_query_executed](../../querying/customize-query.mdx#after_query_executed) - - [after_stream_executed](../../querying/customize-query.mdx#after_stream_executed) - - [no_caching](../../querying/customize-query.mdx#no_caching) - - [no_tracking](../../querying/customize-query.mdx#no_tracking) - - [projection_behavior](../../querying/customize-query.mdx#projection_behavior) - - [random_ordering](../../querying/customize-query.mdx#random_ordering) - - [timings](../../querying/customize-query.mdx#timings) - - [wait_for_non_stale_results](../../querying/customize-query.mdx#wait_for_non_stale_results) - -* [Methods return value](../../querying/customize-query.mdx#methods-return-value) + - [before_query_executed](#before_query_executed) + - [after_query_executed](#after_query_executed) + - [after_stream_executed](#after_stream_executed) + - [no_caching](#no_caching) + - [no_tracking](#no_tracking) + - [projection_behavior](#projection_behavior) + - [random_ordering](#random_ordering) + - [timings](#timings) + - [wait_for_non_stale_results](#wait_for_non_stale_results) + +* [Methods return value](#methods-return-value) diff --git a/docs/querying/content/_overview-csharp.mdx b/docs/querying/content/_overview-csharp.mdx index b5bf54b371..ba1eb9bd4e 100644 --- a/docs/querying/content/_overview-csharp.mdx +++ b/docs/querying/content/_overview-csharp.mdx @@ -17,7 +17,7 @@ import Panel from '@site/src/components/Panel'; * Queries defined with `Query` or `DocumentQuery` are **translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx)** when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../querying/overview.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -33,12 +33,12 @@ import Panel from '@site/src/components/Panel'; * Queries are timed out after a configurable time period. See [query timeout](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this article: - * [Queries always provide results using an index](../../querying/overview.mdx#queries-always-provide-results-using-an-index) - * [Session.Query](../../querying/overview.mdx#session-query) - * [Session.Advanced.DocumentQuery](../../querying/overview.mdx#session-advanced-documentquery) - * [Session.Advanced.RawQuery](../../querying/overview.mdx#session-advanced-rawquery) - * [Custom methods and extensions for LINQ](../../querying/overview.mdx#custom-methods-and-extensions-for-linq) - * [Syntax](../../querying/overview.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [Session.Query](#session-query) + * [Session.Advanced.DocumentQuery](#session-advanced-documentquery) + * [Session.Advanced.RawQuery](#session-advanced-rawquery) + * [Custom methods and extensions for LINQ](#custom-methods-and-extensions-for-linq) + * [Syntax](#syntax) @@ -58,9 +58,9 @@ import Panel from '@site/src/components/Panel'; We differentiate between the following **3 query scenarios**: - 1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index) - 2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering) - 3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id) + 1. [Query an existing index](#1-query-an-existing-index) + 2. [Query a collection - with filtering](#2-query-a-collection---with-filtering) + 3. [Query a collection - query full collection | query by ID](#3-query-a-collection---query-full-collection--query-by-id) For each scenario, a different index type is used, as described below. @@ -110,7 +110,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../document-extensions/timeseries/indexing.mdx) and [Counters](../../document-extensions/counters/indexing.mdx). @@ -142,7 +142,7 @@ For each scenario, a different index type is used, as described below. No search engine index (Lucene or Corax) is involved in this process. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). @@ -156,7 +156,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../querying/overview.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -521,7 +521,7 @@ from "Employees" where FirstName = "Robert" -* Queries defined with [Query](../../querying/overview.mdx#session-query) or [DocumentQuery](../../querying/overview.mdx#session-advanced-documentquery) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) +* Queries defined with [Query](#session-query) or [DocumentQuery](#session-advanced-documentquery) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `RawQuery` method. @@ -567,7 +567,7 @@ List employees = await asyncSession -* Available custom methods and extensions for the session's [Query](../../querying/overview.mdx#session-query) method: +* Available custom methods and extensions for the session's [Query](#session-query) method: * [AggregateBy](../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) * AnyAsync @@ -603,7 +603,7 @@ List employees = await asyncSession --- -* The available methods for the session's [DocumentQuery](../../querying/overview.mdx#session-advanced-documentquery) method +* The available methods for the session's [DocumentQuery](#session-advanced-documentquery) method are listed in [Custom methods and extensions](../../querying/document-query/what-is-document-query.mdx#custom-methods-and-extensions). @@ -646,6 +646,6 @@ IRawDocumentQuery RawQuery(string query); | Return Value | | | - | - | -| `IRavenQueryable`
`IDocumentQuery`
`IRawDocumentQuery` | Instances exposing additional query methods and [extensions](../../querying/overview.mdx#custom-methods-and-extensions-for-linq) | +| `IRavenQueryable`
`IDocumentQuery`
`IRawDocumentQuery` | Instances exposing additional query methods and [extensions](#custom-methods-and-extensions-for-linq) | \ No newline at end of file diff --git a/docs/querying/content/_overview-nodejs.mdx b/docs/querying/content/_overview-nodejs.mdx index 801dfc4d25..06d2999252 100644 --- a/docs/querying/content/_overview-nodejs.mdx +++ b/docs/querying/content/_overview-nodejs.mdx @@ -15,7 +15,7 @@ import Panel from '@site/src/components/Panel'; * Queries defined with the `query` method are **translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx)** when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../querying/overview.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -31,11 +31,11 @@ import Panel from '@site/src/components/Panel'; * Queries are timed out after a configurable time period. See [query timeout](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this article: - * [Queries always provide results using an index](../../querying/overview.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../querying/overview.mdx#session-query) - * [session.advanced.rawQuery](../../querying/overview.mdx#session-advanced-rawquery) - * [query API](../../querying/overview.mdx#query-api) - * [Syntax](../../querying/overview.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#session-query) + * [session.advanced.rawQuery](#session-advanced-rawquery) + * [query API](#query-api) + * [Syntax](#syntax) @@ -55,9 +55,9 @@ import Panel from '@site/src/components/Panel'; We differentiate between the following **3 query scenarios**: - 1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index) - 2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering) - 3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id) + 1. [Query an existing index](#1-query-an-existing-index) + 2. [Query a collection - with filtering](#2-query-a-collection---with-filtering) + 3. [Query a collection - query full collection | query by ID](#3-query-a-collection---query-full-collection--query-by-id) For each scenario, a different index type is used, as described below. @@ -109,7 +109,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../document-extensions/timeseries/indexing.mdx) and [Counters](../../document-extensions/counters/indexing.mdx). @@ -142,7 +142,7 @@ For each scenario, a different index type is used, as described below. No search engine index (Lucene or Corax) is involved in this process. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). @@ -151,7 +151,7 @@ For each scenario, a different index type is used, as described below. * The simplest way to issue a query is by using the session's `query` method. - Customize your query with these [API methods](../../querying/overview.mdx#query-api). + Customize your query with these [API methods](#query-api). * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../indexes/querying/query-index.mdx) for other examples. @@ -336,7 +336,7 @@ from "products" limit 5, 10 // skip 5, take 10 -* Queries defined with [query](../../querying/overview.mdx#session-query) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) when sent to the server. +* Queries defined with [query](#session-query) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. @@ -363,7 +363,7 @@ const employees = await session.advanced -Available methods for the session's [query](../../querying/overview.mdx#session-query) method: +Available methods for the session's [query](#session-query) method: - addOrder - addParameter @@ -472,7 +472,7 @@ session.rawQuery(query); | Return Value | | | - | - | -| `object` | Instance implementing `IDocumentQuery` exposing the additional [query methods](../../querying/overview.mdx#query-api). | +| `object` | Instance implementing `IDocumentQuery` exposing the additional [query methods](#query-api). | * Note: Use `await` when executing the query, e.g. when calling `.all`, `.single`, `.first`, `.count`, etc. diff --git a/docs/querying/content/_overview-php.mdx b/docs/querying/content/_overview-php.mdx index 16ecb53abe..393c9edc7b 100644 --- a/docs/querying/content/_overview-php.mdx +++ b/docs/querying/content/_overview-php.mdx @@ -17,7 +17,7 @@ import Panel from '@site/src/components/Panel'; * Queries defined using `query` or `documentQuery` are **translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx)** when sent to the server. * All RavenDB queries use an **index** to provide results, even when an index is not explicitly defined. - Learn more [below](../../querying/overview.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article shows examples of dynamic queries only. @@ -35,12 +35,12 @@ import Panel from '@site/src/components/Panel'; See [query timeout](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this article: - * [Queries always provide results using an index](../../querying/overview.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../querying/overview.mdx#session-query) - * [session.advanced.documentQuery](../../querying/overview.mdx#session-advanced-documentquery) - * [session.advanced.rawQuery](../../querying/overview.mdx#session-advanced-rawquery) - * [query API](../../querying/overview.mdx#query-api) - * [Syntax](../../querying/overview.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#session-query) + * [session.advanced.documentQuery](#session-advanced-documentquery) + * [session.advanced.rawQuery](#session-advanced-rawquery) + * [query API](#query-api) + * [Syntax](#syntax) @@ -60,9 +60,9 @@ import Panel from '@site/src/components/Panel'; We differentiate between the following **3 query scenarios**: - 1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index) - 2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering) - 3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id) + 1. [Query an existing index](#1-query-an-existing-index) + 2. [Query a collection - with filtering](#2-query-a-collection---with-filtering) + 3. [Query a collection - query full collection | query by ID](#3-query-a-collection---query-full-collection--query-by-id) For each scenario, a different index type is used, as described below. @@ -112,7 +112,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * RQL Example:   `from Employees where FirstName == "Laura"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../document-extensions/timeseries/indexing.mdx) @@ -145,7 +145,7 @@ For each scenario, a different index type is used, as described below. No search engine index (Lucene or Corax) is involved in this process. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). @@ -154,7 +154,7 @@ For each scenario, a different index type is used, as described below. * The simplest way to issue a query is by using the session's `query` method. - Customize your query with these [API methods](../../querying/overview.mdx#query-api). + Customize your query with these [API methods](#query-api). * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../indexes/querying/query-index.mdx) for other examples. @@ -334,8 +334,8 @@ from "Employees" where FirstName = "Robert" -* Queries defined with [query](../../querying/overview.mdx#session-query) - or [documentQuery](../../querying/overview.mdx#session-advanced-documentquery) +* Queries defined with [query](#session-query) + or [documentQuery](#session-advanced-documentquery) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) when sent to the server. @@ -364,7 +364,7 @@ $employees = $session -Available methods for the session's [query](../../querying/overview.mdx#session-query) method: +Available methods for the session's [query](#session-query) method: - AddOrder - [afterQueryExecuted](../../querying/customize-query.mdx#afterqueryexecuted) @@ -477,6 +477,6 @@ public function rawQuery(?string $className, string $query): RawDocumentQueryInt | Return Value | | | - | - | -| `DocumentQueryInterface`
`RawDocumentQueryInterface` | Interfaces exposing additional query methods and [extensions](../../querying/overview.mdx#custom-methods) | +| `DocumentQueryInterface`
`RawDocumentQueryInterface` | Interfaces exposing additional query methods and [extensions](#custom-methods) | \ No newline at end of file diff --git a/docs/querying/content/_overview-python.mdx b/docs/querying/content/_overview-python.mdx index 1a9a63df8d..ca7ab941f1 100644 --- a/docs/querying/content/_overview-python.mdx +++ b/docs/querying/content/_overview-python.mdx @@ -17,7 +17,7 @@ import Panel from '@site/src/components/Panel'; * Queries defined with `query` or `document_query` are **translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx)** when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../querying/overview.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -33,12 +33,12 @@ import Panel from '@site/src/components/Panel'; * Queries are timed out after a configurable time period. See [query timeout](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this article: - * [Queries always provide results using an index](../../querying/overview.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../querying/overview.mdx#session-query) - * [session.advanced.document_query](../../querying/overview.mdx#session-advanced-document_query) - * [session.advanced.raw_query](../../querying/overview.mdx#session-advanced-raw_query) - * [query API](../../querying/overview.mdx#query-api) - * [Syntax](../../querying/overview.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#session-query) + * [session.advanced.document_query](#session-advanced-document_query) + * [session.advanced.raw_query](#session-advanced-raw_query) + * [query API](#query-api) + * [Syntax](#syntax) @@ -58,9 +58,9 @@ import Panel from '@site/src/components/Panel'; We differentiate between the following **3 query scenarios**: - 1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index) - 2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering) - 3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id) + 1. [Query an existing index](#1-query-an-existing-index) + 2. [Query a collection - with filtering](#2-query-a-collection---with-filtering) + 3. [Query a collection - query full collection | query by ID](#3-query-a-collection---query-full-collection--query-by-id) For each scenario, a different index type is used, as described below. @@ -110,7 +110,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../document-extensions/timeseries/indexing.mdx) and [Counters](../../document-extensions/counters/indexing.mdx). @@ -142,7 +142,7 @@ For each scenario, a different index type is used, as described below. No search engine index (Lucene or Corax) is involved in this process. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../querying/overview.mdx#session-query). + See more examples [below](#session-query). @@ -151,7 +151,7 @@ For each scenario, a different index type is used, as described below. * The simplest way to issue a query is using session's `query` method. - Customize your query with these [API methods](../../querying/overview.mdx#query-api). + Customize your query with these [API methods](#query-api). * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../indexes/querying/query-index.mdx) for other examples. @@ -391,7 +391,7 @@ from "Employees" where FirstName = "Robert" -* Queries defined with [query](../../querying/overview.mdx#session-query) or [document_query](../../querying/overview.mdx#session-advanced-document_query) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) +* Queries defined with [query](#session-query) or [document_query](#session-advanced-document_query) are translated by the RavenDB client to [RQL](../../querying/rql/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `raw_query` method. @@ -420,7 +420,7 @@ employees = list( # Execute the query -Available methods for the session's [query](../../querying/overview.mdx#session-query) method: +Available methods for the session's [query](#session-query) method: - add_order - [after_query_executed](../../querying/customize-query.mdx#afterqueryexecuted) @@ -563,6 +563,6 @@ def raw_query(self, query: str, object_type: Optional[Type[_T]] = None) -> RawDo | Return Value | | | - | - | -| `DocumentQuery[_T]`
`RawDocumentQuery[_T]` | Instances exposing additional query methods and [extensions](../../querying/overview.mdx#custom-methods-and-extensions-for-linq) | +| `DocumentQuery[_T]`
`RawDocumentQuery[_T]` | Instances exposing additional query methods and [extensions](#custom-methods-and-extensions-for-linq) | \ No newline at end of file diff --git a/docs/querying/content/_stream-query-results-csharp.mdx b/docs/querying/content/_stream-query-results-csharp.mdx index 5f2011ebf1..fe79d208c1 100644 --- a/docs/querying/content/_stream-query-results-csharp.mdx +++ b/docs/querying/content/_stream-query-results-csharp.mdx @@ -15,17 +15,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To stream results, use the `Stream` method from the `Advanced` session operations. * In this article: - * [Streaming overview](../../querying/stream-query-results.mdx#streaming-overview) - * [Stream by query](../../querying/stream-query-results.mdx#stream-by-query) - * [Stream a dynamic query](../../querying/stream-query-results.mdx#stream-a-dynamic-query) - * [Stream a dynamic raw query](../../querying/stream-query-results.mdx#stream-a-dynamic-raw-query) - * [Stream a projected query](../../querying/stream-query-results.mdx#stream-a-projected-query) - * [Stream an index query](../../querying/stream-query-results.mdx#stream-an-index-query) - * [Stream related documents](../../querying/stream-query-results.mdx#stream-related-documents) - * [By query syntax](../../querying/stream-query-results.mdx#by-query-syntax) - * [Stream by prefix](../../querying/stream-query-results.mdx#stream-by-prefix) - * [Stream results by prefix](../../querying/stream-query-results.mdx#stream-results-by-prefix) - * [By prefix syntax](../../querying/stream-query-results.mdx#by-prefix-syntax) + * [Streaming overview](#streaming-overview) + * [Stream by query](#stream-by-query) + * [Stream a dynamic query](#stream-a-dynamic-query) + * [Stream a dynamic raw query](#stream-a-dynamic-raw-query) + * [Stream a projected query](#stream-a-projected-query) + * [Stream an index query](#stream-an-index-query) + * [Stream related documents](#stream-related-documents) + * [By query syntax](#by-query-syntax) + * [Stream by prefix](#stream-by-prefix) + * [Stream results by prefix](#stream-results-by-prefix) + * [By prefix syntax](#by-prefix-syntax) @@ -50,7 +50,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; So calling [WaitForNonStaleResults](../../querying/customize-query.mdx#waitfornonstaleresults) is Not supported and will result in an exception. * Using [Include](../../client-api/how-to/handle-document-relationships.mdx#includes) to load a related document into the session in a streaming query is Not supported. - Learn more in [Stream related documents](../../querying/stream-query-results.mdx#stream-related-documents). + Learn more in [Stream related documents](#stream-related-documents). diff --git a/docs/querying/content/_stream-query-results-nodejs.mdx b/docs/querying/content/_stream-query-results-nodejs.mdx index 9d09406c12..3b95648f25 100644 --- a/docs/querying/content/_stream-query-results-nodejs.mdx +++ b/docs/querying/content/_stream-query-results-nodejs.mdx @@ -15,17 +15,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To stream results, use the `stream` method from the `advanced` session operations. * In this article: - * [Streaming overview](../../querying/stream-query-results.mdx#streaming-overview) - * [Stream by query](../../querying/stream-query-results.mdx#stream-by-query) - * [Stream a dynamic query](../../querying/stream-query-results.mdx#stream-a-dynamic-query) - * [Stream a dynamic raw query](../../querying/stream-query-results.mdx#stream-a-dynamic-raw-query) - * [Stream a projected query](../../querying/stream-query-results.mdx#stream-a-projected-query) - * [Stream an index query](../../querying/stream-query-results.mdx#stream-an-index-query) - * [Stream related documents](../../querying/stream-query-results.mdx#stream-related-documents) - * [By query syntax](../../querying/stream-query-results.mdx#by-query-syntax) - * [Stream by prefix](../../querying/stream-query-results.mdx#stream-by-prefix) - * [Stream results by prefix](../../querying/stream-query-results.mdx#stream-results-by-prefix) - * [By prefix syntax](../../querying/stream-query-results.mdx#by-prefix-syntax) + * [Streaming overview](#streaming-overview) + * [Stream by query](#stream-by-query) + * [Stream a dynamic query](#stream-a-dynamic-query) + * [Stream a dynamic raw query](#stream-a-dynamic-raw-query) + * [Stream a projected query](#stream-a-projected-query) + * [Stream an index query](#stream-an-index-query) + * [Stream related documents](#stream-related-documents) + * [By query syntax](#by-query-syntax) + * [Stream by prefix](#stream-by-prefix) + * [Stream results by prefix](#stream-results-by-prefix) + * [By prefix syntax](#by-prefix-syntax) @@ -50,7 +50,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; So calling [waitForNonStaleResults](../../querying/customize-query.mdx#waitfornonstaleresults) is Not supported and will result in an exception. * Using [include](../../client-api/session/loading-entities.mdx#load-with-includes) to load a related document into the session in a streaming query is Not supported. - Learn more in [Stream related documents](../../querying/stream-query-results.mdx#stream-related-documents). + Learn more in [Stream related documents](#stream-related-documents). diff --git a/docs/querying/document-query/content/_query-vs-document-query-csharp.mdx b/docs/querying/document-query/content/_query-vs-document-query-csharp.mdx index 79a4ba5fc5..7fbcb19e07 100644 --- a/docs/querying/document-query/content/_query-vs-document-query-csharp.mdx +++ b/docs/querying/document-query/content/_query-vs-document-query-csharp.mdx @@ -13,9 +13,9 @@ import Panel from '@site/src/components/Panel'; * The main differences between `Query` and `DocumentQuery` are outlined in this article. * In this article: - * [API support](../../../querying/document-query/query-vs-document-query.mdx#api-support) - * [Immutability](../../../querying/document-query/query-vs-document-query.mdx#immutability) - * [Default query operator](../../../querying/document-query/query-vs-document-query.mdx#default-query-operator) + * [API support](#api-support) + * [Immutability](#immutability) + * [Default query operator](#default-query-operator) diff --git a/docs/querying/document-query/content/_query-vs-document-query-php.mdx b/docs/querying/document-query/content/_query-vs-document-query-php.mdx index 16c54fb961..346beda791 100644 --- a/docs/querying/document-query/content/_query-vs-document-query-php.mdx +++ b/docs/querying/document-query/content/_query-vs-document-query-php.mdx @@ -18,7 +18,7 @@ import Panel from '@site/src/components/Panel'; Examples of equivalent calls are listed below. * In this article: - * [Examples of equivalent `query` & `documentQuery` calls](../../../querying/document-query/query-vs-document-query.mdx#examples-of-equivalent-query-documentquery-calls) + * [Examples of equivalent `query` & `documentQuery` calls](#examples-of-equivalent-query-documentquery-calls) diff --git a/docs/querying/document-query/content/_query-vs-document-query-python.mdx b/docs/querying/document-query/content/_query-vs-document-query-python.mdx index 7c7c1a07ea..528581048e 100644 --- a/docs/querying/document-query/content/_query-vs-document-query-python.mdx +++ b/docs/querying/document-query/content/_query-vs-document-query-python.mdx @@ -18,7 +18,7 @@ import Panel from '@site/src/components/Panel'; Examples of equivalent calls are listed below. * In this article: - * [Examples of equivalent `query` & `document_query` calls](../../../querying/document-query/query-vs-document-query.mdx#examples-of-equivalent-query-document_query-calls) + * [Examples of equivalent `query` & `document_query` calls](#examples-of-equivalent-query-document_query-calls) diff --git a/docs/querying/document-query/content/_what-is-document-query-csharp.mdx b/docs/querying/document-query/content/_what-is-document-query-csharp.mdx index 02364ae028..1fb55fe32a 100644 --- a/docs/querying/document-query/content/_what-is-document-query-csharp.mdx +++ b/docs/querying/document-query/content/_what-is-document-query-csharp.mdx @@ -15,10 +15,10 @@ import Panel from '@site/src/components/Panel'; as it provides low-level querying capabilities. See [Query -vs- DocumentQuery](../../../querying/document-query/query-vs-document-query.mdx) for all differences. * In this article: - * [`DocumentQuery` examples](../../../querying/document-query/what-is-document-query.mdx#documentquery-examples) - * [Convert between `DocumentQuery` and `Query`](../../../querying/document-query/what-is-document-query.mdx#convert-between-documentquery-and-query) - * [Custom methods and extensions](../../../querying/document-query/what-is-document-query.mdx#custom-methods-and-extensions) - * [Syntax](../../../querying/document-query/what-is-document-query.mdx#syntax) + * [`DocumentQuery` examples](#documentquery-examples) + * [Convert between `DocumentQuery` and `Query`](#convert-between-documentquery-and-query) + * [Custom methods and extensions](#custom-methods-and-extensions) + * [Syntax](#syntax) diff --git a/docs/querying/document-query/content/_what-is-document-query-php.mdx b/docs/querying/document-query/content/_what-is-document-query-php.mdx index d121a327a0..37c4981f2c 100644 --- a/docs/querying/document-query/content/_what-is-document-query-php.mdx +++ b/docs/querying/document-query/content/_what-is-document-query-php.mdx @@ -16,8 +16,8 @@ import Panel from '@site/src/components/Panel'; See [query -vs- documentQuery](../../../querying/document-query/query-vs-document-query.mdx) for additional details. * In this article: - * [`documentQuery` examples](../../../querying/document-query/what-is-document-query.mdx#documentquery-examples) - * [Syntax](../../../querying/document-query/what-is-document-query.mdx#syntax) + * [`documentQuery` examples](#documentquery-examples) + * [Syntax](#syntax) diff --git a/docs/querying/document-query/content/_what-is-document-query-python.mdx b/docs/querying/document-query/content/_what-is-document-query-python.mdx index c59280a336..fa9d16ff1a 100644 --- a/docs/querying/document-query/content/_what-is-document-query-python.mdx +++ b/docs/querying/document-query/content/_what-is-document-query-python.mdx @@ -18,8 +18,8 @@ import Panel from '@site/src/components/Panel'; See [query -vs- document_query](../../../querying/document-query/query-vs-document-query.mdx) for additional details. * In this article: - * [`document_query` examples](../../../querying/document-query/what-is-document-query.mdx#document_query-examples) - * [Syntax](../../../querying/document-query/what-is-document-query.mdx#syntax) + * [`document_query` examples](#document_query-examples) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_conditional-filtering-csharp.mdx b/docs/querying/filtering-query-results/content/_conditional-filtering-csharp.mdx index 50a6e5eed4..f5d1e5e407 100644 --- a/docs/querying/filtering-query-results/content/_conditional-filtering-csharp.mdx +++ b/docs/querying/filtering-query-results/content/_conditional-filtering-csharp.mdx @@ -26,15 +26,15 @@ import Panel from '@site/src/components/Panel'; The second argument, `predicate`, is a regular query predicate that is matched against documents. * In this article: - * [When to use conditional filtering](../../../querying/filtering-query-results/conditional-filtering.mdx#when-to-use-conditional-filtering) - * [Basic example](../../../querying/filtering-query-results/conditional-filtering.mdx#basic-example) - * [Combine `when` with `and`, `or`, and `not`](../../../querying/filtering-query-results/conditional-filtering.mdx#combine-when-with-and-or-and-not) - * [Parameter and null handling](../../../querying/filtering-query-results/conditional-filtering.mdx#parameter-and-null-handling) - * [Type handling](../../../querying/filtering-query-results/conditional-filtering.mdx#type-handling) - * [Logical expressions in the condition](../../../querying/filtering-query-results/conditional-filtering.mdx#logical-expressions-in-the-condition) - * [Using `in` and `all in` in the condition](../../../querying/filtering-query-results/conditional-filtering.mdx#using-in-and-all-in-in-the-condition) - * [Restrictions](../../../querying/filtering-query-results/conditional-filtering.mdx#restrictions) - * [Syntax](../../../querying/filtering-query-results/conditional-filtering.mdx#syntax) + * [When to use conditional filtering](#when-to-use-conditional-filtering) + * [Basic example](#basic-example) + * [Combine `when` with `and`, `or`, and `not`](#combine-when-with-and-or-and-not) + * [Parameter and null handling](#parameter-and-null-handling) + * [Type handling](#type-handling) + * [Logical expressions in the condition](#logical-expressions-in-the-condition) + * [Using `in` and `all in` in the condition](#using-in-and-all-in-in-the-condition) + * [Restrictions](#restrictions) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_filter-by-date-and-time-csharp.mdx b/docs/querying/filtering-query-results/content/_filter-by-date-and-time-csharp.mdx index 9c706bdb39..380e196a87 100644 --- a/docs/querying/filtering-query-results/content/_filter-by-date-and-time-csharp.mdx +++ b/docs/querying/filtering-query-results/content/_filter-by-date-and-time-csharp.mdx @@ -9,25 +9,25 @@ import Panel from '@site/src/components/Panel'; * You can filter query results by date and time in one of the following ways: * An explicit date - * The current UTC date-time, using [now()](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-using-now), with or without an offset - * The start of the current UTC day, using [today()](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-using-today) + * The current UTC date-time, using [now()](#filter-using-now), with or without an offset + * The start of the current UTC day, using [today()](#filter-using-today) * The `now()` and `today()` functions are evaluated **server-side** when the query is executed. * In this article: - * [Filter by an explicit date](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-by-an-explicit-date) - * [Filter by single date](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-by-single-date) - * [Filter by date range](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-by-date-range) - * [Filter by date range using `between`](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-by-date-range-using-between) - * [Filter using `now()`](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-using-now) - * [Filter using `now()` with offset](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-using-now-with-offset) - * [Negative offset (past)](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#negative-offset-past) - * [Positive offset (future)](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#positive-offset-future) - * [Offset format](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#offset-format) - * [Filter using `today()`](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-using-today) - * [Restrictions](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#restrictions) - * [Result caching with time functions](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#result-caching-with-time-functions) - * [Syntax](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#syntax) + * [Filter by an explicit date](#filter-by-an-explicit-date) + * [Filter by single date](#filter-by-single-date) + * [Filter by date range](#filter-by-date-range) + * [Filter by date range using `between`](#filter-by-date-range-using-between) + * [Filter using `now()`](#filter-using-now) + * [Filter using `now()` with offset](#filter-using-now-with-offset) + * [Negative offset (past)](#negative-offset-past) + * [Positive offset (future)](#positive-offset-future) + * [Offset format](#offset-format) + * [Filter using `today()`](#filter-using-today) + * [Restrictions](#restrictions) + * [Result caching with time functions](#result-caching-with-time-functions) + * [Syntax](#syntax) @@ -38,7 +38,7 @@ import Panel from '@site/src/components/Panel'; * Use **UTC** values to avoid time-zone-related issues. RavenDB stores and compares date-time values in UTC. In the C# examples below, [DateTimeKind](https://learn.microsoft.com/dotnet/api/system.datetimekind) is passed to the `DateTime` constructor to mark the value as UTC. -* Unlike the [Restrictions](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#restrictions) on `now()` and `today()`, +* Unlike the [Restrictions](#restrictions) on `now()` and `today()`, explicit date values are deterministic and **can be used** in [Exploration queries](../../../indexes/querying/exploration-queries.mdx) and [Subscription queries](../../../client-api/data-subscriptions/creation/examples.mdx). --- @@ -486,7 +486,7 @@ where HiredAt between "1995-01-01T00:00:00.0000000Z" * This keeps the generated time value stable for the duration of the smallest unit in the offset, allowing identical queries to benefit from the server query cache and return `304 Not Modified` when applicable. - Learn more about caching in: [Result caching with time functions](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#result-caching-with-time-functions). + Learn more about caching in: [Result caching with time functions](#result-caching-with-time-functions). @@ -732,7 +732,7 @@ where RequireAt <= now($offset) Use `today()` when you need to compare a date field with the start of the current UTC day, rather than with the current date and time. * `today()` does **not** accept any arguments. - To filter relative to another day, use [now() with offset](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-using-now-with-offset) instead. + To filter relative to another day, use [now() with offset](#filter-using-now-with-offset) instead. For example, use `now('+1d')` to compare with the start of tomorrow’s UTC day. * The following query returns employees whose _HiredAt_ value is earlier than the start of the current UTC day: @@ -821,7 +821,7 @@ where RequireAt <= now($offset) In exploration queries, these functions are blocked in `filter` clauses because `filter` expressions are evaluated as JavaScript expressions. Since `now()` and `today()` depend on the query execution time, using them in this context produces time-dependent results that conflict with the query result caching mechanism. - [Filtering by an explicit date](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-by-an-explicit-date) is fully supported in exploration queries. + [Filtering by an explicit date](#filter-by-an-explicit-date) is fully supported in exploration queries. --- @@ -841,7 +841,7 @@ where RequireAt <= now($offset) Using `now()` or `today()` would make the matching results depend on when the subscription task evaluates each document, yielding nondeterministic results: the set of matching documents could change dynamically even when the documents themselves have not changed. - [Filtering by an explicit date](../../../querying/filtering-query-results/filter-by-date-and-time.mdx#filter-by-an-explicit-date) is fully supported in subscription queries. + [Filtering by an explicit date](#filter-by-an-explicit-date) is fully supported in subscription queries. --- diff --git a/docs/querying/filtering-query-results/content/_filter-query-results-csharp.mdx b/docs/querying/filtering-query-results/content/_filter-query-results-csharp.mdx index f99a4fa0fe..b0027b25e5 100644 --- a/docs/querying/filtering-query-results/content/_filter-query-results-csharp.mdx +++ b/docs/querying/filtering-query-results/content/_filter-query-results-csharp.mdx @@ -17,22 +17,22 @@ import Panel from '@site/src/components/Panel'; * The examples in this article mostly demonstrate **dynamic queries** (queries that don't specify which index to query). You can use the same filtering syntax when querying a **static index**, - as explained below in [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes). + as explained below in [Filtering when querying static indexes](#filtering-when-querying-static-indexes). * In this article: - * [Filtering and index usage](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-and-index-usage) - * [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) - * [Filter by numeric value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-numeric-value) - * [Filter by nested field](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-nested-field) - * [Filter by values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-values-in-a-collection) - * [Filter by multiple possible values](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-multiple-possible-values) - * [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) - * [Filter by matching all values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-all-values-in-a-collection) - * [Filter by string prefix or suffix](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-string-prefix-or-suffix) - * [Filter by field presence](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-presence) - * [Filter by document ID](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-document-id) - * [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes) - * [Syntax](../../../querying/filtering-query-results/filter-query-results.mdx#syntax) + * [Filtering and index usage](#filtering-and-index-usage) + * [Filter by field value](#filter-by-field-value) + * [Filter by numeric value](#filter-by-numeric-value) + * [Filter by nested field](#filter-by-nested-field) + * [Filter by values in a collection](#filter-by-values-in-a-collection) + * [Filter by multiple possible values](#filter-by-multiple-possible-values) + * [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) + * [Filter by matching all values in a collection](#filter-by-matching-all-values-in-a-collection) + * [Filter by string prefix or suffix](#filter-by-string-prefix-or-suffix) + * [Filter by field presence](#filter-by-field-presence) + * [Filter by document ID](#filter-by-document-id) + * [Filtering when querying static indexes](#filtering-when-querying-static-indexes) + * [Syntax](#syntax) @@ -412,7 +412,7 @@ where FirstName in ("Robert", "Nancy") > > The same auto-index serves both equality (`FirstName = "Robert"`) and `in` queries on this field - > the operator does not affect the auto-index name. -> This means the auto-index created in [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) is reused here, +> This means the auto-index created in [Filter by field value](#filter-by-field-value) is reused here, and no new auto-index is created. @@ -571,7 +571,7 @@ where Tags all in ("Development", "Research") > > `ContainsAny` (`in`) and `ContainsAll` (`all in`) produce the same auto-index name; > the operator only affects which documents match, not which auto-index is created or used. -> This means the auto-index created for [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) is reused here. +> This means the auto-index created for [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) is reused here. diff --git a/docs/querying/filtering-query-results/content/_filter-query-results-java.mdx b/docs/querying/filtering-query-results/content/_filter-query-results-java.mdx index b3dcf7a10c..ebba611aa6 100644 --- a/docs/querying/filtering-query-results/content/_filter-query-results-java.mdx +++ b/docs/querying/filtering-query-results/content/_filter-query-results-java.mdx @@ -17,22 +17,22 @@ import Panel from '@site/src/components/Panel'; * The examples in this article mostly demonstrate **dynamic queries** (queries that don't specify which index to query). You can use the same filtering syntax when querying a **static index**, - as explained below in [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes). + as explained below in [Filtering when querying static indexes](#filtering-when-querying-static-indexes). * In this article: - * [Filtering and index usage](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-and-index-usage) - * [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) - * [Filter by numeric value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-numeric-value) - * [Filter by nested field](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-nested-field) - * [Filter by values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-values-in-a-collection) - * [Filter by multiple possible values](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-multiple-possible-values) - * [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) - * [Filter by matching all values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-all-values-in-a-collection) - * [Filter by string prefix or suffix](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-string-prefix-or-suffix) - * [Filter by field presence](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-presence) - * [Filter by document ID](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-document-id) - * [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes) - * [Syntax](../../../querying/filtering-query-results/filter-query-results.mdx#syntax) + * [Filtering and index usage](#filtering-and-index-usage) + * [Filter by field value](#filter-by-field-value) + * [Filter by numeric value](#filter-by-numeric-value) + * [Filter by nested field](#filter-by-nested-field) + * [Filter by values in a collection](#filter-by-values-in-a-collection) + * [Filter by multiple possible values](#filter-by-multiple-possible-values) + * [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) + * [Filter by matching all values in a collection](#filter-by-matching-all-values-in-a-collection) + * [Filter by string prefix or suffix](#filter-by-string-prefix-or-suffix) + * [Filter by field presence](#filter-by-field-presence) + * [Filter by document ID](#filter-by-document-id) + * [Filtering when querying static indexes](#filtering-when-querying-static-indexes) + * [Syntax](#syntax) @@ -248,7 +248,7 @@ where FirstName in ("Robert", "Nancy") > > The same auto-index serves both equality (`FirstName = "Robert"`) and `in` queries on this field - > the operator does not affect the auto-index name. -> This means the auto-index created in [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) is reused here, +> This means the auto-index created in [Filter by field value](#filter-by-field-value) is reused here, and no new auto-index is created. @@ -347,7 +347,7 @@ where Tags all in ("Development", "Research") > > `containsAny` (`in`) and `containsAll` (`all in`) produce the same auto-index name; > the operator only affects which documents match, not which auto-index is created or used. -> This means the auto-index created for [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) is reused here. +> This means the auto-index created for [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) is reused here. diff --git a/docs/querying/filtering-query-results/content/_filter-query-results-nodejs.mdx b/docs/querying/filtering-query-results/content/_filter-query-results-nodejs.mdx index 83abb47a0e..983ddd8e10 100644 --- a/docs/querying/filtering-query-results/content/_filter-query-results-nodejs.mdx +++ b/docs/querying/filtering-query-results/content/_filter-query-results-nodejs.mdx @@ -17,22 +17,22 @@ import Panel from '@site/src/components/Panel'; * The examples in this article mostly demonstrate **dynamic queries** (queries that don't specify which index to query). You can use the same filtering syntax when querying a **static index**, - as explained below in [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes). + as explained below in [Filtering when querying static indexes](#filtering-when-querying-static-indexes). * In this article: - * [Filtering and index usage](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-and-index-usage) - * [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) - * [Filter by numeric value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-numeric-value) - * [Filter by nested field](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-nested-field) - * [Filter by values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-values-in-a-collection) - * [Filter by multiple possible values](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-multiple-possible-values) - * [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) - * [Filter by matching all values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-all-values-in-a-collection) - * [Filter by string prefix or suffix](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-string-prefix-or-suffix) - * [Filter by field presence](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-presence) - * [Filter by document ID](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-document-id) - * [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes) - * [Syntax](../../../querying/filtering-query-results/filter-query-results.mdx#syntax) + * [Filtering and index usage](#filtering-and-index-usage) + * [Filter by field value](#filter-by-field-value) + * [Filter by numeric value](#filter-by-numeric-value) + * [Filter by nested field](#filter-by-nested-field) + * [Filter by values in a collection](#filter-by-values-in-a-collection) + * [Filter by multiple possible values](#filter-by-multiple-possible-values) + * [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) + * [Filter by matching all values in a collection](#filter-by-matching-all-values-in-a-collection) + * [Filter by string prefix or suffix](#filter-by-string-prefix-or-suffix) + * [Filter by field presence](#filter-by-field-presence) + * [Filter by document ID](#filter-by-document-id) + * [Filtering when querying static indexes](#filtering-when-querying-static-indexes) + * [Syntax](#syntax) @@ -246,7 +246,7 @@ where FirstName in ("Robert", "Nancy") > > The same auto-index serves both equality (`FirstName = "Robert"`) and `in` queries on this field - > the operator does not affect the auto-index name. -> This means the auto-index created in [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) is reused here, +> This means the auto-index created in [Filter by field value](#filter-by-field-value) is reused here, and no new auto-index is created. @@ -337,7 +337,7 @@ where tags all in ("Development", "Research") > > `containsAny` (`in`) and `containsAll` (`all in`) produce the same auto-index name; > the operator only affects which documents match, not which auto-index is created or used. -> This means the auto-index created for [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) is reused here. +> This means the auto-index created for [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) is reused here. diff --git a/docs/querying/filtering-query-results/content/_filter-query-results-php.mdx b/docs/querying/filtering-query-results/content/_filter-query-results-php.mdx index 3b5190cffb..80d031c704 100644 --- a/docs/querying/filtering-query-results/content/_filter-query-results-php.mdx +++ b/docs/querying/filtering-query-results/content/_filter-query-results-php.mdx @@ -17,22 +17,22 @@ import Panel from '@site/src/components/Panel'; * The examples in this article mostly demonstrate **dynamic queries** (queries that don't specify which index to query). You can use the same filtering syntax when querying a **static index**, - as explained below in [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes). + as explained below in [Filtering when querying static indexes](#filtering-when-querying-static-indexes). * In this article: - * [Filtering and index usage](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-and-index-usage) - * [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) - * [Filter by numeric value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-numeric-value) - * [Filter by nested field](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-nested-field) - * [Filter by values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-values-in-a-collection) - * [Filter by multiple possible values](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-multiple-possible-values) - * [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) - * [Filter by matching all values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-all-values-in-a-collection) - * [Filter by string prefix or suffix](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-string-prefix-or-suffix) - * [Filter by field presence](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-presence) - * [Filter by document ID](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-document-id) - * [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes) - * [Syntax](../../../querying/filtering-query-results/filter-query-results.mdx#syntax) + * [Filtering and index usage](#filtering-and-index-usage) + * [Filter by field value](#filter-by-field-value) + * [Filter by numeric value](#filter-by-numeric-value) + * [Filter by nested field](#filter-by-nested-field) + * [Filter by values in a collection](#filter-by-values-in-a-collection) + * [Filter by multiple possible values](#filter-by-multiple-possible-values) + * [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) + * [Filter by matching all values in a collection](#filter-by-matching-all-values-in-a-collection) + * [Filter by string prefix or suffix](#filter-by-string-prefix-or-suffix) + * [Filter by field presence](#filter-by-field-presence) + * [Filter by document ID](#filter-by-document-id) + * [Filtering when querying static indexes](#filtering-when-querying-static-indexes) + * [Syntax](#syntax) @@ -248,7 +248,7 @@ where FirstName in ("Robert", "Nancy") > > The same auto-index serves both equality (`FirstName = "Robert"`) and `in` queries on this field - > the operator does not affect the auto-index name. -> This means the auto-index created in [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) is reused here, +> This means the auto-index created in [Filter by field value](#filter-by-field-value) is reused here, and no new auto-index is created. @@ -347,7 +347,7 @@ where tags all in ("Development", "Research") > > `containsAny` (`in`) and `containsAll` (`all in`) produce the same auto-index name; > the operator only affects which documents match, not which auto-index is created or used. -> This means the auto-index created for [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) is reused here. +> This means the auto-index created for [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) is reused here. diff --git a/docs/querying/filtering-query-results/content/_filter-query-results-python.mdx b/docs/querying/filtering-query-results/content/_filter-query-results-python.mdx index cdbac5bc4e..dfd8edb088 100644 --- a/docs/querying/filtering-query-results/content/_filter-query-results-python.mdx +++ b/docs/querying/filtering-query-results/content/_filter-query-results-python.mdx @@ -17,22 +17,22 @@ import Panel from '@site/src/components/Panel'; * The examples in this article mostly demonstrate **dynamic queries** (queries that don't specify which index to query). You can use the same filtering syntax when querying a **static index**, - as explained below in [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes). + as explained below in [Filtering when querying static indexes](#filtering-when-querying-static-indexes). * In this article: - * [Filtering and index usage](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-and-index-usage) - * [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) - * [Filter by numeric value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-numeric-value) - * [Filter by nested field](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-nested-field) - * [Filter by values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-values-in-a-collection) - * [Filter by multiple possible values](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-multiple-possible-values) - * [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) - * [Filter by matching all values in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-all-values-in-a-collection) - * [Filter by string prefix or suffix](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-string-prefix-or-suffix) - * [Filter by field presence](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-presence) - * [Filter by document ID](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-document-id) - * [Filtering when querying static indexes](../../../querying/filtering-query-results/filter-query-results.mdx#filtering-when-querying-static-indexes) - * [Syntax](../../../querying/filtering-query-results/filter-query-results.mdx#syntax) + * [Filtering and index usage](#filtering-and-index-usage) + * [Filter by field value](#filter-by-field-value) + * [Filter by numeric value](#filter-by-numeric-value) + * [Filter by nested field](#filter-by-nested-field) + * [Filter by values in a collection](#filter-by-values-in-a-collection) + * [Filter by multiple possible values](#filter-by-multiple-possible-values) + * [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) + * [Filter by matching all values in a collection](#filter-by-matching-all-values-in-a-collection) + * [Filter by string prefix or suffix](#filter-by-string-prefix-or-suffix) + * [Filter by field presence](#filter-by-field-presence) + * [Filter by document ID](#filter-by-document-id) + * [Filtering when querying static indexes](#filtering-when-querying-static-indexes) + * [Syntax](#syntax) @@ -253,7 +253,7 @@ where FirstName in ("Robert", "Nancy") > > The same auto-index serves both equality (`FirstName = "Robert"`) and `in` queries on this field - > the operator does not affect the auto-index name. -> This means the auto-index created in [Filter by field value](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-field-value) is reused here, +> This means the auto-index created in [Filter by field value](#filter-by-field-value) is reused here, and no new auto-index is created. @@ -344,7 +344,7 @@ where tags all in ("Development", "Research") > > `contains_any` (`in`) and `contains_all` (`all in`) produce the same auto-index name; > the operator only affects which documents match, not which auto-index is created or used. -> This means the auto-index created for [Filter by matching any value in a collection](../../../querying/filtering-query-results/filter-query-results.mdx#filter-by-matching-any-value-in-a-collection) is reused here. +> This means the auto-index created for [Filter by matching any value in a collection](#filter-by-matching-any-value-in-a-collection) is reused here. diff --git a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-csharp.mdx b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-csharp.mdx index cde4420fbc..e4b69805dc 100644 --- a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-csharp.mdx +++ b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-csharp.mdx @@ -18,20 +18,20 @@ import Panel from '@site/src/components/Panel'; If the target index uses [Corax](../../../indexes/search-engine/corax.mdx), the query throws an exception. * In this article: - * [Basic usage](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#basic-usage) - * [Common Lucene clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#common-lucene-clauses) - * [Wildcards](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#wildcards) - * [Boolean operators](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boolean-operators) - * [Phrase and proximity search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#phrase-and-proximity-search) - * [Fuzzy search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#fuzzy-search) - * [Boosting terms](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boosting-terms) - * [Range clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#range-clauses) - * [Filter on multiple fields](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#filter-on-multiple-fields) - * [Case-sensitive matching](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#case-sensitive-matching) - * [Combine with other filtering methods](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#combine-with-other-filtering-methods) - * [Escaping special characters](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#escaping-special-characters) - * [Restrictions](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#restrictions) - * [Syntax](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#syntax) + * [Basic usage](#basic-usage) + * [Common Lucene clauses](#common-lucene-clauses) + * [Wildcards](#wildcards) + * [Boolean operators](#boolean-operators) + * [Phrase and proximity search](#phrase-and-proximity-search) + * [Fuzzy search](#fuzzy-search) + * [Boosting terms](#boosting-terms) + * [Range clauses](#range-clauses) + * [Filter on multiple fields](#filter-on-multiple-fields) + * [Case-sensitive matching](#case-sensitive-matching) + * [Combine with other filtering methods](#combine-with-other-filtering-methods) + * [Escaping special characters](#escaping-special-characters) + * [Restrictions](#restrictions) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-java.mdx b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-java.mdx index 59dc07fb5e..030c16d4e1 100644 --- a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-java.mdx +++ b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-java.mdx @@ -18,20 +18,20 @@ import Panel from '@site/src/components/Panel'; If the target index uses [Corax](../../../indexes/search-engine/corax.mdx), the query throws an exception. * In this article: - * [Basic usage](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#basic-usage) - * [Common Lucene clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#common-lucene-clauses) - * [Wildcards](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#wildcards) - * [Boolean operators](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boolean-operators) - * [Phrase and proximity search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#phrase-and-proximity-search) - * [Fuzzy search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#fuzzy-search) - * [Boosting terms](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boosting-terms) - * [Range clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#range-clauses) - * [Filter on multiple fields](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#filter-on-multiple-fields) - * [Case-sensitive matching](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#case-sensitive-matching) - * [Combine with other filtering methods](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#combine-with-other-filtering-methods) - * [Escaping special characters](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#escaping-special-characters) - * [Restrictions](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#restrictions) - * [Syntax](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#syntax) + * [Basic usage](#basic-usage) + * [Common Lucene clauses](#common-lucene-clauses) + * [Wildcards](#wildcards) + * [Boolean operators](#boolean-operators) + * [Phrase and proximity search](#phrase-and-proximity-search) + * [Fuzzy search](#fuzzy-search) + * [Boosting terms](#boosting-terms) + * [Range clauses](#range-clauses) + * [Filter on multiple fields](#filter-on-multiple-fields) + * [Case-sensitive matching](#case-sensitive-matching) + * [Combine with other filtering methods](#combine-with-other-filtering-methods) + * [Escaping special characters](#escaping-special-characters) + * [Restrictions](#restrictions) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-nodejs.mdx b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-nodejs.mdx index 0e8a9ccbe6..c0628f242a 100644 --- a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-nodejs.mdx +++ b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-nodejs.mdx @@ -18,20 +18,20 @@ import Panel from '@site/src/components/Panel'; If the target index uses [Corax](../../../indexes/search-engine/corax.mdx), the query throws an exception. * In this article: - * [Basic usage](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#basic-usage) - * [Common Lucene clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#common-lucene-clauses) - * [Wildcards](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#wildcards) - * [Boolean operators](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boolean-operators) - * [Phrase and proximity search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#phrase-and-proximity-search) - * [Fuzzy search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#fuzzy-search) - * [Boosting terms](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boosting-terms) - * [Range clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#range-clauses) - * [Filter on multiple fields](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#filter-on-multiple-fields) - * [Case-sensitive matching](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#case-sensitive-matching) - * [Combine with other filtering methods](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#combine-with-other-filtering-methods) - * [Escaping special characters](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#escaping-special-characters) - * [Restrictions](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#restrictions) - * [Syntax](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#syntax) + * [Basic usage](#basic-usage) + * [Common Lucene clauses](#common-lucene-clauses) + * [Wildcards](#wildcards) + * [Boolean operators](#boolean-operators) + * [Phrase and proximity search](#phrase-and-proximity-search) + * [Fuzzy search](#fuzzy-search) + * [Boosting terms](#boosting-terms) + * [Range clauses](#range-clauses) + * [Filter on multiple fields](#filter-on-multiple-fields) + * [Case-sensitive matching](#case-sensitive-matching) + * [Combine with other filtering methods](#combine-with-other-filtering-methods) + * [Escaping special characters](#escaping-special-characters) + * [Restrictions](#restrictions) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-php.mdx b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-php.mdx index 00464c2e8d..c1953fcc4b 100644 --- a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-php.mdx +++ b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-php.mdx @@ -18,20 +18,20 @@ import Panel from '@site/src/components/Panel'; If the target index uses [Corax](../../../indexes/search-engine/corax.mdx), the query throws an exception. * In this article: - * [Basic usage](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#basic-usage) - * [Common Lucene clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#common-lucene-clauses) - * [Wildcards](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#wildcards) - * [Boolean operators](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boolean-operators) - * [Phrase and proximity search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#phrase-and-proximity-search) - * [Fuzzy search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#fuzzy-search) - * [Boosting terms](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boosting-terms) - * [Range clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#range-clauses) - * [Filter on multiple fields](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#filter-on-multiple-fields) - * [Case-sensitive matching](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#case-sensitive-matching) - * [Combine with other filtering methods](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#combine-with-other-filtering-methods) - * [Escaping special characters](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#escaping-special-characters) - * [Restrictions](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#restrictions) - * [Syntax](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#syntax) + * [Basic usage](#basic-usage) + * [Common Lucene clauses](#common-lucene-clauses) + * [Wildcards](#wildcards) + * [Boolean operators](#boolean-operators) + * [Phrase and proximity search](#phrase-and-proximity-search) + * [Fuzzy search](#fuzzy-search) + * [Boosting terms](#boosting-terms) + * [Range clauses](#range-clauses) + * [Filter on multiple fields](#filter-on-multiple-fields) + * [Case-sensitive matching](#case-sensitive-matching) + * [Combine with other filtering methods](#combine-with-other-filtering-methods) + * [Escaping special characters](#escaping-special-characters) + * [Restrictions](#restrictions) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-python.mdx b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-python.mdx index 7abd40c973..8cd835f86d 100644 --- a/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-python.mdx +++ b/docs/querying/filtering-query-results/content/_filter-with-lucene-syntax-python.mdx @@ -18,20 +18,20 @@ import Panel from '@site/src/components/Panel'; If the target index uses [Corax](../../../indexes/search-engine/corax.mdx), the query throws an exception. * In this article: - * [Basic usage](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#basic-usage) - * [Common Lucene clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#common-lucene-clauses) - * [Wildcards](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#wildcards) - * [Boolean operators](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boolean-operators) - * [Phrase and proximity search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#phrase-and-proximity-search) - * [Fuzzy search](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#fuzzy-search) - * [Boosting terms](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#boosting-terms) - * [Range clauses](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#range-clauses) - * [Filter on multiple fields](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#filter-on-multiple-fields) - * [Case-sensitive matching](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#case-sensitive-matching) - * [Combine with other filtering methods](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#combine-with-other-filtering-methods) - * [Escaping special characters](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#escaping-special-characters) - * [Restrictions](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#restrictions) - * [Syntax](../../../querying/filtering-query-results/filter-with-lucene-syntax.mdx#syntax) + * [Basic usage](#basic-usage) + * [Common Lucene clauses](#common-lucene-clauses) + * [Wildcards](#wildcards) + * [Boolean operators](#boolean-operators) + * [Phrase and proximity search](#phrase-and-proximity-search) + * [Fuzzy search](#fuzzy-search) + * [Boosting terms](#boosting-terms) + * [Range clauses](#range-clauses) + * [Filter on multiple fields](#filter-on-multiple-fields) + * [Case-sensitive matching](#case-sensitive-matching) + * [Combine with other filtering methods](#combine-with-other-filtering-methods) + * [Escaping special characters](#escaping-special-characters) + * [Restrictions](#restrictions) + * [Syntax](#syntax) diff --git a/docs/querying/filtering-query-results/content/_use-logical-operators-csharp.mdx b/docs/querying/filtering-query-results/content/_use-logical-operators-csharp.mdx index 9e5bca14d9..18f979006c 100644 --- a/docs/querying/filtering-query-results/content/_use-logical-operators-csharp.mdx +++ b/docs/querying/filtering-query-results/content/_use-logical-operators-csharp.mdx @@ -25,7 +25,7 @@ import Panel from '@site/src/components/Panel'; RQL keywords are case-insensitive; the examples below use lowercase. * The same logical-operator rules apply when querying a collection dynamically - and when [querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index). + and when [querying a static index](#logical-operators-when-querying-a-static-index). * For filtering by field value, numeric value, nested field, collection, document ID, and other basic conditions, see [Filter query results](../../../querying/filtering-query-results/filter-query-results.mdx). @@ -33,13 +33,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Combine conditions with AND](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-and) - * [Combine conditions with OR](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-or) - * [Negate a condition with NOT](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-condition-with-not) - * [Negate a group of conditions](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-group-of-conditions) - * [Group conditions to control precedence](../../../querying/filtering-query-results/use-logical-operators.mdx#group-conditions-to-control-precedence) - * [Logical operators when querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index) - * [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults) + * [Combine conditions with AND](#combine-conditions-with-and) + * [Combine conditions with OR](#combine-conditions-with-or) + * [Negate a condition with NOT](#negate-a-condition-with-not) + * [Negate a group of conditions](#negate-a-group-of-conditions) + * [Group conditions to control precedence](#group-conditions-to-control-precedence) + * [Logical operators when querying a static index](#logical-operators-when-querying-a-static-index) + * [Operator precedence and defaults](#operator-precedence-and-defaults) @@ -531,7 +531,7 @@ Without the grouping, the query: `Title = "Sales Representative" and FirstName = "Robert" or FirstName = "Nancy"` is evaluated as: `(Title = "Sales Representative" and FirstName = "Robert") or FirstName = "Nancy"`, -because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults)). +because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](#operator-precedence-and-defaults)). This returns a different set of documents than the grouped query. diff --git a/docs/querying/filtering-query-results/content/_use-logical-operators-java.mdx b/docs/querying/filtering-query-results/content/_use-logical-operators-java.mdx index f7204770be..8fd0ce8219 100644 --- a/docs/querying/filtering-query-results/content/_use-logical-operators-java.mdx +++ b/docs/querying/filtering-query-results/content/_use-logical-operators-java.mdx @@ -23,7 +23,7 @@ import Panel from '@site/src/components/Panel'; RQL keywords are case-insensitive; the examples below use lowercase. * The same logical-operator rules apply when querying a collection dynamically - and when [querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index). + and when [querying a static index](#logical-operators-when-querying-a-static-index). * For filtering by field value, numeric value, nested field, collection, document ID, and other basic conditions, see [Filter query results](../../../querying/filtering-query-results/filter-query-results.mdx). @@ -31,13 +31,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Combine conditions with AND](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-and) - * [Combine conditions with OR](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-or) - * [Negate a condition with NOT](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-condition-with-not) - * [Negate a group of conditions](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-group-of-conditions) - * [Group conditions to control precedence](../../../querying/filtering-query-results/use-logical-operators.mdx#group-conditions-to-control-precedence) - * [Logical operators when querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index) - * [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults) + * [Combine conditions with AND](#combine-conditions-with-and) + * [Combine conditions with OR](#combine-conditions-with-or) + * [Negate a condition with NOT](#negate-a-condition-with-not) + * [Negate a group of conditions](#negate-a-group-of-conditions) + * [Group conditions to control precedence](#group-conditions-to-control-precedence) + * [Logical operators when querying a static index](#logical-operators-when-querying-a-static-index) + * [Operator precedence and defaults](#operator-precedence-and-defaults) @@ -337,7 +337,7 @@ Without the grouping, the query: `Title = "Sales Representative" and FirstName = "Robert" or FirstName = "Nancy"` is evaluated as: `(Title = "Sales Representative" and FirstName = "Robert") or FirstName = "Nancy"`, -because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults)). +because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](#operator-precedence-and-defaults)). This returns a different set of documents than the grouped query. diff --git a/docs/querying/filtering-query-results/content/_use-logical-operators-nodejs.mdx b/docs/querying/filtering-query-results/content/_use-logical-operators-nodejs.mdx index b432028b6c..c071b7fe19 100644 --- a/docs/querying/filtering-query-results/content/_use-logical-operators-nodejs.mdx +++ b/docs/querying/filtering-query-results/content/_use-logical-operators-nodejs.mdx @@ -23,7 +23,7 @@ import Panel from '@site/src/components/Panel'; RQL keywords are case-insensitive; the examples below use lowercase. * The same logical-operator rules apply when querying a collection dynamically - and when [querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index). + and when [querying a static index](#logical-operators-when-querying-a-static-index). * For filtering by field value, numeric value, nested field, collection, document ID, and other basic conditions, see [Filter query results](../../../querying/filtering-query-results/filter-query-results.mdx). @@ -31,13 +31,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Combine conditions with AND](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-and) - * [Combine conditions with OR](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-or) - * [Negate a condition with NOT](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-condition-with-not) - * [Negate a group of conditions](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-group-of-conditions) - * [Group conditions to control precedence](../../../querying/filtering-query-results/use-logical-operators.mdx#group-conditions-to-control-precedence) - * [Logical operators when querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index) - * [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults) + * [Combine conditions with AND](#combine-conditions-with-and) + * [Combine conditions with OR](#combine-conditions-with-or) + * [Negate a condition with NOT](#negate-a-condition-with-not) + * [Negate a group of conditions](#negate-a-group-of-conditions) + * [Group conditions to control precedence](#group-conditions-to-control-precedence) + * [Logical operators when querying a static index](#logical-operators-when-querying-a-static-index) + * [Operator precedence and defaults](#operator-precedence-and-defaults) @@ -334,7 +334,7 @@ Without the grouping, the query: `Title = "Sales Representative" and FirstName = "Robert" or FirstName = "Nancy"` is evaluated as: `(Title = "Sales Representative" and FirstName = "Robert") or FirstName = "Nancy"`, -because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults)). +because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](#operator-precedence-and-defaults)). This returns a different set of documents than the grouped query. diff --git a/docs/querying/filtering-query-results/content/_use-logical-operators-php.mdx b/docs/querying/filtering-query-results/content/_use-logical-operators-php.mdx index 9b6168ea25..fd75376cbe 100644 --- a/docs/querying/filtering-query-results/content/_use-logical-operators-php.mdx +++ b/docs/querying/filtering-query-results/content/_use-logical-operators-php.mdx @@ -23,7 +23,7 @@ import Panel from '@site/src/components/Panel'; RQL keywords are case-insensitive; the examples below use lowercase. * The same logical-operator rules apply when querying a collection dynamically - and when [querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index). + and when [querying a static index](#logical-operators-when-querying-a-static-index). * For filtering by field value, numeric value, nested field, collection, document ID, and other basic conditions, see [Filter query results](../../../querying/filtering-query-results/filter-query-results.mdx). @@ -31,13 +31,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Combine conditions with AND](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-and) - * [Combine conditions with OR](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-or) - * [Negate a condition with NOT](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-condition-with-not) - * [Negate a group of conditions](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-group-of-conditions) - * [Group conditions to control precedence](../../../querying/filtering-query-results/use-logical-operators.mdx#group-conditions-to-control-precedence) - * [Logical operators when querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index) - * [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults) + * [Combine conditions with AND](#combine-conditions-with-and) + * [Combine conditions with OR](#combine-conditions-with-or) + * [Negate a condition with NOT](#negate-a-condition-with-not) + * [Negate a group of conditions](#negate-a-group-of-conditions) + * [Group conditions to control precedence](#group-conditions-to-control-precedence) + * [Logical operators when querying a static index](#logical-operators-when-querying-a-static-index) + * [Operator precedence and defaults](#operator-precedence-and-defaults) @@ -337,7 +337,7 @@ Without the grouping, the query: `Title = "Sales Representative" and FirstName = "Robert" or FirstName = "Nancy"` is evaluated as: `(Title = "Sales Representative" and FirstName = "Robert") or FirstName = "Nancy"`, -because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults)). +because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](#operator-precedence-and-defaults)). This returns a different set of documents than the grouped query. diff --git a/docs/querying/filtering-query-results/content/_use-logical-operators-python.mdx b/docs/querying/filtering-query-results/content/_use-logical-operators-python.mdx index 77eaa697d0..c4790fdac9 100644 --- a/docs/querying/filtering-query-results/content/_use-logical-operators-python.mdx +++ b/docs/querying/filtering-query-results/content/_use-logical-operators-python.mdx @@ -23,7 +23,7 @@ import Panel from '@site/src/components/Panel'; RQL keywords are case-insensitive; the examples below use lowercase. * The same logical-operator rules apply when querying a collection dynamically - and when [querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index). + and when [querying a static index](#logical-operators-when-querying-a-static-index). * For filtering by field value, numeric value, nested field, collection, document ID, and other basic conditions, see [Filter query results](../../../querying/filtering-query-results/filter-query-results.mdx). @@ -31,13 +31,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Combine conditions with AND](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-and) - * [Combine conditions with OR](../../../querying/filtering-query-results/use-logical-operators.mdx#combine-conditions-with-or) - * [Negate a condition with NOT](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-condition-with-not) - * [Negate a group of conditions](../../../querying/filtering-query-results/use-logical-operators.mdx#negate-a-group-of-conditions) - * [Group conditions to control precedence](../../../querying/filtering-query-results/use-logical-operators.mdx#group-conditions-to-control-precedence) - * [Logical operators when querying a static index](../../../querying/filtering-query-results/use-logical-operators.mdx#logical-operators-when-querying-a-static-index) - * [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults) + * [Combine conditions with AND](#combine-conditions-with-and) + * [Combine conditions with OR](#combine-conditions-with-or) + * [Negate a condition with NOT](#negate-a-condition-with-not) + * [Negate a group of conditions](#negate-a-group-of-conditions) + * [Group conditions to control precedence](#group-conditions-to-control-precedence) + * [Logical operators when querying a static index](#logical-operators-when-querying-a-static-index) + * [Operator precedence and defaults](#operator-precedence-and-defaults) @@ -339,7 +339,7 @@ Without the grouping, the query: `Title = "Sales Representative" and FirstName = "Robert" or FirstName = "Nancy"` is evaluated as: `(Title = "Sales Representative" and FirstName = "Robert") or FirstName = "Nancy"`, -because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](../../../querying/filtering-query-results/use-logical-operators.mdx#operator-precedence-and-defaults)). +because **AND** has higher precedence than **OR** (see [Operator precedence and defaults](#operator-precedence-and-defaults)). This returns a different set of documents than the grouped query. diff --git a/docs/querying/rql/rql-code-assistance.mdx b/docs/querying/rql/rql-code-assistance.mdx index c7fc9aa006..3cd4cfac84 100644 --- a/docs/querying/rql/rql-code-assistance.mdx +++ b/docs/querying/rql/rql-code-assistance.mdx @@ -34,8 +34,8 @@ import ContentFrame from "@site/src/components/ContentFrame"; --- * In this article: - * [Auto-completion](../../querying/rql/rql-code-assistance.mdx#auto-completion) - * [Syntax verification](../../querying/rql/rql-code-assistance.mdx#syntax-verification) + * [Auto-completion](#auto-completion) + * [Syntax verification](#syntax-verification) diff --git a/docs/querying/rql/what-is-rql.mdx b/docs/querying/rql/what-is-rql.mdx index 2f114c4c84..97c1f40f0f 100644 --- a/docs/querying/rql/what-is-rql.mdx +++ b/docs/querying/rql/what-is-rql.mdx @@ -37,19 +37,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; --- * In this article: - * [The query pipeline](../../querying/rql/what-is-rql.mdx#the-query-pipeline) - * [RQL keywords and methods](../../querying/rql/what-is-rql.mdx#rql-keywords-and-methods) - * [`declare`](../../querying/rql/what-is-rql.mdx#declare) - * [`from`](../../querying/rql/what-is-rql.mdx#from) - * [`where`](../../querying/rql/what-is-rql.mdx#where) - * [`group by`](../../querying/rql/what-is-rql.mdx#group-by) - * [`include`](../../querying/rql/what-is-rql.mdx#include) - * [`order by`](../../querying/rql/what-is-rql.mdx#order-by) - * [`select`](../../querying/rql/what-is-rql.mdx#select) - * [`load`](../../querying/rql/what-is-rql.mdx#load) - * [`limit`](../../querying/rql/what-is-rql.mdx#limit) - * [`update`](../../querying/rql/what-is-rql.mdx#update) - * [RQL comments](../../querying/rql/what-is-rql.mdx#rql-comments) + * [The query pipeline](#the-query-pipeline) + * [RQL keywords and methods](#rql-keywords-and-methods) + * [`declare`](#declare) + * [`from`](#from) + * [`where`](#where) + * [`group by`](#group-by) + * [`include`](#include) + * [`order by`](#order-by) + * [`select`](#select) + * [`load`](#load) + * [`limit`](#limit) + * [`update`](#update) + * [RQL comments](#rql-comments) @@ -57,7 +57,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; The query pipeline in RavenDB includes the following main stages: -1. **Detect query source** ([`from`](../../querying/rql/what-is-rql.mdx#from)) +1. **Detect query source** ([`from`](#from)) * Based on your query, RavenDB will determine the appropriate data source from which to retrieve results. * The following options are available: @@ -67,23 +67,23 @@ The query pipeline in RavenDB includes the following main stages: * Note: all queries in RavenDB use an index to provide results, even when you don't specify one. Learn more about these **query scenarios** in this [Query Overview](../../querying/overview.mdx#queries-always-provide-results-using-an-index). -2. **Filter the data** ([`where`](../../querying/rql/what-is-rql.mdx#where)) +2. **Filter the data** ([`where`](#where)) * The index is scanned for records that match the query predicate. -3. **Include related documents** ([`include`](../../querying/rql/what-is-rql.mdx#include)) +3. **Include related documents** ([`include`](#include)) * [Related documents](../../client-api/how-to/handle-document-relationships.mdx#includes) that are included in the query will be retrieved and returned to the client along with the resulting matching documents, reducing the need to do another network round trip to the database when accessing the included documents. -4. **Sort results** ([`order by`](../../querying/rql/what-is-rql.mdx#order-by)) +4. **Sort results** ([`order by`](#order-by)) * Query results can be sorted. For example, you can order by a field value, by the resulting documents' score, by random ordering, etc. -5. **Limit results** ([`limit`](../../querying/rql/what-is-rql.mdx#limit)) +5. **Limit results** ([`limit`](#limit)) * You can specify the number of results you want to get back from the query and the number of results you want to skip. -6. **Project results** ([`select`](../../querying/rql/what-is-rql.mdx#select)) +6. **Project results** ([`select`](#select)) * [Projections](../../indexes/querying/projections.mdx) are specified when you need to retrieve only specific document fields, instead of the whole full document. This reduces the amount of data sent over the network and is useful when only partial data is needed. When projections are Not defined on the query - then the full document content is retrieved from the document storage. @@ -92,7 +92,7 @@ The query pipeline in RavenDB includes the following main stages: This means that the projection doesn't apply to all the documents in the database, only to the results that are actually returned. - * Data can be loaded ([`load`](../../querying/rql/what-is-rql.mdx#load)) from related documents to be used in the projected fields. + * Data can be loaded ([`load`](#load)) from related documents to be used in the projected fields. * For each record, the server extracts the requested field: If a field is stored in the index - the server will fetch it from the index. @@ -106,12 +106,12 @@ The query pipeline in RavenDB includes the following main stages: The following keywords and methods are available in RQL: -- [DECLARE](../../querying/rql/what-is-rql.mdx#declare) -- [FROM](../../querying/rql/what-is-rql.mdx#from) - - [index](../../querying/rql/what-is-rql.mdx#query-an-index--from-index-index-name) -- [GROUP BY](../../querying/rql/what-is-rql.mdx#group-by) +- [DECLARE](#declare) +- [FROM](#from) + - [index](#query-an-index--from-index-index-name) +- [GROUP BY](#group-by) - [array()](../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-values) -- [WHERE](../../querying/rql/what-is-rql.mdx#where) +- [WHERE](#where) - id() - [search()](../../client-api/session/querying/text-search/full-text-search.mdx) - cmpxchg() @@ -130,7 +130,7 @@ The following keywords and methods are available in RQL: - [moreLikeThis()](../../client-api/session/querying/how-to-use-morelikethis.mdx) - [vector.search()](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx) - [when()](../../querying/filtering-query-results/conditional-filtering.mdx) -- [ORDER BY](../../querying/rql/what-is-rql.mdx#order-by) +- [ORDER BY](#order-by) - [ASC | ASCENDING](../../querying/sorting-query-results/sort-query-results.mdx) - [DESC | DESCENDING](../../querying/sorting-query-results/sort-query-results.mdx) - [AS](../../querying/sorting-query-results/sort-query-results.mdx) @@ -142,7 +142,7 @@ The following keywords and methods are available in RQL: - [random()](../../querying/sorting-query-results/sort-query-results.mdx#order-by-random) - [score()](../../querying/sorting-query-results/sort-query-results.mdx#order-by-score) - [spatial.distance()](../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) -- [SELECT](../../querying/rql/what-is-rql.mdx#select) +- [SELECT](#select) - DISTINCT - key() - sum() @@ -150,10 +150,10 @@ The following keywords and methods are available in RQL: - [facet()](../../indexes/querying/faceted-search.mdx) - [timeseries()](../../document-extensions/timeseries/querying/overview-and-syntax.mdx#syntax) - [counter()](../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) -- [LOAD](../../querying/rql/what-is-rql.mdx#load) -- [LIMIT](../../querying/rql/what-is-rql.mdx#limit) -- [UPDATE](../../querying/rql/what-is-rql.mdx#update) -- [INCLUDE](../../querying/rql/what-is-rql.mdx#include) +- [LOAD](#load) +- [LIMIT](#limit) +- [UPDATE](#update) +- [INCLUDE](#include) With the following operators: diff --git a/docs/querying/sorting-query-results/content/_sort-query-results-csharp.mdx b/docs/querying/sorting-query-results/content/_sort-query-results-csharp.mdx index 6d4ee3a16d..a4db95e0ca 100644 --- a/docs/querying/sorting-query-results/content/_sort-query-results-csharp.mdx +++ b/docs/querying/sorting-query-results/content/_sort-query-results-csharp.mdx @@ -16,30 +16,30 @@ import Panel from '@site/src/components/Panel'; * Sorting is applied by the server after the query filtering stage. Filtering is recommended, as it reduces the number of results RavenDB needs to sort when querying a large dataset. -* Multiple sorting operations can be [chained](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). +* Multiple sorting operations can be [chained](#chain-ordering). * All sorting capabilities available for **dynamic queries** can also be used when querying a **static-index**. The same syntax used with dynamic queries also applies when querying indexes. * In this article: - * [Order by field value](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value) - * [Order by field value - dynamic query](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---dynamic-query) - * [Order by field value - querying a static-index ](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---querying-a-static-index) - * [Ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#ordering-type) - * [Control position of null values](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) - * [Order by searchable fields](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-searchable-fields) - * [Order by score](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../querying/sorting-query-results/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Order by metadata](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-metadata) - * [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../querying/sorting-query-results/sort-query-results.mdx#custom-sorters) - * [Performance notes](../../../querying/sorting-query-results/sort-query-results.mdx#performance-notes) - * [Syntax](../../../querying/sorting-query-results/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by field value - dynamic query](#order-by-field-value---dynamic-query) + * [Order by field value - querying a static-index ](#order-by-field-value---querying-a-static-index) + * [Ordering type](#ordering-type) + * [Control position of null values](#control-position-of-null-values) + * [Order by searchable fields](#order-by-searchable-fields) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Order by metadata](#order-by-metadata) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Performance notes](#performance-notes) + * [Syntax](#syntax) @@ -204,7 +204,7 @@ order by UnitsInStock as long desc * E.g. in the above example, ordering by `x => x.UnitsInStock` will result in `OrderingType.Long` because that property data type is an integer. -* Different ordering can be forced - see [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. @@ -221,7 +221,7 @@ order by UnitsInStock as long desc * The requested null placement is a per-query, per-sort-clause setting. When using multiple `order by` clauses, each clause can define its own null placement. - Learn more in [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). + Learn more in [Chain ordering](#chain-ordering). * Use `NullsOrdering.First` to place documents with `null` values **before** documents with non-null values. Use `NullsOrdering.Last` to place documents with `null` values **after** documents with non-null values. @@ -1124,7 +1124,7 @@ order by QuantityPerUnit as alphanumeric * This is achieved by using the `ThenBy` (`ThenByDescending`) and `ThenByScore` (`ThenByScoreDescending`) methods. -* When ordering by a field, each ordering clause can also define its own [null placement](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) (Corax only). +* When ordering by a field, each ordering clause can also define its own [null placement](#control-position-of-null-values) (Corax only). If no null placement is specified for an ordering clause, RavenDB uses the behavior configured by [Indexing.Querying.Corax.NullsSortMode](../../../server/configuration/indexing-configuration.mdx#indexingqueryingcoraxnullssortmode) for that clause. * **When using the Lucene search engine** - diff --git a/docs/querying/sorting-query-results/content/_sort-query-results-java.mdx b/docs/querying/sorting-query-results/content/_sort-query-results-java.mdx index f4f6e28ab8..5563eb2934 100644 --- a/docs/querying/sorting-query-results/content/_sort-query-results-java.mdx +++ b/docs/querying/sorting-query-results/content/_sort-query-results-java.mdx @@ -16,30 +16,30 @@ import Panel from '@site/src/components/Panel'; * Sorting is applied by the server after the query filtering stage. Filtering is recommended, as it reduces the number of results RavenDB needs to sort when querying a large dataset. -* Multiple sorting operations can be [chained](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). +* Multiple sorting operations can be [chained](#chain-ordering). * All sorting capabilities available for **dynamic queries** can also be used when querying a **static-index**. The same syntax used with dynamic queries also applies when querying indexes. * In this article: - * [Order by field value](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value) - * [Order by field value - dynamic query](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---dynamic-query) - * [Order by field value - querying a static-index ](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---querying-a-static-index) - * [Ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#ordering-type) - * [Control position of null values](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) - * [Order by searchable fields](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-searchable-fields) - * [Order by score](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../querying/sorting-query-results/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Order by metadata](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-metadata) - * [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../querying/sorting-query-results/sort-query-results.mdx#custom-sorters) - * [Performance notes](../../../querying/sorting-query-results/sort-query-results.mdx#performance-notes) - * [Syntax](../../../querying/sorting-query-results/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by field value - dynamic query](#order-by-field-value---dynamic-query) + * [Order by field value - querying a static-index ](#order-by-field-value---querying-a-static-index) + * [Ordering type](#ordering-type) + * [Control position of null values](#control-position-of-null-values) + * [Order by searchable fields](#order-by-searchable-fields) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Order by metadata](#order-by-metadata) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Performance notes](#performance-notes) + * [Syntax](#syntax) @@ -131,7 +131,7 @@ order by UnitsInStock as long desc * In the above example, the ordering type was set to `OrderingType.LONG`. -* Different ordering can be forced - see [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. @@ -148,7 +148,7 @@ order by UnitsInStock as long desc * The requested null placement is a per-query, per-sort-clause setting. When using multiple `order by` clauses, each clause can define its own null placement. - Learn more in [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). + Learn more in [Chain ordering](#chain-ordering). * Use `NullsOrdering.FIRST` to place documents with `null` values **before** documents with non-null values. Use `NullsOrdering.LAST` to place documents with `null` values **after** documents with non-null values. @@ -740,7 +740,7 @@ order by QuantityPerUnit as alphaNumeric * This is achieved by calling the `orderBy` (`orderByDescending`) and `orderByScore` (`orderByScoreDescending`) methods multiple times. -* When ordering by a field, each ordering clause can also define its own [null placement](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) (Corax only). +* When ordering by a field, each ordering clause can also define its own [null placement](#control-position-of-null-values) (Corax only). If no null placement is specified for an ordering clause, RavenDB uses the behavior configured by [Indexing.Querying.Corax.NullsSortMode](../../../server/configuration/indexing-configuration.mdx#indexingqueryingcoraxnullssortmode) for that clause. * **When using the Lucene search engine** - diff --git a/docs/querying/sorting-query-results/content/_sort-query-results-nodejs.mdx b/docs/querying/sorting-query-results/content/_sort-query-results-nodejs.mdx index c64d5fadf9..c39a898f85 100644 --- a/docs/querying/sorting-query-results/content/_sort-query-results-nodejs.mdx +++ b/docs/querying/sorting-query-results/content/_sort-query-results-nodejs.mdx @@ -16,30 +16,30 @@ import Panel from '@site/src/components/Panel'; * Sorting is applied by the server after the query filtering stage. Filtering is recommended, as it reduces the number of results RavenDB needs to sort when querying a large dataset. -* Multiple sorting operations can be [chained](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). +* Multiple sorting operations can be [chained](#chain-ordering). * All sorting capabilities available for **dynamic queries** can also be used when querying a **static-index**. The same syntax used with dynamic queries also applies when querying indexes. * In this article: - * [Order by field value](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value) - * [Order by field value - dynamic query](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---dynamic-query) - * [Order by field value - querying a static-index ](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---querying-a-static-index) - * [Ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#ordering-type) - * [Control position of null values](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) - * [Order by searchable fields](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-searchable-fields) - * [Order by score](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../querying/sorting-query-results/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Order by metadata](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-metadata) - * [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../querying/sorting-query-results/sort-query-results.mdx#custom-sorters) - * [Performance notes](../../../querying/sorting-query-results/sort-query-results.mdx#performance-notes) - * [Syntax](../../../querying/sorting-query-results/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by field value - dynamic query](#order-by-field-value---dynamic-query) + * [Order by field value - querying a static-index ](#order-by-field-value---querying-a-static-index) + * [Ordering type](#ordering-type) + * [Control position of null values](#control-position-of-null-values) + * [Order by searchable fields](#order-by-searchable-fields) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Order by metadata](#order-by-metadata) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Performance notes](#performance-notes) + * [Syntax](#syntax) @@ -136,7 +136,7 @@ order by unitsInStock as long desc * In the above example, the ordering type was set to `Long`. -* Different ordering can be forced - see [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. @@ -153,7 +153,7 @@ order by unitsInStock as long desc * The requested null placement is a per-query, per-sort-clause setting. When using multiple `order by` clauses, each clause can define its own null placement. - Learn more in [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). + Learn more in [Chain ordering](#chain-ordering). * Pass `"First"` to place documents with `null` values **before** documents with non-null values. Pass `"Last"` to place documents with `null` values **after** documents with non-null values. diff --git a/docs/querying/sorting-query-results/content/_sort-query-results-php.mdx b/docs/querying/sorting-query-results/content/_sort-query-results-php.mdx index 74a2aaab49..83bb714766 100644 --- a/docs/querying/sorting-query-results/content/_sort-query-results-php.mdx +++ b/docs/querying/sorting-query-results/content/_sort-query-results-php.mdx @@ -16,27 +16,27 @@ import Panel from '@site/src/components/Panel'; * Sorting is applied by the server after the query filtering stage. Filtering is recommended, as it reduces the number of results RavenDB needs to sort when querying a large dataset. -* Multiple sorting operations can be [chained](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). +* Multiple sorting operations can be [chained](#chain-ordering). * All sorting capabilities available for **dynamic queries** can also be used when querying a **static-index**. The same syntax used with dynamic queries also applies when querying indexes. * In this article: - * [Order by field value](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value) - * [Ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#ordering-type) - * [Order by searchable fields](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-searchable-fields) - * [Order by score](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../querying/sorting-query-results/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Order by metadata](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-metadata) - * [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../querying/sorting-query-results/sort-query-results.mdx#custom-sorters) - * [Performance notes](../../../querying/sorting-query-results/sort-query-results.mdx#performance-notes) - * [Syntax](../../../querying/sorting-query-results/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Ordering type](#ordering-type) + * [Order by searchable fields](#order-by-searchable-fields) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Order by metadata](#order-by-metadata) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Performance notes](#performance-notes) + * [Syntax](#syntax) @@ -190,7 +190,7 @@ order by UnitsInStock as long desc * E.g. in the above example, ordering by `UnitsInStock` will result in `OrderingType::long` because this property's data type is integer. -* Different ordering can be forced - see [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/docs/querying/sorting-query-results/content/_sort-query-results-python.mdx b/docs/querying/sorting-query-results/content/_sort-query-results-python.mdx index 92ec1c55c2..6f3d926511 100644 --- a/docs/querying/sorting-query-results/content/_sort-query-results-python.mdx +++ b/docs/querying/sorting-query-results/content/_sort-query-results-python.mdx @@ -15,30 +15,30 @@ import Panel from '@site/src/components/Panel'; * Sorting is applied by the server after the query filtering stage. Filtering is recommended, as it reduces the number of results RavenDB needs to sort when querying a large dataset. -* Multiple sorting operations can be [chained](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). +* Multiple sorting operations can be [chained](#chain-ordering). * All sorting capabilities available for **dynamic queries** can also be used when querying a **static-index**. The same syntax used with dynamic queries also applies when querying indexes. * In this article: - * [Order by field value](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value) - * [Order by field value - dynamic query](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---dynamic-query) - * [Order by field value - querying a static-index ](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-field-value---querying-a-static-index) - * [Ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#ordering-type) - * [Control position of null values](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) - * [Order by searchable fields](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-searchable-fields) - * [Order by score](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../querying/sorting-query-results/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Order by metadata](../../../querying/sorting-query-results/sort-query-results.mdx#order-by-metadata) - * [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../querying/sorting-query-results/sort-query-results.mdx#custom-sorters) - * [Performance notes](../../../querying/sorting-query-results/sort-query-results.mdx#performance-notes) - * [Syntax](../../../querying/sorting-query-results/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by field value - dynamic query](#order-by-field-value---dynamic-query) + * [Order by field value - querying a static-index ](#order-by-field-value---querying-a-static-index) + * [Ordering type](#ordering-type) + * [Control position of null values](#control-position-of-null-values) + * [Order by searchable fields](#order-by-searchable-fields) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Order by metadata](#order-by-metadata) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Performance notes](#performance-notes) + * [Syntax](#syntax) @@ -142,7 +142,7 @@ order by UnitsInStock as long desc * E.g. in the above example, ordering by `"UnitsInStock"` will result in `OrderingType.LONG` because that property data type is an integer. -* Different ordering can be forced - see [Force ordering type](../../../querying/sorting-query-results/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. @@ -159,7 +159,7 @@ order by UnitsInStock as long desc * The requested null placement is a per-query, per-sort-clause setting. When using multiple `order by` clauses, each clause can define its own null placement. - Learn more in [Chain ordering](../../../querying/sorting-query-results/sort-query-results.mdx#chain-ordering). + Learn more in [Chain ordering](#chain-ordering). * Use `NullsOrdering.FIRST` to place documents with `null` values **before** documents with non-null values. Use `NullsOrdering.LAST` to place documents with `null` values **after** documents with non-null values. @@ -725,7 +725,7 @@ order by QuantityPerUnit as alphanumeric * It is possible to chain multiple orderings in the query. Any combination of secondary sorting is possible as the fields are indexed independently of one another. -* When ordering by a field, each ordering clause can also define its own [null placement](../../../querying/sorting-query-results/sort-query-results.mdx#control-position-of-null-values) (Corax only). +* When ordering by a field, each ordering clause can also define its own [null placement](#control-position-of-null-values) (Corax only). If no null placement is specified for an ordering clause, RavenDB uses the behavior configured by [Indexing.Querying.Corax.NullsSortMode](../../../server/configuration/indexing-configuration.mdx#indexingqueryingcoraxnullssortmode) for that clause. * **When using the Lucene search engine** - diff --git a/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-csharp.mdx b/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-csharp.mdx index 36e197abbb..e05e92a84d 100644 --- a/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-csharp.mdx +++ b/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-csharp.mdx @@ -20,11 +20,11 @@ import Panel from '@site/src/components/Panel'; To learn how to write a custom sorter, see: [How to write a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#how-to-write-a-custom-sorter). * In this article: - * [Add database-level custom sorter - via the Client API](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-database-level-custom-sorter-via-the-client-api) - * [Add database-level custom sorter - via Studio](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-database-level-custom-sorter-via-studio) - * [Delete database-level custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#delete-database-level-custom-sorter) - * [Test custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#test-custom-sorter) - * [Syntax](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#syntax) + * [Add database-level custom sorter - via the Client API](#add-database-level-custom-sorter-via-the-client-api) + * [Add database-level custom sorter - via Studio](#add-database-level-custom-sorter-via-studio) + * [Delete database-level custom sorter](#delete-database-level-custom-sorter) + * [Test custom sorter](#test-custom-sorter) + * [Syntax](#syntax) @@ -156,16 +156,16 @@ order by custom(UnitsInStock, "MyCustomSorter") ### The custom sorters view The custom sorters view lists all custom sorters that were uploaded from Studio and from the -[Client API](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-database-level-custom-sorter-via-the-client-api). +[Client API](#add-database-level-custom-sorter-via-the-client-api). ![Database-level custom sorter view](../assets/custom-sorter-db-level-1.png) 1. Go to **Settings > Custom Sorters**. 2. Click to add a new database-level custom sorter. - See [Add a custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-a-custom-sorter) below. + See [Add a custom sorter](#add-a-custom-sorter) below. 3. The custom sorters deployed for this **database** are listed here. 4. Click to test this custom sorter. - Learn more in [Test custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#test-custom-sorter) below. + Learn more in [Test custom sorter](#test-custom-sorter) below. 5. Click to edit this custom sorter. 6. Click to delete this custom sorter. 7. The **server-wide** custom sorters are listed here. @@ -190,7 +190,7 @@ The custom sorters view lists all custom sorters that were uploaded from Studio -In addition to deleting a custom sorter via [The custom sorters view](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#the-custom-sorters-view) in Studio, +In addition to deleting a custom sorter via [The custom sorters view](#the-custom-sorters-view) in Studio, you can ues `DeleteSorterOperation` to delete a database-level custom sorter. Once removed, the sorter will no longer be available for ordering query results in the associated database. @@ -220,7 +220,7 @@ await store.Maintenance.SendAsync(deleteSorterOp); You can test a custom sorter from Studio before using it in a query, to verify that it works as expected. -Click the test button from the [Custom sorters view](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#the-custom-sorters-view) to open the test panel: +Click the test button from the [Custom sorters view](#the-custom-sorters-view) to open the test panel: ![Test custom sorter](../assets/custom-sorter-db-level-3.png) @@ -238,7 +238,7 @@ Click the test button from the [Custom sorters view](../../../../querying/sortin Displays diagnostic messages collected while the custom sorter is executed. Studio runs the test query with diagnostics enabled, so you can verify that the sorter was invoked and inspect its execution flow. Studio records comparator execution details during the test, such as calls to `Compare`, `SetBottom`, and `Copy`. - You can also add your own messages to this list - see [Adding your own diagnostic messages](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#adding-your-own-diagnostic-messages). + You can also add your own messages to this list - see [Adding your own diagnostic messages](#adding-your-own-diagnostic-messages). 5. Click to close the test panel. diff --git a/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-nodejs.mdx b/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-nodejs.mdx index ff0d2019d6..b1fc07c1b4 100644 --- a/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-nodejs.mdx +++ b/docs/querying/sorting-query-results/custom-sorters/content/_database-level-custom-sorters-nodejs.mdx @@ -20,11 +20,11 @@ import Panel from '@site/src/components/Panel'; To learn how to write a custom sorter, see: [How to write a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#how-to-write-a-custom-sorter). * In this article: - * [Add database-level custom sorter - via the Client API](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-database-level-custom-sorter-via-the-client-api) - * [Add database-level custom sorter - via Studio](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-database-level-custom-sorter-via-studio) - * [Delete database-level custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#delete-database-level-custom-sorter) - * [Test custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#test-custom-sorter) - * [Syntax](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#syntax) + * [Add database-level custom sorter - via the Client API](#add-database-level-custom-sorter-via-the-client-api) + * [Add database-level custom sorter - via Studio](#add-database-level-custom-sorter-via-studio) + * [Delete database-level custom sorter](#delete-database-level-custom-sorter) + * [Test custom sorter](#test-custom-sorter) + * [Syntax](#syntax) @@ -91,16 +91,16 @@ order by custom(UnitsInStock, "MyCustomSorter") ### The custom sorters view: The custom sorters view lists all custom sorters that were uploaded from Studio and from the -[Client API](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-database-level-custom-sorter-via-the-client-api). +[Client API](#add-database-level-custom-sorter-via-the-client-api). ![Database-level custom sorter view](../assets/custom-sorter-db-level-1.png) 1. Go to **Settings > Custom Sorters**. 2. Click to add a new database-level custom sorter. - See [Add a custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#add-a-custom-sorter) below. + See [Add a custom sorter](#add-a-custom-sorter) below. 3. The custom sorters deployed for this **database** are listed here. 4. Click to test this custom sorter. - Learn more in [Test custom sorter](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#test-custom-sorter) below. + Learn more in [Test custom sorter](#test-custom-sorter) below. 5. Click to edit this custom sorter. 6. Click to delete this custom sorter. 7. The **server-wide** custom sorters are listed here. @@ -125,7 +125,7 @@ The custom sorters view lists all custom sorters that were uploaded from Studio -In addition to deleting a custom sorter via [The custom sorters view](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#the-custom-sorters-view) in the Studio, +In addition to deleting a custom sorter via [The custom sorters view](#the-custom-sorters-view) in the Studio, you can ues `DeleteSorterOperation` to delete a database-level custom sorter. Once removed, the sorter will no longer be available for ordering query results in the associated database. @@ -144,7 +144,7 @@ await store.maintenance.send(deleteSorterOp); You can test a custom sorter from Studio before using it in a query, to verify that it works as expected. -Click the test button from the [Custom sorters view](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#the-custom-sorters-view) to open the test panel: +Click the test button from the [Custom sorters view](#the-custom-sorters-view) to open the test panel: ![Test custom sorter](../assets/custom-sorter-db-level-3.png) @@ -162,7 +162,7 @@ Click the test button from the [Custom sorters view](../../../../querying/sortin Displays diagnostic messages collected while the custom sorter is executed. Studio runs the test query with diagnostics enabled, so you can verify that the sorter was invoked and inspect its execution flow. Studio records comparator execution details during the test, such as calls to `Compare`, `SetBottom`, and `Copy`. - You can also add your own messages to this list - see [Adding your own diagnostic messages](../../../../querying/sorting-query-results/custom-sorters/database-level-custom-sorters.mdx#adding-your-own-diagnostic-messages). + You can also add your own messages to this list - see [Adding your own diagnostic messages](#adding-your-own-diagnostic-messages). 5. Click to close the test panel. diff --git a/docs/querying/sorting-query-results/custom-sorters/content/_overview-csharp.mdx b/docs/querying/sorting-query-results/custom-sorters/content/_overview-csharp.mdx index bb2a0ca071..ed0a0713ac 100644 --- a/docs/querying/sorting-query-results/custom-sorters/content/_overview-csharp.mdx +++ b/docs/querying/sorting-query-results/custom-sorters/content/_overview-csharp.mdx @@ -24,9 +24,9 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Querying with a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#querying-with-a-custom-sorter) - * [How to write a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#how-to-write-a-custom-sorter) - * [Testing a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#testing-a-custom-sorter) + * [Querying with a custom sorter](#querying-with-a-custom-sorter) + * [How to write a custom sorter](#how-to-write-a-custom-sorter) + * [Testing a custom sorter](#testing-a-custom-sorter) diff --git a/docs/querying/sorting-query-results/custom-sorters/content/_overview-nodejs.mdx b/docs/querying/sorting-query-results/custom-sorters/content/_overview-nodejs.mdx index 41d8399f5d..9ec472dbde 100644 --- a/docs/querying/sorting-query-results/custom-sorters/content/_overview-nodejs.mdx +++ b/docs/querying/sorting-query-results/custom-sorters/content/_overview-nodejs.mdx @@ -24,9 +24,9 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Querying with a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#querying-with-a-custom-sorter) - * [How to write a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#how-to-write-a-custom-sorter) - * [Testing a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#testing-a-custom-sorter) + * [Querying with a custom sorter](#querying-with-a-custom-sorter) + * [How to write a custom sorter](#how-to-write-a-custom-sorter) + * [Testing a custom sorter](#testing-a-custom-sorter) diff --git a/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-csharp.mdx b/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-csharp.mdx index 44561253c4..f27a09f795 100644 --- a/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-csharp.mdx +++ b/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-csharp.mdx @@ -17,11 +17,11 @@ import Panel from '@site/src/components/Panel'; To learn how to write a custom sorter, see: [How to write a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#how-to-write-a-custom-sorter). * In this article: - * [Add server-wide custom sorter - via the Client API](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#add-server-wide-custom-sorter-via-the-client-api) - * [Add server-wide custom sorter - via Studio](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#add-server-wide-custom-sorter-via-studio) - * [Delete server-wide custom sorter](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#delete-server-wide-custom-sorter) - * [Test custom sorter](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#test-custom-sorter) - * [Syntax](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#syntax) + * [Add server-wide custom sorter - via the Client API](#add-server-wide-custom-sorter-via-the-client-api) + * [Add server-wide custom sorter - via Studio](#add-server-wide-custom-sorter-via-studio) + * [Delete server-wide custom sorter](#delete-server-wide-custom-sorter) + * [Test custom sorter](#test-custom-sorter) + * [Syntax](#syntax) @@ -157,7 +157,7 @@ order by custom(UnitsInStock, "MyServerWideCustomSorter") 1. Go to **Manage Server > Server-Wide Sorters**. 2. Click to add a new server-wide custom sorter. - See [Add a server-wide custom sorter](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#add-a-server-wide-custom-sorter) below. + See [Add a server-wide custom sorter](#add-a-server-wide-custom-sorter) below. 3. The **server-wide** custom sorters are listed here. 4. Click to edit this server-wide custom sorter. 5. Click to delete this server-wide custom sorter. @@ -180,7 +180,7 @@ order by custom(UnitsInStock, "MyServerWideCustomSorter") -In addition to deleting a server-wide custom sorter via [The server-wide custom sorters view](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#the-server-wide-custom-sorters-view) in Studio, +In addition to deleting a server-wide custom sorter via [The server-wide custom sorters view](#the-server-wide-custom-sorters-view) in Studio, you can use `DeleteServerWideSorterOperation` to delete a server-wide custom sorter. Once removed, the sorter will no longer be available for ordering query results in any database in the cluster. diff --git a/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-nodejs.mdx b/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-nodejs.mdx index 2261d406a9..dd509942f8 100644 --- a/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-nodejs.mdx +++ b/docs/querying/sorting-query-results/custom-sorters/content/_server-wide-custom-sorters-nodejs.mdx @@ -17,11 +17,11 @@ import Panel from '@site/src/components/Panel'; To learn how to write a custom sorter, see: [How to write a custom sorter](../../../../querying/sorting-query-results/custom-sorters/overview.mdx#how-to-write-a-custom-sorter). * In this article: - * [Add server-wide custom sorter - via the Client API](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#add-server-wide-custom-sorter-via-the-client-api) - * [Add server-wide custom sorter - via Studio](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#add-server-wide-custom-sorter-via-studio) - * [Delete server-wide custom sorter](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#delete-server-wide-custom-sorter) - * [Test custom sorter](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#test-custom-sorter) - * [Syntax](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#syntax) + * [Add server-wide custom sorter - via the Client API](#add-server-wide-custom-sorter-via-the-client-api) + * [Add server-wide custom sorter - via Studio](#add-server-wide-custom-sorter-via-studio) + * [Delete server-wide custom sorter](#delete-server-wide-custom-sorter) + * [Test custom sorter](#test-custom-sorter) + * [Syntax](#syntax) @@ -92,7 +92,7 @@ order by custom(UnitsInStock, "MyServerWideCustomSorter") 1. Go to **Manage Server > Server-Wide Sorters**. 2. Click to add a new server-wide custom sorter. - See [Add a server-wide custom sorter](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#add-a-server-wide-custom-sorter) below. + See [Add a server-wide custom sorter](#add-a-server-wide-custom-sorter) below. 3. The **server-wide** custom sorters are listed here. 4. Click to edit this server-wide custom sorter. 5. Click to delete this server-wide custom sorter. @@ -115,7 +115,7 @@ order by custom(UnitsInStock, "MyServerWideCustomSorter") -In addition to deleting a server-wide custom sorter via [The server-wide custom sorters view](../../../../querying/sorting-query-results/custom-sorters/server-wide-custom-sorters.mdx#the-server-wide-custom-sorters-view) in Studio, +In addition to deleting a server-wide custom sorter via [The server-wide custom sorters view](#the-server-wide-custom-sorters-view) in Studio, you can use `DeleteServerWideSorterOperation` to delete a server-wide custom sorter. Once removed, the sorter will no longer be available for ordering query results in any database in the cluster. diff --git a/docs/server/administration/cli.mdx b/docs/server/administration/cli.mdx index 66a3a03dcf..862c8d1dd4 100644 --- a/docs/server/administration/cli.mdx +++ b/docs/server/administration/cli.mdx @@ -22,26 +22,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page lists available CLI commands and explains their usage. * In this page: - * [`rvn`](../../server/administration/cli.mdx#rvn) - * [`info`](../../server/administration/cli.mdx#info) - * [`stats`](../../server/administration/cli.mdx#stats) - * [`log`](../../server/administration/cli.mdx#log) - * [`gc`](../../server/administration/cli.mdx#gc) + * [`rvn`](#rvn) + * [`info`](#info) + * [`stats`](#stats) + * [`log`](#log) + * [`gc`](#gc) * [`shutdown | q`](../../server/administration/cli.mdx#shutdown-|-q) * [`restartServer`, `resetServer`](../../server/administration/cli.mdx#restartserver,-resetserver) - * [`script`](../../server/administration/cli.mdx#script) - * [`generateClientCert`](../../server/administration/cli.mdx#generateclientcert) - * [`trustServerCert`](../../server/administration/cli.mdx#trustservercert) - * [`trustClientCert`](../../server/administration/cli.mdx#trustclientcert) - * [`replaceClusterCert`](../../server/administration/cli.mdx#replaceclustercert) - * [`triggerCertificateRefresh`](../../server/administration/cli.mdx#triggercertificaterefresh) - * [`clear`](../../server/administration/cli.mdx#clear) - * [`prompt`](../../server/administration/cli.mdx#prompt) - * [`logout`](../../server/administration/cli.mdx#logout) - * [`logo`](../../server/administration/cli.mdx#logo) - * [`help`](../../server/administration/cli.mdx#help) - * [`lowMem`](../../server/administration/cli.mdx#lowmem) - * [`timer`](../../server/administration/cli.mdx#timer) + * [`script`](#script) + * [`generateClientCert`](#generateclientcert) + * [`trustServerCert`](#trustservercert) + * [`trustClientCert`](#trustclientcert) + * [`replaceClusterCert`](#replaceclustercert) + * [`triggerCertificateRefresh`](#triggercertificaterefresh) + * [`clear`](#clear) + * [`prompt`](#prompt) + * [`logout`](#logout) + * [`logo`](#logo) + * [`help`](#help) + * [`lowMem`](#lowmem) + * [`timer`](#timer) ## `rvn` diff --git a/docs/server/administration/monitoring/mib-generation.mdx b/docs/server/administration/monitoring/mib-generation.mdx index de5270e58f..c1a786faf7 100644 --- a/docs/server/administration/monitoring/mib-generation.mdx +++ b/docs/server/administration/monitoring/mib-generation.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The created MIB can be used by monitoring tools to extract RavenDB metrics via SNMP. * In this page: - * [Generating a MIB](../../../server/administration/monitoring/mib-generation.mdx#generating-a-mib) - * [MIB generation endpoint](../../../server/administration/monitoring/mib-generation.mdx#mib-generation-endpoint) - * [Fine-tune the OIDs list](../../../server/administration/monitoring/mib-generation.mdx#fine-tune-the-oids-list) + * [Generating a MIB](#generating-a-mib) + * [MIB generation endpoint](#mib-generation-endpoint) + * [Fine-tune the OIDs list](#fine-tune-the-oids-list) ## Generating a MIB diff --git a/docs/server/administration/monitoring/open-telemetry.mdx b/docs/server/administration/monitoring/open-telemetry.mdx index 9e78414d0b..2439a761f8 100644 --- a/docs/server/administration/monitoring/open-telemetry.mdx +++ b/docs/server/administration/monitoring/open-telemetry.mdx @@ -23,22 +23,22 @@ import LanguageContent from "@site/src/components/LanguageContent"; allowing seamless data collection and analysis by an OpenTelemetry retriever. * In addition, an OpenTelemetry collector can retrieve data from RavenDB's [Prometheus](../../../server/administration/monitoring/prometheus.mdx) endpoint. - Learn more [below](../../../server/administration/monitoring/open-telemetry.mdx#retrieve-data-from-prometheus). + Learn more [below](#retrieve-data-from-prometheus). * OpenTelemetry support is provided for RavenDB instances both on-premises and in the cloud. * In this article: - * [Enabling OpenTelemetry in RavenDB](../../../server/administration/monitoring/open-telemetry.mdx#enabling-opentelemetry-in-ravendb) - * [RavenDB OpenTelemetry meters](../../../server/administration/monitoring/open-telemetry.mdx#ravendb-opentelemetry-meters) - * [Server identification in metrics](../../../server/administration/monitoring/open-telemetry.mdx#server-identification-in-metrics) - * [Service name and namespace](../../../server/administration/monitoring/open-telemetry.mdx#service-name-and-namespace) - * [The metric instruments](../../../server/administration/monitoring/open-telemetry.mdx#the-metric-instruments) - * [Metrics export options](../../../server/administration/monitoring/open-telemetry.mdx#metrics-export-options) - * [Console](../../../server/administration/monitoring/open-telemetry.mdx#console) - * [OpenTelemetry Protocol](../../../server/administration/monitoring/open-telemetry.mdx#opentelemetry-protocol) - * [Configuring the OpenTelemetry Collector](../../../server/administration/monitoring/open-telemetry.mdx#configuring-the-opentelemetry-collector) - * [Receive data via OLTP ](../../../server/administration/monitoring/open-telemetry.mdx#receive-data-via-otlp) - * [Retrieve data from Prometheus](../../../server/administration/monitoring/open-telemetry.mdx#retrieve-data-from-prometheus) + * [Enabling OpenTelemetry in RavenDB](#enabling-opentelemetry-in-ravendb) + * [RavenDB OpenTelemetry meters](#ravendb-opentelemetry-meters) + * [Server identification in metrics](#server-identification-in-metrics) + * [Service name and namespace](#service-name-and-namespace) + * [The metric instruments](#the-metric-instruments) + * [Metrics export options](#metrics-export-options) + * [Console](#console) + * [OpenTelemetry Protocol](#opentelemetry-protocol) + * [Configuring the OpenTelemetry Collector](#configuring-the-opentelemetry-collector) + * [Receive data via OLTP ](#receive-data-via-otlp) + * [Retrieve data from Prometheus](#retrieve-data-from-prometheus) @@ -54,7 +54,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## RavenDB OpenTelemetry meters -Each meter listed below groups similar or related [metric instruments](../../../server/administration/monitoring/open-telemetry.mdx#the-metric-instruments). +Each meter listed below groups similar or related [metric instruments](#the-metric-instruments). Each metric instrument observes some metric value. Only the most commonly used meters are enabled by default. @@ -300,7 +300,7 @@ RavenDB offers two options for exporting metrics: | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.ExportProcessorType](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolexportprocessortype) | Export processor type | Simple / Batch | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Headers](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolheaders) | Custom headers | string | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Protocol](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolprotocol) | Defines the transport protocol that OpenTelemetry Protocol should use to send data. | gRPC / HttpProtobuf | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](../../../server/administration/monitoring/open-telemetry.mdx#configure-endpoint). | string | +| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](#configure-endpoint). | string | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) | Timeout | int | @@ -308,7 +308,7 @@ RavenDB offers two options for exporting metrics: __Configuring the OpenTelemetry Protocol endpoint__: -The defined endpoint must correspond to the endpoint [configured on the collector](../../../server/administration/monitoring/open-telemetry.mdx#configuring-the-opentelemetry-collector) for receiving metrics data. +The defined endpoint must correspond to the endpoint [configured on the collector](#configuring-the-opentelemetry-collector) for receiving metrics data. The endpoint format should match the transport protocol you are using:
diff --git a/docs/server/administration/monitoring/prometheus.mdx b/docs/server/administration/monitoring/prometheus.mdx index 79b56674dc..94a6d7d3b3 100644 --- a/docs/server/administration/monitoring/prometheus.mdx +++ b/docs/server/administration/monitoring/prometheus.mdx @@ -24,12 +24,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A Prometheus endpoint is provided by RavenDB instances both on-premise and on the cloud. * In this page: - * [Prometheus](../../../server/administration/monitoring/prometheus.mdx#prometheus) - * [RavenDB Prometheus Endpoint](../../../server/administration/monitoring/prometheus.mdx#ravendb-prometheus-endpoint) - * [Omit or Include Selected Metrics](../../../server/administration/monitoring/prometheus.mdx#omit-or-include-selected-metrics) - * [Metrics Provided by the Prometheus Endpoint](../../../server/administration/monitoring/prometheus.mdx#metrics-provided-by-the-prometheus-endpoint) - * [Using the RavenDB Endpoint by a Prometheus Server](../../../server/administration/monitoring/prometheus.mdx#using-the-ravendb-endpoint-by-a-prometheus-server) - * [Fetching Additional RavenDB Information](../../../server/administration/monitoring/prometheus.mdx#fetching-additional-ravendb-information) + * [Prometheus](#prometheus) + * [RavenDB Prometheus Endpoint](#ravendb-prometheus-endpoint) + * [Omit or Include Selected Metrics](#omit-or-include-selected-metrics) + * [Metrics Provided by the Prometheus Endpoint](#metrics-provided-by-the-prometheus-endpoint) + * [Using the RavenDB Endpoint by a Prometheus Server](#using-the-ravendb-endpoint-by-a-prometheus-server) + * [Fetching Additional RavenDB Information](#fetching-additional-ravendb-information) ## Prometheus @@ -51,7 +51,7 @@ E.g. [http://live-test.ravendb.net/admin/monitoring/v1/prometheus](http://live-t * As prometheus handles only numeric values, the endpoint outputs all values as numbers, providing legends that explain what the numbers mean. - Metrics values are also explained in the [table below](../../../server/administration/monitoring/prometheus.mdx#metrics-provided-by-the-prometheus-endpoint). + Metrics values are also explained in the [table below](#metrics-provided-by-the-prometheus-endpoint). ## Omit or Include Selected Metrics diff --git a/docs/server/administration/monitoring/telegraf.mdx b/docs/server/administration/monitoring/telegraf.mdx index fb18eac35f..3fc27952ea 100644 --- a/docs/server/administration/monitoring/telegraf.mdx +++ b/docs/server/administration/monitoring/telegraf.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and displayed as live graphs using [Grafana](https://grafana.com/). * In this page: - * [Telegraf](../../../server/administration/monitoring/telegraf.mdx#telegraf) - * [Monitoring Endpoints](../../../server/administration/monitoring/telegraf.mdx#monitoring-endpoints) - * [JSON Fields Returned by the Endpoints](../../../server/administration/monitoring/telegraf.mdx#json-fields-returned-by-the-endpoints) + * [Telegraf](#telegraf) + * [Monitoring Endpoints](#monitoring-endpoints) + * [JSON Fields Returned by the Endpoints](#json-fields-returned-by-the-endpoints) ## Telegraf diff --git a/docs/server/administration/snmp/setup-zabbix.mdx b/docs/server/administration/snmp/setup-zabbix.mdx index 65365f3cc4..41552fbed0 100644 --- a/docs/server/administration/snmp/setup-zabbix.mdx +++ b/docs/server/administration/snmp/setup-zabbix.mdx @@ -38,16 +38,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; see [Set up Zabbix monitoring for RavenDB Cloud](../../../../guides/zabbix-setup-guide). * In this article: - * [Prerequisites](./setup-zabbix.mdx#prerequisites) - * [Importing the template](./setup-zabbix.mdx#importing-the-template) - * [Creating a host](./setup-zabbix.mdx#creating-a-host) - * [Configuring the SNMP interface](./setup-zabbix.mdx#configuring-the-snmp-interface) - * [Overriding the memory threshold macros](./setup-zabbix.mdx#overriding-the-memory-threshold-macros) - * [Confirming Zabbix is collecting values](./setup-zabbix.mdx#confirming-zabbix-is-collecting-values) - * [Triggers](./setup-zabbix.mdx#triggers) - * [Triggers included with the template](./setup-zabbix.mdx#triggers-included-with-the-template) - * [Adding a custom trigger](./setup-zabbix.mdx#adding-a-custom-trigger) - * [Setting up notifications](./setup-zabbix.mdx#setting-up-notifications) + * [Prerequisites](#prerequisites) + * [Importing the template](#importing-the-template) + * [Creating a host](#creating-a-host) + * [Configuring the SNMP interface](#configuring-the-snmp-interface) + * [Overriding the memory threshold macros](#overriding-the-memory-threshold-macros) + * [Confirming Zabbix is collecting values](#confirming-zabbix-is-collecting-values) + * [Triggers](#triggers) + * [Triggers included with the template](#triggers-included-with-the-template) + * [Adding a custom trigger](#adding-a-custom-trigger) + * [Setting up notifications](#setting-up-notifications) diff --git a/docs/server/administration/snmp/snmp-overview.mdx b/docs/server/administration/snmp/snmp-overview.mdx index ce4e69686e..3ba27a62b4 100644 --- a/docs/server/administration/snmp/snmp-overview.mdx +++ b/docs/server/administration/snmp/snmp-overview.mdx @@ -24,22 +24,22 @@ SNMP support is available for [Enterprise](../../../licensing/overview.mdx#enter * This page explains how to use SNMP to monitor RavenDB and what metrics can be accessed. * In this page: - * [Overview](../../../server/administration/snmp/snmp-overview.mdx#overview) - * [Enabling SNMP in RavenDB](../../../server/administration/snmp/snmp-overview.mdx#enabling-snmp-in-ravendb) - * [SNMP Configuration options](../../../server/administration/snmp/snmp-overview.mdx#snmp-configuration-options) - * [The Metrics](../../../server/administration/snmp/snmp-overview.mdx#the-metrics) - * [Access metrics via monitoring tools](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-monitoring-tools) - * [Access metrics via SNMP agents](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-snmp-agents) - * [Access metrics via HTTP](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-http) - * [List of OIDs](../../../server/administration/snmp/snmp-overview.mdx#list-of-oids) - * [Server OIDs](../../../server/administration/snmp/snmp-overview.mdx#server-oids) - * [Cluster OIDs](../../../server/administration/snmp/snmp-overview.mdx#cluster-oids) - * [Database OIDs](../../../server/administration/snmp/snmp-overview.mdx#database-oids) - * [Index OIDs](../../../server/administration/snmp/snmp-overview.mdx#index-oids) - * [General OIDs](../../../server/administration/snmp/snmp-overview.mdx#general-oids) - * [Ongoing tasks OIDs](../../../server/administration/snmp/snmp-overview.mdx#ongoing-tasks-oids) - * [Per-task ETL OIDs](../../../server/administration/snmp/snmp-overview.mdx#per-task-etl-oids) - * [Per-task AI OIDs](../../../server/administration/snmp/snmp-overview.mdx#per-task-ai-oids) + * [Overview](#overview) + * [Enabling SNMP in RavenDB](#enabling-snmp-in-ravendb) + * [SNMP Configuration options](#snmp-configuration-options) + * [The Metrics](#the-metrics) + * [Access metrics via monitoring tools](#access-metrics-via-monitoring-tools) + * [Access metrics via SNMP agents](#access-metrics-via-snmp-agents) + * [Access metrics via HTTP](#access-metrics-via-http) + * [List of OIDs](#list-of-oids) + * [Server OIDs](#server-oids) + * [Cluster OIDs](#cluster-oids) + * [Database OIDs](#database-oids) + * [Index OIDs](#index-oids) + * [General OIDs](#general-oids) + * [Ongoing tasks OIDs](#ongoing-tasks-oids) + * [Per-task ETL OIDs](#per-task-etl-oids) + * [Per-task AI OIDs](#per-task-ai-oids) ## Overview @@ -52,7 +52,7 @@ SNMP support is available for [Enterprise](../../../licensing/overview.mdx#enter * In RavenDB we have support for SNMP which allows monitoring tools like [Zabbix](https://www.zabbix.com), [PRTG](https://www.paessler.com/prtg), and [Datadog](https://www.datadoghq.com/) direct access to the - internal details of RavenDB. We expose a long [list of metrics](../../../server/administration/snmp/snmp-overview.mdx#list-of-oids): CPU and memory usage, server total requests, + internal details of RavenDB. We expose a long [list of metrics](#list-of-oids): CPU and memory usage, server total requests, the loaded databases, and database-specific metrics like the number of indexed items per second, document writes per second, storage space each database takes, and more. @@ -151,7 +151,7 @@ There are several configurable SNMP properties in RavenDB: Each metric has a unique object identifier (OID) and can be accessed individually. * The most basic SNMP commands are `snmpget`, `snmpset` and `snmpwalk`. - For example, you can execute the following _snmpget_ commands to retrieve the server's [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13). + For example, you can execute the following _snmpget_ commands to retrieve the server's [up-time metric](#13). ##### For SNMPv2c: @@ -195,7 +195,7 @@ iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73 * An individual OID value can be retrieved via HTTP `GET` endpoint: `/monitoring/snmp?oid=` -* For example, a cURL request for the server [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13): +* For example, a cURL request for the server [up-time metric](#13): @@ -212,7 +212,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 * Multiple OID values can be retrieved by making either a `GET` or a `POST` request to the following HTTP endpoint: `/monitoring/snmp/bulk` -* For example, cURL requests for the server [managed memory](../../../server/administration/snmp/snmp-overview.mdx#167) and [unmanaged memory](../../../server/administration/snmp/snmp-overview.mdx#168) metrics: +* For example, cURL requests for the server [managed memory](#167) and [unmanaged memory](#168) metrics: @@ -321,7 +321,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 | 1.6.11.`X`.14 | GC info for `X`.
Gets the total available memory (in MB) for the garbage collector to use when the last garbage collection occurred. | | 1.6.11.`X`.15 | GC info for `X`.
Gets the total committed MB of the managed heap. | | 1.6.11.`X`.16.3 | GC info for `X`.
Gets the large object heap size (in MB) after the last garbage collection of given kind occurred. | -| 1.6.12.{0} | Monitor [/proc/meminfo/](https://man7.org/linux/man-pages/man5/proc.5.html) metrics (unix/linux).
The description of each metric is available via endpoint `/monitoring/snmp/oids`.
See [Get all OIDs](../../../server/administration/snmp/snmp-overview.mdx#getalloids). | +| 1.6.12.{0} | Monitor [/proc/meminfo/](https://man7.org/linux/man-pages/man5/proc.5.html) metrics (unix/linux).
The description of each metric is available via endpoint `/monitoring/snmp/oids`.
See [Get all OIDs](#getalloids). | | 1.6.13 | Available memory for processing (in MB) | | 1.7.1 | Number of concurrent requests | | 1.7.2 | Total number of requests since server startup | diff --git a/docs/server/clustering/cluster-api.mdx b/docs/server/clustering/cluster-api.mdx index 224ea4d9c3..3b746fe448 100644 --- a/docs/server/clustering/cluster-api.mdx +++ b/docs/server/clustering/cluster-api.mdx @@ -20,13 +20,13 @@ All cluster operations are available through the GUI. However, sometimes you'd w In this section we will demonstrate of how to perform certain cluster operations programmatically using the REST API. In the first example we will show how to make a secure call using PowerShell, cURL and the RavenDB C# Client. The rest of the examples are cURL only. -- [Add node to the cluster](../../server/clustering/cluster-api.mdx#add-node-to-the-cluster) -- [Delete node from the cluster](../../server/clustering/cluster-api.mdx#delete-node-from-the-cluster) -- [Promote a watcher node](../../server/clustering/cluster-api.mdx#promote-a-node) -- [Demote a watcher node](../../server/clustering/cluster-api.mdx#demote-a-node) -- [Force elections](../../server/clustering/cluster-api.mdx#force-elections) -- [Force timeout](../../server/clustering/cluster-api.mdx#force-timeout) -- [Bootstrap the cluster](../../server/clustering/cluster-api.mdx#bootstrap-cluster) +- [Add node to the cluster](#add-node-to-the-cluster) +- [Delete node from the cluster](#delete-node-from-the-cluster) +- [Promote a watcher node](#promote-a-node) +- [Demote a watcher node](#demote-a-node) +- [Force elections](#force-elections) +- [Force timeout](#force-timeout) +- [Bootstrap the cluster](#bootstrap-cluster) If authentication is turned on, a client certificate with either `Cluster Admin` or `Operator` [Security Clearance](../../server/security/authorization/security-clearance-and-permissions.mdx) must be supplied, depending on the endpoint. diff --git a/docs/server/clustering/cluster-best-practice-and-configuration.mdx b/docs/server/clustering/cluster-best-practice-and-configuration.mdx index 5a827bfd0b..64a8be0bc3 100644 --- a/docs/server/clustering/cluster-best-practice-and-configuration.mdx +++ b/docs/server/clustering/cluster-best-practice-and-configuration.mdx @@ -16,8 +16,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Clusters should have an odd number of at least 3 nodes](../../server/clustering/cluster-best-practice-and-configuration.mdx#clusters-should-have-an-odd-number-of-at-least-3-nodes) - * [Avoid different cluster configurations among the cluster's nodes](../../server/clustering/cluster-best-practice-and-configuration.mdx#avoid-different-cluster-configurations-among-the-clusters-nodes) + * [Clusters should have an odd number of at least 3 nodes](#clusters-should-have-an-odd-number-of-at-least-3-nodes) + * [Avoid different cluster configurations among the cluster's nodes](#avoid-different-cluster-configurations-among-the-clusters-nodes) diff --git a/docs/server/clustering/cluster-transactions.mdx b/docs/server/clustering/cluster-transactions.mdx index 7d8a6bc500..87565a2a73 100644 --- a/docs/server/clustering/cluster-transactions.mdx +++ b/docs/server/clustering/cluster-transactions.mdx @@ -20,12 +20,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Code examples and client API can be found [here](../../client-api/session/saving-changes.mdx#transaction-mode---cluster-wide). * In this page: - * [Why Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#why-cluster-wide-transactions) - * [How Cluster Transactions Work](../../server/clustering/cluster-transactions.mdx#how-cluster-transactions-work) described by the flow of a cluster transaction request example. - * [Cluster Transactions Properties](../../server/clustering/cluster-transactions.mdx#cluster-transactions-properties) - * [Concurrent Cluster-Wide and Single-Node Transactions](../../server/clustering/cluster-transactions.mdx#concurrent-cluster-wide-and-single-node-transactions) - * [Failure Modes in Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#failure-modes-in-cluster-wide-transactions) - * [Debug Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#debug-cluster-wide-transactions) + * [Why Cluster-Wide Transactions](#why-cluster-wide-transactions) + * [How Cluster Transactions Work](#how-cluster-transactions-work) described by the flow of a cluster transaction request example. + * [Cluster Transactions Properties](#cluster-transactions-properties) + * [Concurrent Cluster-Wide and Single-Node Transactions](#concurrent-cluster-wide-and-single-node-transactions) + * [Failure Modes in Cluster-Wide Transactions](#failure-modes-in-cluster-wide-transactions) + * [Debug Cluster-Wide Transactions](#debug-cluster-wide-transactions) ## Why Cluster-Wide Transactions @@ -95,7 +95,7 @@ After having a quorum for the cluster transaction request by raft and a successf of the compare exchange values, the transaction is guaranteed to be executed. Failure during the quorum or the concurrency check will roll back the entire session transaction, while failure during the commit of the documents will halt any further cluster transactions execution on the database -until that failure is remedied (failure mode for the documents commits are described later [here](../../server/clustering/cluster-transactions.mdx#failure-modes-in-cluster-wide-transactions)). +until that failure is remedied (failure mode for the documents commits are described later [here](#failure-modes-in-cluster-wide-transactions)). **Consistency** Consistency is guaranteed on the requested node. The node will complete the request only when the transaction is completed diff --git a/docs/server/clustering/distribution/cluster-observer.mdx b/docs/server/clustering/distribution/cluster-observer.mdx index 1a5001dbf1..aa46239680 100644 --- a/docs/server/clustering/distribution/cluster-observer.mdx +++ b/docs/server/clustering/distribution/cluster-observer.mdx @@ -21,8 +21,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This observer is always running on the [Leader](../../../server/clustering/rachis/cluster-topology.mdx#leader) node. * In this page: - * [Operation flow](../../../server/clustering/distribution/cluster-observer.mdx#operation-flow) - * [Interacting with the Cluster Observer](../../../server/clustering/distribution/cluster-observer.mdx#interacting-with-the-cluster-observer) + * [Operation flow](#operation-flow) + * [Interacting with the Cluster Observer](#interacting-with-the-cluster-observer) ## Operation flow diff --git a/docs/server/clustering/distribution/distributed-database.mdx b/docs/server/clustering/distribution/distributed-database.mdx index 78c50fdae6..d8486653d4 100644 --- a/docs/server/clustering/distribution/distributed-database.mdx +++ b/docs/server/clustering/distribution/distributed-database.mdx @@ -15,21 +15,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Distributed Database -* In RavenDB, a database can be replicated across multiple nodes, depending on its [Replication Factor](../../../server/clustering/distribution/distributed-database.mdx#replication-factor). +* In RavenDB, a database can be replicated across multiple nodes, depending on its [Replication Factor](#replication-factor). * A node where a database resides is referred to as a `Database Node`. The group of _Database Nodes_ that assemble the distributed database, is called a [Database Group](../../../studio/database/settings/manage-database-group.mdx). -* Unless [Sharding](../../../server/clustering/distribution/distributed-database.mdx#sharding) is employed, +* Unless [Sharding](#sharding) is employed, each Database Node has a **full copy** of the database, containing **all** the database documents, and indexes them **locally**. This greatly simplifies executing query requests, as there is no need to aggregate data from multiple nodes. * In this page: - * [The Database Record](../../../server/clustering/distribution/distributed-database.mdx#the-database-record) - * [Replication Factor](../../../server/clustering/distribution/distributed-database.mdx#replication-factor) - * [Database Topology](../../../server/clustering/distribution/distributed-database.mdx#database-topology) - * [Dynamic Database Distribution](../../../server/clustering/distribution/distributed-database.mdx#dynamic-database-distribution) - * [Sharding](../../../server/clustering/distribution/distributed-database.mdx#sharding) + * [The Database Record](#the-database-record) + * [Replication Factor](#replication-factor) + * [Database Topology](#database-topology) + * [Dynamic Database Distribution](#dynamic-database-distribution) + * [Sharding](#sharding) ## The Database Record diff --git a/docs/server/clustering/distribution/highly-available-tasks.mdx b/docs/server/clustering/distribution/highly-available-tasks.mdx index 12c1d91b41..f142ae86fb 100644 --- a/docs/server/clustering/distribution/highly-available-tasks.mdx +++ b/docs/server/clustering/distribution/highly-available-tasks.mdx @@ -21,17 +21,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Updating a `Rehab` or a `Promotable` [Database Node](../../../server/clustering/distribution/distributed-database.mdx#database-topology) * There is no single coordinator handing out tasks to a specific node. - Instead, each node decides on its own if it is the [Responsible Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) of the task. + Instead, each node decides on its own if it is the [Responsible Node](#responsible-node) of the task. * Each node will re-evaluate its responsibilities with every change made to the [Database Record](../../../client-api/operations/server-wide/create-database.mdx), such as defining a new _index_, configuring or modifying an _Ongoing Task_, any _Database Topology_ change, etc. * In this page: - * [License](../../../server/clustering/distribution/highly-available-tasks.mdx#license) - * [Constraints](../../../server/clustering/distribution/highly-available-tasks.mdx#constraints) - * [Responsible Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) - * [Tasks Relocation](../../../server/clustering/distribution/highly-available-tasks.mdx#tasks-relocation) - * [Pinning a Task](../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) + * [License](#license) + * [Constraints](#constraints) + * [Responsible Node](#responsible-node) + * [Tasks Relocation](#tasks-relocation) + * [Pinning a Task](#pinning-a-task) ## License @@ -50,7 +50,7 @@ to verify whether the Highly Available Tasks feature is activated in your databa * If your license does **not** provide highly available tasks, the responsibilities of a failed node will be resumed when the node returns online. -* Scenarios [below](../../../server/clustering/distribution/highly-available-tasks.mdx#tasks-relocation) +* Scenarios [below](#tasks-relocation) are meant to demonstrate the behavior of a system licensed for highly available tasks. diff --git a/docs/server/clustering/rachis/cluster-topology.mdx b/docs/server/clustering/rachis/cluster-topology.mdx index 347cc23d6e..b52a125754 100644 --- a/docs/server/clustering/rachis/cluster-topology.mdx +++ b/docs/server/clustering/rachis/cluster-topology.mdx @@ -20,10 +20,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Clusters are typically composed of any odd number of nodes equal or greater than 3, see [Clusters Best Practice](../../../server/clustering/cluster-best-practice-and-configuration.mdx). * In this page: - * [Fetching the topology](../../../server/clustering/rachis/cluster-topology.mdx#fetching-the-topology) - * [Modifying the topology](../../../server/clustering/rachis/cluster-topology.mdx#modifying-the-topology) - * [Nodes states and types](../../../server/clustering/rachis/cluster-topology.mdx#nodes-states-and-types) - * [Changing node type](../../../server/clustering/rachis/cluster-topology.mdx#changing-node-type) + * [Fetching the topology](#fetching-the-topology) + * [Modifying the topology](#modifying-the-topology) + * [Nodes states and types](#nodes-states-and-types) + * [Changing node type](#changing-node-type) ## Fetching the topology @@ -53,14 +53,14 @@ Optional parameters (for the Add Node endpoint): | Name | Value type | Description | |------------------|--------------|--------------------------------------------------------------------------------------------------------------| | tag | `string` | The node tag. 1-4 uppercase unicode letters.
Default: 'A' - 'Z' assigned by order of addition. | -| watcher | `bool` | Add the node as a [Watcher](../../../server/clustering/rachis/cluster-topology.mdx#watcher).
Default: `false` | +| watcher | `bool` | Add the node as a [Watcher](#watcher).
Default: `false` | | maxUtilizedCores | `uint` | Maximum number of cores that can be assigned to this node.
Default: number of processors. | See the [Cluster API page](../../../server/clustering/cluster-api.mdx) for usage examples. ## Nodes states and types -In Rachis every cluster node has a [state](../../../server/clustering/rachis/cluster-topology.mdx#state) and a [type](../../../server/clustering/rachis/cluster-topology.mdx#type). +In Rachis every cluster node has a [state](#state) and a [type](#type). @@ -73,7 +73,7 @@ and **elect** a new leader when needed. |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Member** | A fully functional voting node in the cluster. | | **Promotable** | A non-voting node.
This is an intermediate stage until node is promoted by the Leader to a Member. | -| **Watcher** | A non-voting node that is still fully managed by the cluster.
Can be assigned with databases and tasks. See more [below](../../../server/clustering/rachis/cluster-topology.mdx#watcher). | +| **Watcher** | A non-voting node that is still fully managed by the cluster.
Can be assigned with databases and tasks. See more [below](#watcher). | @@ -89,7 +89,7 @@ The Rachis state defines the **current role** of the node in the cluster. | **Candidate** | Has no Leader and tries to get elected for leadership. | | **Follower** | Has a Leader and operates normally. | | **Leader-Elect** | Just elected for leadership, but will take office and become the leader only after the dummy `noop` raft command was successfully applied in the cluster. | -| **Leader** | Leader of the cluster. See more [below](../../../server/clustering/rachis/cluster-topology.mdx#leader). | +| **Leader** | Leader of the cluster. See more [below](#leader). | diff --git a/docs/server/clustering/rachis/consensus-operations.mdx b/docs/server/clustering/rachis/consensus-operations.mdx index 46226659aa..85151da861 100644 --- a/docs/server/clustering/rachis/consensus-operations.mdx +++ b/docs/server/clustering/rachis/consensus-operations.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Only after the cluster's approval (majority of nodes ), it will _eventually_ be executed on all cluster nodes. * In this page: - * [Operations that require Consensus](../../../server/clustering/rachis/consensus-operations.mdx#operations-that-require-consensus) - * [Operations that do not require Consensus](../../../server/clustering/rachis/consensus-operations.mdx#operations-that-do-not-require-consensus) - * [Raft Commands Implementation Details](../../../server/clustering/rachis/consensus-operations.mdx#raft-commands-implementation-details) + * [Operations that require Consensus](#operations-that-require-consensus) + * [Operations that do not require Consensus](#operations-that-do-not-require-consensus) + * [Raft Commands Implementation Details](#raft-commands-implementation-details) ## Operations that require Consensus @@ -37,7 +37,7 @@ Since getting a consensus is an expensive operation, it is limited to the follow * Creating / Deleting Indexes (static and auto indexes) * Configuring the [Ongoing Tasks](../../../studio/database/tasks/ongoing-tasks/general-info.mdx) -See [Implementation Details](../../../server/clustering/rachis/consensus-operations.mdx#implementation-details) below. +See [Implementation Details](#implementation-details) below. diff --git a/docs/server/clustering/replication/advanced-replication.mdx b/docs/server/clustering/replication/advanced-replication.mdx index 75f4930253..3ff7d03389 100644 --- a/docs/server/clustering/replication/advanced-replication.mdx +++ b/docs/server/clustering/replication/advanced-replication.mdx @@ -23,7 +23,7 @@ Whenever the replication process between two databases is initiated it has to de 3. Once the _source_ gets the OK message it queries the _destination_ about the latest ETag it got from him. 4. The _destination_ sends back a heartbeat message with both the latest `ETag` he got from the _source_ and the current [Change Vector](../../../server/clustering/replication/change-vector.mdx) of the database. 5. The `ETag` is used as a starting point for the replication process but it is then been filtered by the _destination's_ current `change vector`, -meaning we will skip documents with higher `ETag` and lower `Change Vector`, this is done to prevent the [Ripple Effect](../../../server/clustering/replication/advanced-replication.mdx#preventing-the-ripple-effect). +meaning we will skip documents with higher `ETag` and lower `Change Vector`, this is done to prevent the [Ripple Effect](#preventing-the-ripple-effect). ## Preventing the Ripple Effect diff --git a/docs/server/clustering/replication/change-vector.mdx b/docs/server/clustering/replication/change-vector.mdx index 76310e3804..a16112e9cd 100644 --- a/docs/server/clustering/replication/change-vector.mdx +++ b/docs/server/clustering/replication/change-vector.mdx @@ -18,17 +18,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Change vectors are the RavenDB implementation of the [Vector clock](https://en.wikipedia.org/wiki/Vector_clock) concept. They give us partial order over modifications of documents in a RavenDB cluster. -* Change vectors are updated every time a document is [modified](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors) +* Change vectors are updated every time a document is [modified](#concurrency-control--change-vectors) in any way. * In this page: - * [What are Change Vectors Constructed From?](../../../server/clustering/replication/change-vector.mdx#what-are-change-vectors-constructed-from) - * [How are Change Vectors used to Determine Order?](../../../server/clustering/replication/change-vector.mdx#how-are-change-vectors-used-to-determine-order) - * [Concurrency Control & Change Vectors](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors) - * [Change Vector Comparisons](../../../server/clustering/replication/change-vector.mdx#change-vector-comparisons) - * [Concurrency Control at the Cluster](../../../server/clustering/replication/change-vector.mdx#concurrency-control-at-the-cluster) - * [Database Global Change Vector](../../../server/clustering/replication/change-vector.mdx#database-global-change-vector) - * [After Restoring a Database from Backup](../../../server/clustering/replication/change-vector.mdx#after-restoring-a-database-from-backup) + * [What are Change Vectors Constructed From?](#what-are-change-vectors-constructed-from) + * [How are Change Vectors used to Determine Order?](#how-are-change-vectors-used-to-determine-order) + * [Concurrency Control & Change Vectors](#concurrency-control--change-vectors) + * [Change Vector Comparisons](#change-vector-comparisons) + * [Concurrency Control at the Cluster](#concurrency-control-at-the-cluster) + * [Database Global Change Vector](#database-global-change-vector) + * [After Restoring a Database from Backup](#after-restoring-a-database-from-backup) ## What are Change Vectors Constructed From? @@ -183,7 +183,7 @@ Note that if data is considered contained by a database it doesn't mean it is pr * [Snapshot backups](../../../backup/overview.mdx#snapshot-image) save [change vector data](../../../backup/overview.mdx#backup-content). * [Logical backups](../../../backup/overview.mdx#logical-backup) do not save change vector data. - Restoring a database from a logical backup will renew the document change vector's frequently [incrementing ETag](../../../server/clustering/replication/change-vector.mdx#what-are-change-vectors-constructed-from) + Restoring a database from a logical backup will renew the document change vector's frequently [incrementing ETag](#what-are-change-vectors-constructed-from) to its original value. diff --git a/docs/server/clustering/replication/replication-and-embedded-instance.mdx b/docs/server/clustering/replication/replication-and-embedded-instance.mdx index b568c78a98..6707df1810 100644 --- a/docs/server/clustering/replication/replication-and-embedded-instance.mdx +++ b/docs/server/clustering/replication/replication-and-embedded-instance.mdx @@ -20,10 +20,10 @@ Essentially, Embedded RavenDB is the same as non-embedded, their only difference ## Configuring Replication between Embedded Instance and a Cluster ## Examples in this page - * [Configuring cluster membership of embedded instance through the Studio](../../../server/clustering/replication/replication-and-embedded-instance.mdx#configuring-cluster-membership-of-embedded-instance-through-the-studio) - * [Programmatically configuring cluster membership of embedded instance](../../../server/clustering/replication/replication-and-embedded-instance.mdx#programmatically-configuring-cluster-membership-of-embedded-instance) - * [Configuring embedded instance as External Replication destination through the Studio](../../../server/clustering/replication/replication-and-embedded-instance.mdx#configuring-embedded-instance-as-external-replication-destination-through-the-studio) - * [Programmatically embedded instance as External Replication destination](../../../server/clustering/replication/replication-and-embedded-instance.mdx#programmatically-embedded-instance-as-external-replication-destination) + * [Configuring cluster membership of embedded instance through the Studio](#configuring-cluster-membership-of-embedded-instance-through-the-studio) + * [Programmatically configuring cluster membership of embedded instance](#programmatically-configuring-cluster-membership-of-embedded-instance) + * [Configuring embedded instance as External Replication destination through the Studio](#configuring-embedded-instance-as-external-replication-destination-through-the-studio) + * [Programmatically embedded instance as External Replication destination](#programmatically-embedded-instance-as-external-replication-destination) diff --git a/docs/server/clustering/replication/replication-conflicts.mdx b/docs/server/clustering/replication/replication-conflicts.mdx index 6c1e707fb7..900ecfa6d2 100644 --- a/docs/server/clustering/replication/replication-conflicts.mdx +++ b/docs/server/clustering/replication/replication-conflicts.mdx @@ -45,8 +45,8 @@ When there is a conflict between two or more document versions, RavenDB will try The identity check applies to [Tombstone](../../../monitoring/tombstones/overview.mdx) as well, and it will always resolve to the local one, since the tombstones are always considered equal. -3. Try to resolve the conflict by using a script, which is set up by configuring a [Conflict Resolver](../../../server/clustering/replication/replication-conflicts.mdx#conflict-resolution-script). -4. If all else fails, record conflicting document variants as "Conflicted Documents" which will have to be resolved [Manually](../../../server/clustering/replication/replication-conflicts.mdx#manually-resolving-conflicts). +3. Try to resolve the conflict by using a script, which is set up by configuring a [Conflict Resolver](#conflict-resolution-script). +4. If all else fails, record conflicting document variants as "Conflicted Documents" which will have to be resolved [Manually](#manually-resolving-conflicts). ## Conflict Resolution Script A resolution script is defined per collection and have the following input arguments: diff --git a/docs/server/clustering/replication/replication-overview.mdx b/docs/server/clustering/replication/replication-overview.mdx index f793e7d532..199c9bd2b0 100644 --- a/docs/server/clustering/replication/replication-overview.mdx +++ b/docs/server/clustering/replication/replication-overview.mdx @@ -26,13 +26,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; are resolved according to the defined [conflict resolution](../../../server/clustering/replication/replication-conflicts.mdx) policy on the receiving end. * In this page: - * [Replication types](../../../server/clustering/replication/replication-overview.mdx#replication-types) - * [Internal replication](../../../server/clustering/replication/replication-overview.mdx#internal-replication) - * [External replication](../../../server/clustering/replication/replication-overview.mdx#external-replication) - * [Hub/Sink replication](../../../server/clustering/replication/replication-overview.mdx#hubsink-replication) - * [What is replicated](../../../server/clustering/replication/replication-overview.mdx#what-is-replicated) - * [How replication works](../../../server/clustering/replication/replication-overview.mdx#how-replication-works) - * [Replication & transaction boundary](../../../server/clustering/replication/replication-overview.mdx#replication--transaction-boundary) + * [Replication types](#replication-types) + * [Internal replication](#internal-replication) + * [External replication](#external-replication) + * [Hub/Sink replication](#hubsink-replication) + * [What is replicated](#what-is-replicated) + * [How replication works](#how-replication-works) + * [Replication & transaction boundary](#replication--transaction-boundary) ## Replication types @@ -163,7 +163,7 @@ __Replication & cluster-wide transactions__ is either persisted on all database group nodes or rolled back on all upon failure. * After a cluster consensus is reached, the Raft command to be executed is propagated to all nodes. - When the command is executed locally on a node, if the items that are persisted are of the [type that replicates](../../../server/clustering/replication/replication-overview.mdx#what-is-replicated), + When the command is executed locally on a node, if the items that are persisted are of the [type that replicates](#what-is-replicated), then the node will __replicate__ them to the other nodes via the replication process. * A node that receives such replication will accept this write, diff --git a/docs/server/configuration/cluster-configuration.mdx b/docs/server/configuration/cluster-configuration.mdx index b94f1e3920..5fb9a70467 100644 --- a/docs/server/configuration/cluster-configuration.mdx +++ b/docs/server/configuration/cluster-configuration.mdx @@ -27,30 +27,30 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Server-wide scope: - [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../../server/configuration/cluster-configuration.mdx#clustercompareexchangeexpireddeletefrequencyinsec) - [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration.mdx#clustercompareexchangetombstonescleanupintervalinmin) - [Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clusterelectiontimeoutinms) - [Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration.mdx#clusterharddeleteonreplacement) - [Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration.mdx#clusterloghistorymaxentries) - [Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration.mdx#clustermaxchangevectordistance) - [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) - [Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration.mdx#clustermaxsizeofsingleraftcommandinmb) - [Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration.mdx#clustermaximalallowedclusterversion) - [Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration.mdx#clusteronerrordelaytimeinms) - [Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration.mdx#clusteroperationtimeoutinsec) - [Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clusterreceivefromworkertimeoutinms) - [Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration.mdx#clusterstatsstabilizationtimeinsec) - [Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#clustersupervisorsampleperiodinms) - [Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#clustertcpreceivebuffersizeinbytes) - [Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#clustertcpsendbuffersizeinbytes) - [Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clustertcptimeoutinms) - [Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) - [Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) - [Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforerotatingpreferrednodeinsec) - [Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#clusterworkersampleperiodinms) + [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](#clustercompareexchangeexpireddeletefrequencyinsec) + [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](#clustercompareexchangetombstonescleanupintervalinmin) + [Cluster.ElectionTimeoutInMs](#clusterelectiontimeoutinms) + [Cluster.HardDeleteOnReplacement](#clusterharddeleteonreplacement) + [Cluster.LogHistoryMaxEntries](#clusterloghistorymaxentries) + [Cluster.MaxChangeVectorDistance](#clustermaxchangevectordistance) + [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) + [Cluster.MaxSizeOfSingleRaftCommandInMb](#clustermaxsizeofsingleraftcommandinmb) + [Cluster.MaximalAllowedClusterVersion](#clustermaximalallowedclusterversion) + [Cluster.OnErrorDelayTimeInMs](#clusteronerrordelaytimeinms) + [Cluster.OperationTimeoutInSec](#clusteroperationtimeoutinsec) + [Cluster.ReceiveFromWorkerTimeoutInMs](#clusterreceivefromworkertimeoutinms) + [Cluster.StatsStabilizationTimeInSec](#clusterstatsstabilizationtimeinsec) + [Cluster.SupervisorSamplePeriodInMs](#clustersupervisorsampleperiodinms) + [Cluster.TcpReceiveBufferSizeInBytes](#clustertcpreceivebuffersizeinbytes) + [Cluster.TcpSendBufferSizeInBytes](#clustertcpsendbuffersizeinbytes) + [Cluster.TcpTimeoutInMs](#clustertcptimeoutinms) + [Cluster.TimeBeforeAddingReplicaInSec](#clustertimebeforeaddingreplicainsec) + [Cluster.TimeBeforeMovingToRehabInSec](#clustertimebeforemovingtorehabinsec) + [Cluster.TimeBeforeRotatingPreferredNodeInSec](#clustertimebeforerotatingpreferrednodeinsec) + [Cluster.WorkerSamplePeriodInMs](#clusterworkersampleperiodinms) * Server-wide, or database scope: - [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#clusterdisableatomicdocumentwrites) - [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactionbatchsize) + [Cluster.DisableAtomicDocumentWrites](#clusterdisableatomicdocumentwrites) + [Cluster.MaxClusterTransactionBatchSize](#clustermaxclustertransactionbatchsize) ## Cluster.CompareExchangeExpiredDeleteFrequencyInSec diff --git a/docs/server/configuration/configuration-options.mdx b/docs/server/configuration/configuration-options.mdx index 533ae23cca..cdaec7d0ac 100644 --- a/docs/server/configuration/configuration-options.mdx +++ b/docs/server/configuration/configuration-options.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; If needed, you can customize the default configuration to suit your specific needs. * Any **configuration key** can be modified by either of the following options: - * [Environment variables](../../server/configuration/configuration-options.mdx#environment-variables) - * [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) - * [Command line arguments](../../server/configuration/configuration-options.mdx#command-line-arguments) - * [Database settings view](../../server/configuration/configuration-options.mdx#database-settings-view) (database scope only) + * [Environment variables](#environment-variables) + * [settings.json](#settingsjson) + * [Command line arguments](#command-line-arguments) + * [Database settings view](#database-settings-view) (database scope only) @@ -55,7 +55,7 @@ $Env:RAVEN_Security_Certificate_Path=/config/raven-server.certificate.pfx _settings.json_ configuration values **override** their matching -[environment variables](../../server/configuration/configuration-options.mdx#environment-variables) values. +[environment variables](#environment-variables) values. * The `settings.json` file is created by RavenDB when running the server for the first time, @@ -103,8 +103,8 @@ for example, use: Command line arguments configuration values **override** their matching -[environment variables](../../server/configuration/configuration-options.mdx#environment-variables) -and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) values. +[environment variables](#environment-variables) +and [settings.json](#settingsjson) values. * The server can be configured using command line arguments that are passed to the console application diff --git a/docs/server/configuration/database-configuration.mdx b/docs/server/configuration/database-configuration.mdx index 559ba63573..8ff12bcb76 100644 --- a/docs/server/configuration/database-configuration.mdx +++ b/docs/server/configuration/database-configuration.mdx @@ -19,21 +19,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Databases.Compression.CompressAllCollectionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault) - [Databases.Compression.CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) - [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesconcurrentloadtimeoutinsec) - [Databases.FrequencyToCheckForIdleInSec](../../server/configuration/database-configuration.mdx#databasesfrequencytocheckforidleinsec) - [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databasesmaxconcurrentloads) + [Databases.Compression.CompressAllCollectionsDefault](#databasescompressioncompressallcollectionsdefault) + [Databases.Compression.CompressRevisionsDefault](#databasescompressioncompressrevisionsdefault) + [Databases.ConcurrentLoadTimeoutInSec](#databasesconcurrentloadtimeoutinsec) + [Databases.FrequencyToCheckForIdleInSec](#databasesfrequencytocheckforidleinsec) + [Databases.MaxConcurrentLoads](#databasesmaxconcurrentloads) * Server-wide, or database scope: - [Databases.CollectionOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasescollectionoperationtimeoutinsec) - [Databases.DeepCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databasesdeepcleanupthresholdinmin) - [Databases.MaxIdleTimeInSec](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec) - [Databases.OperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesoperationtimeoutinsec) - [Databases.PulseReadTransactionLimitInMb](../../server/configuration/database-configuration.mdx#databasespulsereadtransactionlimitinmb) - [Databases.QueryOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) - [Databases.QueryTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) - [Databases.RegularCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databasesregularcleanupthresholdinmin) + [Databases.CollectionOperationTimeoutInSec](#databasescollectionoperationtimeoutinsec) + [Databases.DeepCleanupThresholdInMin](#databasesdeepcleanupthresholdinmin) + [Databases.MaxIdleTimeInSec](#databasesmaxidletimeinsec) + [Databases.OperationTimeoutInSec](#databasesoperationtimeoutinsec) + [Databases.PulseReadTransactionLimitInMb](#databasespulsereadtransactionlimitinmb) + [Databases.QueryOperationTimeoutInSec](#databasesqueryoperationtimeoutinsec) + [Databases.QueryTimeoutInSec](#databasesquerytimeoutinsec) + [Databases.RegularCleanupThresholdInMin](#databasesregularcleanupthresholdinmin) ## Databases.Compression.CompressAllCollectionsDefault @@ -65,7 +65,7 @@ The time (in seconds) that a database waits for a free loading slot before the load attempt times out. RavenDB limits the number of databases that load at the same time -(set by [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databasesmaxconcurrentloads)). +(set by [Databases.MaxConcurrentLoads](#databasesmaxconcurrentloads)). When this limit is reached, each additional database that needs to load waits for a slot to free up. This can happen when a burst of requests accesses many idle databases at once. @@ -96,7 +96,7 @@ The interval (in seconds) at which the system checks for idle databases. Specifies the maximum number of databases that can be loaded concurrently. If more databases need to load at the same time, each database waits for a free slot -for the period set by [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesconcurrentloadtimeoutinsec). +for the period set by [Databases.ConcurrentLoadTimeoutInSec](#databasesconcurrentloadtimeoutinsec). - **Type**: `int` - **Default**: `8` diff --git a/docs/server/configuration/etl-configuration.mdx b/docs/server/configuration/etl-configuration.mdx index 9b67801804..a522e1114b 100644 --- a/docs/server/configuration/etl-configuration.mdx +++ b/docs/server/configuration/etl-configuration.mdx @@ -17,19 +17,19 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [ETL.ExtractAndTransformTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlextractandtransformtimeoutinsec) - * [ETL.MaxBatchSizeInMb](../../server/configuration/etl-configuration.mdx#etlmaxbatchsizeinmb) - * [ETL.MaxFallbackTimeInSec](../../server/configuration/etl-configuration.mdx#etlmaxfallbacktimeinsec) - * [ETL.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteddocuments) - * [ETL.MaxNumberOfExtractedItems](../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteditems) - * [ETL.OLAP.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etlolapmaxnumberofextracteddocuments) - * [ETL.ProcessHealthStatusFailedThreshold](../../server/configuration/etl-configuration.mdx#etlprocesshealthstatusfailedthreshold) - * [ETL.ProcessHealthStatusImpairedThreshold](../../server/configuration/etl-configuration.mdx#etlprocesshealthstatusimpairedthreshold) - * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragetimetoliveinsec) - * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragevisibilitytimeoutinsec) - * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlqueuekafkainittransactionstimeoutinsec) - * [ETL.Raven.LoadRequestTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlravenloadrequesttimeoutinsec) - * [ETL.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) + * [ETL.ExtractAndTransformTimeoutInSec](#etlextractandtransformtimeoutinsec) + * [ETL.MaxBatchSizeInMb](#etlmaxbatchsizeinmb) + * [ETL.MaxFallbackTimeInSec](#etlmaxfallbacktimeinsec) + * [ETL.MaxNumberOfExtractedDocuments](#etlmaxnumberofextracteddocuments) + * [ETL.MaxNumberOfExtractedItems](#etlmaxnumberofextracteditems) + * [ETL.OLAP.MaxNumberOfExtractedDocuments](#etlolapmaxnumberofextracteddocuments) + * [ETL.ProcessHealthStatusFailedThreshold](#etlprocesshealthstatusfailedthreshold) + * [ETL.ProcessHealthStatusImpairedThreshold](#etlprocesshealthstatusimpairedthreshold) + * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](#etlqueueazurequeuestoragetimetoliveinsec) + * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](#etlqueueazurequeuestoragevisibilitytimeoutinsec) + * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](#etlqueuekafkainittransactionstimeoutinsec) + * [ETL.Raven.LoadRequestTimeoutInSec](#etlravenloadrequesttimeoutinsec) + * [ETL.SQL.CommandTimeoutInSec](#etlsqlcommandtimeoutinsec) diff --git a/docs/server/configuration/http-configuration.mdx b/docs/server/configuration/http-configuration.mdx index f970031bd8..6507fe8538 100644 --- a/docs/server/configuration/http-configuration.mdx +++ b/docs/server/configuration/http-configuration.mdx @@ -20,33 +20,33 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can set Kestrel's properties via the following RavenDB configuration keys. * In this page: - * [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#httpmindataratebytespersec) - * [Http.MinDataRateGracePeriodInSec](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec) - * [Http.MaxRequestBufferSizeInKb](../../server/configuration/http-configuration.mdx#httpmaxrequestbuffersizeinkb) - * [Http.MaxRequestLineSizeInKb](../../server/configuration/http-configuration.mdx#httpmaxrequestlinesizeinkb) - * [Http.Http2.KeepAlivePingTimeoutInSec](../../server/configuration/http-configuration.mdx#httphttp2keepalivepingtimeoutinsec) - * [Http.Http2.KeepAlivePingDelayInSec](../../server/configuration/http-configuration.mdx#httphttp2keepalivepingdelayinsec) - * [Http.Http2.MaxStreamsPerConnection](../../server/configuration/http-configuration.mdx#httphttp2maxstreamsperconnection) - * [Http.Http2.Profile](../../server/configuration/http-configuration.mdx#httphttp2profile) - * [Http.Http2.LatencyHint](../../server/configuration/http-configuration.mdx#httphttp2latencyhint) - * [Http.Http2.InitialConnectionWindowSizeInKb](../../server/configuration/http-configuration.mdx#httphttp2initialconnectionwindowsizeinkb) - * [Http.Http2.InitialStreamWindowSizeInKb](../../server/configuration/http-configuration.mdx#httphttp2initialstreamwindowsizeinkb) - * [Http.Http2.MaxFrameSizeInKb](../../server/configuration/http-configuration.mdx#httphttp2maxframesizeinkb) - * [Http.UseResponseCompression](../../server/configuration/http-configuration.mdx#httpuseresponsecompression) - * [Http.AllowResponseCompressionOverHttps](../../server/configuration/http-configuration.mdx#httpallowresponsecompressionoverhttps) - * [Http.GzipResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpgzipresponsecompressionlevel) - * [Http.DeflateResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpdeflateresponsecompressionlevel) - * [Http.ZstdResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpzstdresponsecompressionlevel) - * [Http.StaticFilesResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpstaticfilesresponsecompressionlevel) - * [Http.Protocols](../../server/configuration/http-configuration.mdx#httpprotocols) - * [Http.AllowSynchronousIO](../../server/configuration/http-configuration.mdx#httpallowsynchronousio) + * [Http.MinDataRateBytesPerSec](#httpmindataratebytespersec) + * [Http.MinDataRateGracePeriodInSec](#httpmindatarategraceperiodinsec) + * [Http.MaxRequestBufferSizeInKb](#httpmaxrequestbuffersizeinkb) + * [Http.MaxRequestLineSizeInKb](#httpmaxrequestlinesizeinkb) + * [Http.Http2.KeepAlivePingTimeoutInSec](#httphttp2keepalivepingtimeoutinsec) + * [Http.Http2.KeepAlivePingDelayInSec](#httphttp2keepalivepingdelayinsec) + * [Http.Http2.MaxStreamsPerConnection](#httphttp2maxstreamsperconnection) + * [Http.Http2.Profile](#httphttp2profile) + * [Http.Http2.LatencyHint](#httphttp2latencyhint) + * [Http.Http2.InitialConnectionWindowSizeInKb](#httphttp2initialconnectionwindowsizeinkb) + * [Http.Http2.InitialStreamWindowSizeInKb](#httphttp2initialstreamwindowsizeinkb) + * [Http.Http2.MaxFrameSizeInKb](#httphttp2maxframesizeinkb) + * [Http.UseResponseCompression](#httpuseresponsecompression) + * [Http.AllowResponseCompressionOverHttps](#httpallowresponsecompressionoverhttps) + * [Http.GzipResponseCompressionLevel](#httpgzipresponsecompressionlevel) + * [Http.DeflateResponseCompressionLevel](#httpdeflateresponsecompressionlevel) + * [Http.ZstdResponseCompressionLevel](#httpzstdresponsecompressionlevel) + * [Http.StaticFilesResponseCompressionLevel](#httpstaticfilesresponsecompressionlevel) + * [Http.Protocols](#httpprotocols) + * [Http.AllowSynchronousIO](#httpallowsynchronousio) ## Http.MinDataRateBytesPerSec * Set Kestrel's minimum required data rate in bytes per second. -* This option must be configured together with [Http.MinDataRateGracePeriod](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec). +* This option must be configured together with [Http.MinDataRateGracePeriod](#httpmindatarategraceperiodinsec). - **Type**: `int` - **Default**: `null` - **Scope**: Server-wide only @@ -59,7 +59,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Http.MinDataRateGracePeriodInSec * Set Kestrel's allowed request and response grace period in seconds. - This option must be configured together with [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#httpmindataratebytespersec) + This option must be configured together with [Http.MinDataRateBytesPerSec](#httpmindataratebytespersec) * Kestrel checks every second if data is coming in at the specified rate in bytes/second. If the rate drops below the minimum set by _MinResponseDataRate_, the connection is timed out. @@ -194,8 +194,8 @@ The latency hint does **not** affect explicit overrides set via * **EXPERT**: Override the Kestrel HTTP/2 per-connection receive window size. -* Prefer using [Http.Http2.Profile](../../server/configuration/http-configuration.mdx#httphttp2profile) and - [Http.Http2.LatencyHint](../../server/configuration/http-configuration.mdx#httphttp2latencyhint) +* Prefer using [Http.Http2.Profile](#httphttp2profile) and + [Http.Http2.LatencyHint](#httphttp2latencyhint) unless you understand your bandwidth-delay product and memory tradeoffs. * Values are clamped to the RFC 9113 legal range (64 KB – 2,147,483,647 bytes). @@ -211,8 +211,8 @@ The latency hint does **not** affect explicit overrides set via * **EXPERT**: Override the Kestrel HTTP/2 per-stream receive window size. -* Prefer using [Http.Http2.Profile](../../server/configuration/http-configuration.mdx#httphttp2profile) and - [Http.Http2.LatencyHint](../../server/configuration/http-configuration.mdx#httphttp2latencyhint) +* Prefer using [Http.Http2.Profile](#httphttp2profile) and + [Http.Http2.LatencyHint](#httphttp2latencyhint) unless you are tuning for specific concurrency and RTT requirements. * Values are clamped to the RFC 9113 legal range (64 KB – 2,147,483,647 bytes). diff --git a/docs/server/configuration/indexing-configuration.mdx b/docs/server/configuration/indexing-configuration.mdx index 80a04f16a0..4ea294b82d 100644 --- a/docs/server/configuration/indexing-configuration.mdx +++ b/docs/server/configuration/indexing-configuration.mdx @@ -26,91 +26,91 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Indexing.CleanupIntervalInMin](../../server/configuration/indexing-configuration.mdx#indexingcleanupintervalinmin) - [Indexing.Corax.VectorSearch.MaxNumberOfThreadsForLocalEmbeddingsGeneration](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchmaxnumberofthreadsforlocalembeddingsgeneration) - [Indexing.GlobalScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingglobalscratchspacelimitinmb) - [Indexing.MaxNumberOfConcurrentlyRunningIndexes](../../server/configuration/indexing-configuration.mdx#indexingmaxnumberofconcurrentlyrunningindexes) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) - [Indexing.NuGetAllowPreReleasePackages](../../server/configuration/indexing-configuration.mdx#indexingnugetallowprereleasepackages) - [Indexing.NuGetPackageSourceUrl](../../server/configuration/indexing-configuration.mdx#indexingnugetpackagesourceurl) - [Indexing.NuGetPackagesPath](../../server/configuration/indexing-configuration.mdx#indexingnugetpackagespath) - [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacheexpirationscanfrequencyinsec) - [Indexing.QueryClauseCache.RepeatedQueriesCount](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacherepeatedqueriescount) - [Indexing.QueryClauseCache.SizeInMb](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecachesizeinmb) + [Indexing.CleanupIntervalInMin](#indexingcleanupintervalinmin) + [Indexing.Corax.VectorSearch.MaxNumberOfThreadsForLocalEmbeddingsGeneration](#indexingcoraxvectorsearchmaxnumberofthreadsforlocalembeddingsgeneration) + [Indexing.GlobalScratchSpaceLimitInMb](#indexingglobalscratchspacelimitinmb) + [Indexing.MaxNumberOfConcurrentlyRunningIndexes](#indexingmaxnumberofconcurrentlyrunningindexes) + [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](#indexingmaxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) + [Indexing.NuGetAllowPreReleasePackages](#indexingnugetallowprereleasepackages) + [Indexing.NuGetPackageSourceUrl](#indexingnugetpackagesourceurl) + [Indexing.NuGetPackagesPath](#indexingnugetpackagespath) + [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](#indexingqueryclausecacheexpirationscanfrequencyinsec) + [Indexing.QueryClauseCache.RepeatedQueriesCount](#indexingqueryclausecacherepeatedqueriescount) + [Indexing.QueryClauseCache.SizeInMb](#indexingqueryclausecachesizeinmb) * Server-wide, or database scope: - [Indexing.Auto.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) - [Indexing.Auto.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexingautodeploymentmode) - [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) - [Indexing.Disable](../../server/configuration/indexing-configuration.mdx#indexingdisable) - [Indexing.DisableQueryOptimizerGeneratedIndexes](../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) - [Indexing.ErrorIndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexingerrorindexstartupbehavior) - [Indexing.History.NumberOfRevisions](../../server/configuration/indexing-configuration.mdx#indexinghistorynumberofrevisions) - [Indexing.IndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexingindexstartupbehavior) - [Indexing.ResetMode](../../server/configuration/indexing-configuration.mdx#indexingresetmode) - [Indexing.RunInMemory](../../server/configuration/indexing-configuration.mdx#indexingruninmemory) - [Indexing.SkipDatabaseIdValidationOnIndexOpening](../../server/configuration/indexing-configuration.mdx#indexingskipdatabaseidvalidationonindexopening) - [Indexing.Static.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) - [Indexing.Static.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexingstaticdeploymentmode) - [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) - [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath) - [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](../../server/configuration/indexing-configuration.mdx#indexingtimebeforedeletionofsupersededautoindexinsec) - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin) + [Indexing.Auto.ArchivedDataProcessingBehavior](#indexingautoarchiveddataprocessingbehavior) + [Indexing.Auto.DeploymentMode](#indexingautodeploymentmode) + [Indexing.Auto.SearchEngineType](#indexingautosearchenginetype) + [Indexing.Disable](#indexingdisable) + [Indexing.DisableQueryOptimizerGeneratedIndexes](#indexingdisablequeryoptimizergeneratedindexes) + [Indexing.ErrorIndexStartupBehavior](#indexingerrorindexstartupbehavior) + [Indexing.History.NumberOfRevisions](#indexinghistorynumberofrevisions) + [Indexing.IndexStartupBehavior](#indexingindexstartupbehavior) + [Indexing.ResetMode](#indexingresetmode) + [Indexing.RunInMemory](#indexingruninmemory) + [Indexing.SkipDatabaseIdValidationOnIndexOpening](#indexingskipdatabaseidvalidationonindexopening) + [Indexing.Static.ArchivedDataProcessingBehavior](#indexingstaticarchiveddataprocessingbehavior) + [Indexing.Static.DeploymentMode](#indexingstaticdeploymentmode) + [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](#indexingstaticrequireadmintodeployjavascriptindexes) + [Indexing.TempPath](#indexingtemppath) + [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](#indexingtimebeforedeletionofsupersededautoindexinsec) + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) + [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](#indexingtimetowaitbeforemarkingautoindexasidleinmin) * Server-wide, or database, or per index: - [Indexing.AllowStringCompilation](../../server/configuration/indexing-configuration.mdx#indexingallowstringcompilation) - [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) - [Indexing.Analyzers.Exact.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) - [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) - [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) - [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) - [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) - [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) - [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxmemoizationsizeinmb) - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) - [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxunmanagedallocationsbatchsizelimitinmb) - [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) - [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofedges) - [Indexing.Corax.VectorSearch.MaximumConcurrentBatchesForHnswAcceleration](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchmaximumconcurrentbatchesforhnswacceleration) - [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchorderbyscoreautomatically) - [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) - [Indexing.Encrypted.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb) - [Indexing.IndexEmptyEntries](../../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) - [Indexing.IndexMissingFieldsAsNull](../../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) - [Indexing.Lucene.Analyzers.NGram.MaxGram](../../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) - [Indexing.Lucene.Analyzers.NGram.MinGram](../../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) - [Indexing.Lucene.IndexInputType](../../server/configuration/indexing-configuration.mdx#indexingluceneindexinputtype) - [Indexing.Lucene.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglucenelargesegmentsizetomergeinmb) - [Indexing.Lucene.MaximumSizePerSegmentInMb](../../server/configuration/indexing-configuration.mdx#indexinglucenemaximumsizepersegmentinmb) - [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](../../server/configuration/indexing-configuration.mdx#indexinglucenemaxtimeformergestokeeprunninginsec) - [Indexing.Lucene.MergeFactor](../../server/configuration/indexing-configuration.mdx#indexinglucenemergefactor) - [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexinglucenenumberoflargesegmentstomergeinsinglebatch) - [Indexing.Lucene.ReaderTermsIndexDivisor](../../server/configuration/indexing-configuration.mdx#indexinglucenereadertermsindexdivisor) - [Indexing.Lucene.UseCompoundFileInMerging](../../server/configuration/indexing-configuration.mdx#indexingluceneusecompoundfileinmerging) - [Indexing.ManagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingmanagedallocationsbatchsizelimitinmb) - [Indexing.MapBatchSize](../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) - [Indexing.MapTimeoutAfterEtagReachedInMin](../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutafteretagreachedinmin) - [Indexing.MapTimeoutInSec](../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) - [Indexing.MaxStepsForScript](../../server/configuration/indexing-configuration.mdx#indexingmaxstepsforscript) - [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimefordocumenttransactiontoremainopeninsec) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) - [Indexing.Metrics.Enabled](../../server/configuration/indexing-configuration.mdx#indexingmetricsenabled) - [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexingminnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) - [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](../../server/configuration/indexing-configuration.mdx#indexingminimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) - [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexingnumberofconcurrentstoppedbatchesifrunninglowonmemory) - [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexingnumberoflargesegmentstomergeinsinglebatch) - [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](../../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) - [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](../../server/configuration/indexing-configuration.mdx#indexingorderbyticksautomaticallywhendatesareinvolved) - [Indexing.QueryClauseCache.Disabled](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecachedisabled) - [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacherepeatedqueriestimeframeinsec) - [Indexing.Querying.Corax.NullFirst](../../server/configuration/indexing-configuration.mdx#indexingqueryingcoraxnullfirst) - [Indexing.Querying.Corax.NullsSortMode](../../server/configuration/indexing-configuration.mdx#indexingqueryingcoraxnullssortmode) - [Indexing.Querying.UseSearchAnalyzerForDynamicFieldsIfNotSetExplicitlyInSearchQuery](../../server/configuration/indexing-configuration.mdx#indexingqueryingusesearchanalyzerfordynamicfieldsifnotsetexplicitlyinsearchquery) [Indexing.ScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingscratchspacelimitinmb) - [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) - [Indexing.Throttling.TimeIntervalInMs](../../server/configuration/indexing-configuration.mdx#indexingthrottlingtimeintervalinms) - [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](../../server/configuration/indexing-configuration.mdx#indexingtimesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) - [Indexing.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingtransactionsizelimitinmb) + [Indexing.AllowStringCompilation](#indexingallowstringcompilation) + [Indexing.Analyzers.Default](#indexinganalyzersdefault) + [Indexing.Analyzers.Exact.Default](#indexinganalyzersexactdefault) + [Indexing.Analyzers.Search.Default](#indexinganalyzerssearchdefault) + [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](#indexingcoraxdocumentslimitforcompressiondictionarycreation) + [Indexing.Corax.IncludeDocumentScore](#indexingcoraxincludedocumentscore) + [Indexing.Corax.IncludeSpatialDistance](#indexingcoraxincludespatialdistance) + [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](#indexingcoraxmaxallocationsatdictionarytraininginmb) + [Indexing.Corax.MaxMemoizationSizeInMb](#indexingcoraxmaxmemoizationsizeinmb) + [Indexing.Corax.Static.ComplexFieldIndexingBehavior](#indexingcoraxstaticcomplexfieldindexingbehavior) + [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](#indexingcoraxunmanagedallocationsbatchsizelimitinmb) + [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](#indexingcoraxvectorsearchdefaultminimumsimilarity) + [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing) + [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) + [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](#indexingcoraxvectorsearchdefaultnumberofedges) + [Indexing.Corax.VectorSearch.MaximumConcurrentBatchesForHnswAcceleration](#indexingcoraxvectorsearchmaximumconcurrentbatchesforhnswacceleration) + [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](#indexingcoraxvectorsearchorderbyscoreautomatically) + [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](#indexingcoraxvectorsearchvectorsearchscanningthreshold) + [Indexing.Encrypted.TransactionSizeLimitInMb](#indexingencryptedtransactionsizelimitinmb) + [Indexing.IndexEmptyEntries](#indexingindexemptyentries) + [Indexing.IndexMissingFieldsAsNull](#indexingindexmissingfieldsasnull) + [Indexing.Lucene.Analyzers.NGram.MaxGram](#indexingluceneanalyzersngrammaxgram) + [Indexing.Lucene.Analyzers.NGram.MinGram](#indexingluceneanalyzersngrammingram) + [Indexing.Lucene.IndexInputType](#indexingluceneindexinputtype) + [Indexing.Lucene.LargeSegmentSizeToMergeInMb](#indexinglucenelargesegmentsizetomergeinmb) + [Indexing.Lucene.MaximumSizePerSegmentInMb](#indexinglucenemaximumsizepersegmentinmb) + [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](#indexinglucenemaxtimeformergestokeeprunninginsec) + [Indexing.Lucene.MergeFactor](#indexinglucenemergefactor) + [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](#indexinglucenenumberoflargesegmentstomergeinsinglebatch) + [Indexing.Lucene.ReaderTermsIndexDivisor](#indexinglucenereadertermsindexdivisor) + [Indexing.Lucene.UseCompoundFileInMerging](#indexingluceneusecompoundfileinmerging) + [Indexing.ManagedAllocationsBatchSizeLimitInMb](#indexingmanagedallocationsbatchsizelimitinmb) + [Indexing.MapBatchSize](#indexingmapbatchsize) + [Indexing.MapTimeoutAfterEtagReachedInMin](#indexingmaptimeoutafteretagreachedinmin) + [Indexing.MapTimeoutInSec](#indexingmaptimeoutinsec) + [Indexing.MaxStepsForScript](#indexingmaxstepsforscript) + [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](#indexingmaxtimefordocumenttransactiontoremainopeninsec) + [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](#indexingmaxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) + [Indexing.Metrics.Enabled](#indexingmetricsenabled) + [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](#indexingminnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) + [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](#indexingminimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) + [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](#indexingnumberofconcurrentstoppedbatchesifrunninglowonmemory) + [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](#indexingnumberoflargesegmentstomergeinsinglebatch) + [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](#indexingorderbyscoreautomaticallywhenboostingisinvolved) + [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](#indexingorderbyticksautomaticallywhendatesareinvolved) + [Indexing.QueryClauseCache.Disabled](#indexingqueryclausecachedisabled) + [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](#indexingqueryclausecacherepeatedqueriestimeframeinsec) + [Indexing.Querying.Corax.NullFirst](#indexingqueryingcoraxnullfirst) + [Indexing.Querying.Corax.NullsSortMode](#indexingqueryingcoraxnullssortmode) + [Indexing.Querying.UseSearchAnalyzerForDynamicFieldsIfNotSetExplicitlyInSearchQuery](#indexingqueryingusesearchanalyzerfordynamicfieldsifnotsetexplicitlyinsearchquery) [Indexing.ScratchSpaceLimitInMb](#indexingscratchspacelimitinmb) + [Indexing.Static.SearchEngineType](#indexingstaticsearchenginetype) + [Indexing.Throttling.TimeIntervalInMs](#indexingthrottlingtimeintervalinms) + [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](#indexingtimesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) + [Indexing.TransactionSizeLimitInMb](#indexingtransactionsizelimitinmb) ## Indexing.CleanupIntervalInMin @@ -748,7 +748,7 @@ EXPERT ONLY: * This configuration applies only to the Lucene indexing engine. * The definition of a large segment in MB. - We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexingnumberoflargesegmentstomergeinsinglebatch) in a single batch. + We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](#indexingnumberoflargesegmentstomergeinsinglebatch) in a single batch. * The default value, which is determined based on your platform details, is set by the constructor of class `IndexingConfiguration`. - **Type**: `int` @@ -811,7 +811,7 @@ EXPERT ONLY: * This configuration applies only to the Lucene indexing engine. -* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglargesegmentsizetomergeinmb) to merge in a single batch. +* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](#indexinglargesegmentsizetomergeinmb) to merge in a single batch. - **Type**: `int` - **Default**: `2` - **Scope**: Server-wide, or per database, or per index @@ -1015,7 +1015,7 @@ Queries that repeat within this time frame will be considered worth caching. OBSOLETE. This key is kept only for backward compatibility. -Use [Indexing.Querying.Corax.NullsSortMode](../../server/configuration/indexing-configuration.mdx#indexingqueryingcoraxnullssortmode) instead. +Use [Indexing.Querying.Corax.NullsSortMode](#indexingqueryingcoraxnullssortmode) instead. * When set, RavenDB maps its value to `Indexing.Querying.Corax.NullsSortMode`: * `true` maps to `NullsSmallest` @@ -1063,11 +1063,11 @@ Use [Indexing.Querying.Corax.NullsSortMode](../../server/configuration/indexing- * `false` (default): The [Default analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) is used to analyze the **query term**. - This analyzer can be configured via the [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. + This analyzer can be configured via the [Indexing.Analyzers.Default](#indexinganalyzersdefault) configuration key. * `true`: The [Default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to analyze the **query term**. - This analyzer can be configured via the [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. + This analyzer can be configured via the [Indexing.Analyzers.Search.Default](#indexinganalyzerssearchdefault) configuration key. * See the table in [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) for the complete analyzer-selection rules based on this configuration key and the analyzer configured for the dynamic index field. diff --git a/docs/server/configuration/logs-configuration.mdx b/docs/server/configuration/logs-configuration.mdx index ad3b76ef50..89abbb5441 100644 --- a/docs/server/configuration/logs-configuration.mdx +++ b/docs/server/configuration/logs-configuration.mdx @@ -20,25 +20,25 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * RavenDB logging configuration keys: - [Logs.ArchiveAboveSizeInMb](../../server/configuration/logs-configuration.mdx#logsarchiveabovesizeinmb) - [Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logsconfigpath) - [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logsenablearchivefilecompression) - [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) - [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) - [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) - [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) - [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) - [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) - [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logsnugetallowprereleasepackages) - [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logsnugetpackagespath) - [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logsnugetpackagesourceurl) - [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) - [Logs.ThrowConfigExceptions](../../server/configuration/logs-configuration.mdx#logsthrowconfigexceptions) + [Logs.ArchiveAboveSizeInMb](#logsarchiveabovesizeinmb) + [Logs.ConfigPath](#logsconfigpath) + [Logs.EnableArchiveFileCompression](#logsenablearchivefilecompression) + [Logs.MaxArchiveDays](#logsmaxarchivedays) + [Logs.MaxArchiveFiles](#logsmaxarchivefiles) + [Logs.Microsoft.Enabled](#logsmicrosoftenabled) + [Logs.Microsoft.MinLevel](#logsmicrosoftminlevel) + [Logs.MinLevel](#logsminlevel) + [Logs.NuGet.AdditionalPackages](#logsnugetadditionalpackages) + [Logs.NuGet.AllowPreReleasePackages](#logsnugetallowprereleasepackages) + [Logs.NuGet.PackagesPath](#logsnugetpackagespath) + [Logs.NuGet.PackageSourceUrl](#logsnugetpackagesourceurl) + [Logs.Path](#logspath) + [Logs.ThrowConfigExceptions](#logsthrowconfigexceptions) * Internal NLog configuration keys: - [Logs.Internal.Level](../../server/configuration/logs-configuration.mdx#logsinternallevel) - [Logs.Internal.LogToStandardError](../../server/configuration/logs-configuration.mdx#logsinternallogtostandarderror) - [Logs.Internal.LogToStandardOutput](../../server/configuration/logs-configuration.mdx#logsinternallogtostandardoutput) - [Logs.Internal.Path](../../server/configuration/logs-configuration.mdx#logsinternalpath) + [Logs.Internal.Level](#logsinternallevel) + [Logs.Internal.LogToStandardError](#logsinternallogtostandarderror) + [Logs.Internal.LogToStandardOutput](#logsinternallogtostandardoutput) + [Logs.Internal.Path](#logsinternalpath) ## Logs.ArchiveAboveSizeInMb diff --git a/docs/server/configuration/memory-configuration.mdx b/docs/server/configuration/memory-configuration.mdx index 0e8aea2947..d6cd233e13 100644 --- a/docs/server/configuration/memory-configuration.mdx +++ b/docs/server/configuration/memory-configuration.mdx @@ -21,12 +21,12 @@ Use the configuration keys listed below to control how your RavenDB server manag Learn how to apply these keys in the [Configuration Overview](../../server/configuration/configuration-options.mdx) article. * On this page: - * [Configuration keys](../../server/configuration/memory-configuration.mdx#configuration-keys) - * [Memory.LowMemoryLimitInMb](../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) - * [Memory.LowMemoryCommitLimitInMb](../../server/configuration/memory-configuration.mdx#memorylowmemorycommitlimitinmb) - * [Memory.MinimumFreeCommittedMemoryPercentage](../../server/configuration/memory-configuration.mdx#memoryminimumfreecommittedmemorypercentage) - * [Memory.MaxFreeCommittedMemoryToKeepInMb](../../server/configuration/memory-configuration.mdx#memorymaxfreecommittedmemorytokeepinmb) - * [Memory.GC.LargeObjectHeapCompactionThresholdPercentage](../../server/configuration/memory-configuration.mdx#memorygclargeobjectheapcompactionthresholdpercentage) + * [Configuration keys](#configuration-keys) + * [Memory.LowMemoryLimitInMb](#memorylowmemorylimitinmb) + * [Memory.LowMemoryCommitLimitInMb](#memorylowmemorycommitlimitinmb) + * [Memory.MinimumFreeCommittedMemoryPercentage](#memoryminimumfreecommittedmemorypercentage) + * [Memory.MaxFreeCommittedMemoryToKeepInMb](#memorymaxfreecommittedmemorytokeepinmb) + * [Memory.GC.LargeObjectHeapCompactionThresholdPercentage](#memorygclargeobjectheapcompactionthresholdpercentage) diff --git a/docs/server/configuration/monitoring-configuration.mdx b/docs/server/configuration/monitoring-configuration.mdx index e6d336ecfa..fefbd00f0c 100644 --- a/docs/server/configuration/monitoring-configuration.mdx +++ b/docs/server/configuration/monitoring-configuration.mdx @@ -16,47 +16,47 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * OpenTelemetry monitoring: - [Monitoring.OpenTelemetry.ConsoleExporter](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryconsoleexporter) - [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) - [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersaspnetcoreenabled) - [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersruntimeenabled) - [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservercpucreditsenabled) - [Monitoring.OpenTelemetry.Meters.Server.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverenabled) - [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergcenabled) - [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergeneralenabled) - [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverrequestsenabled) - [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverresourcesenabled) - [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverstorageenabled) - [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservertotaldatabasesenabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolenabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolexportprocessortype) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolheaders) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolprotocol) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) - [Monitoring.OpenTelemetry.ServiceInstanceId](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryserviceinstanceid) - [Monitoring.OpenTelemetry.ServiceName](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryservicename) - [Monitoring.OpenTelemetry.ServiceNamespace](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryservicenamespace) + [Monitoring.OpenTelemetry.ConsoleExporter](#monitoringopentelemetryconsoleexporter) + [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) + [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](#monitoringopentelemetrymetersaspnetcoreenabled) + [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](#monitoringopentelemetrymetersruntimeenabled) + [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](#monitoringopentelemetrymetersservercpucreditsenabled) + [Monitoring.OpenTelemetry.Meters.Server.Enabled](#monitoringopentelemetrymetersserverenabled) + [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](#monitoringopentelemetrymetersservergcenabled) + [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](#monitoringopentelemetrymetersservergeneralenabled) + [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](#monitoringopentelemetrymetersserverrequestsenabled) + [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](#monitoringopentelemetrymetersserverresourcesenabled) + [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](#monitoringopentelemetrymetersserverstorageenabled) + [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](#monitoringopentelemetrymetersservertotaldatabasesenabled) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](#monitoringopentelemetryopentelemetryprotocolenabled) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](#monitoringopentelemetryopentelemetryprotocolendpoint) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](#monitoringopentelemetryopentelemetryprotocolexportprocessortype) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](#monitoringopentelemetryopentelemetryprotocolheaders) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](#monitoringopentelemetryopentelemetryprotocolprotocol) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](#monitoringopentelemetryopentelemetryprotocoltimeout) + [Monitoring.OpenTelemetry.ServiceInstanceId](#monitoringopentelemetryserviceinstanceid) + [Monitoring.OpenTelemetry.ServiceName](#monitoringopentelemetryservicename) + [Monitoring.OpenTelemetry.ServiceNamespace](#monitoringopentelemetryservicenamespace) * SNMP monitoring - [Monitoring.Snmp.AuthenticationPassword](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpassword) - [Monitoring.Snmp.AuthenticationPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpasswordsecondary) - [Monitoring.Snmp.AuthenticationProtocol](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocol) - [Monitoring.Snmp.AuthenticationProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocolsecondary) - [Monitoring.Snmp.AuthenticationUser](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationuser) - [Monitoring.Snmp.AuthenticationUser.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationusersecondary) - [Monitoring.Snmp.Community](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) - [Monitoring.Snmp.DisableTimeWindowChecks](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpdisabletimewindowchecks) - [Monitoring.Snmp.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpenabled) - [Monitoring.Snmp.Port](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpport) - [Monitoring.Snmp.PrivacyPassword](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypassword) - [Monitoring.Snmp.PrivacyPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypasswordsecondary) - [Monitoring.Snmp.PrivacyProtocol](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocol) - [Monitoring.Snmp.PrivacyProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocolsecondary) - [Monitoring.Snmp.SupportedVersions](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpsupportedversions) + [Monitoring.Snmp.AuthenticationPassword](#monitoringsnmpauthenticationpassword) + [Monitoring.Snmp.AuthenticationPassword.Secondary](#monitoringsnmpauthenticationpasswordsecondary) + [Monitoring.Snmp.AuthenticationProtocol](#monitoringsnmpauthenticationprotocol) + [Monitoring.Snmp.AuthenticationProtocol.Secondary](#monitoringsnmpauthenticationprotocolsecondary) + [Monitoring.Snmp.AuthenticationUser](#monitoringsnmpauthenticationuser) + [Monitoring.Snmp.AuthenticationUser.Secondary](#monitoringsnmpauthenticationusersecondary) + [Monitoring.Snmp.Community](#monitoringsnmpcommunity) + [Monitoring.Snmp.DisableTimeWindowChecks](#monitoringsnmpdisabletimewindowchecks) + [Monitoring.Snmp.Enabled](#monitoringsnmpenabled) + [Monitoring.Snmp.Port](#monitoringsnmpport) + [Monitoring.Snmp.PrivacyPassword](#monitoringsnmpprivacypassword) + [Monitoring.Snmp.PrivacyPassword.Secondary](#monitoringsnmpprivacypasswordsecondary) + [Monitoring.Snmp.PrivacyProtocol](#monitoringsnmpprivacyprotocol) + [Monitoring.Snmp.PrivacyProtocol.Secondary](#monitoringsnmpprivacyprotocolsecondary) + [Monitoring.Snmp.SupportedVersions](#monitoringsnmpsupportedversions) * Other monitoring: - [Monitoring.Cpu.Exec](../../server/configuration/monitoring-configuration.mdx#monitoringcpuexec) - [Monitoring.Cpu.Exec.Arguments](../../server/configuration/monitoring-configuration.mdx#monitoringcpuexecarguments) - [Monitoring.Disk.ReadStatsDebounceTimeInMs](../../server/configuration/monitoring-configuration.mdx#monitoringdiskreadstatsdebouncetimeinms) + [Monitoring.Cpu.Exec](#monitoringcpuexec) + [Monitoring.Cpu.Exec.Arguments](#monitoringcpuexecarguments) + [Monitoring.Disk.ReadStatsDebounceTimeInMs](#monitoringdiskreadstatsdebouncetimeinms) @@ -258,7 +258,7 @@ OpenTelemetryProtocol timeout value. * Sets the OpenTelemetry **service name**. This value is reported as the `service.name` resource attribute and is used to identify the RavenDB service in observability tools, such as the .NET Aspire dashboard. -* If [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) is set to `true`, +* If [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) is set to `true`, the effective value must not be `null`, empty, or whitespace. Otherwise, the server will fail to start. @@ -275,7 +275,7 @@ OpenTelemetryProtocol timeout value. * Sets the OpenTelemetry **service namespace**. This value is reported as the `service.namespace` resource attribute and is used to group related services together in observability tools. -* If [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) is set to `true`, +* If [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) is set to `true`, the effective value must not be `null`, empty, or whitespace. Otherwise, the server will fail to start. diff --git a/docs/server/configuration/patching-configuration.mdx b/docs/server/configuration/patching-configuration.mdx index cedb8d6349..e9f457c995 100644 --- a/docs/server/configuration/patching-configuration.mdx +++ b/docs/server/configuration/patching-configuration.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Set-base patch operations](../../client-api/operations/patching/set-based.mdx) * [Apply patching from the Studio](../../studio/database/documents/patch-view.mdx) * In this article: - * [Patching.AllowStringCompilation](../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) - * [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) - * [Patching.StrictMode](../../server/configuration/patching-configuration.mdx#patchingstrictmode) + * [Patching.AllowStringCompilation](#patchingallowstringcompilation) + * [Patching.MaxStepsForScript](#patchingmaxstepsforscript) + * [Patching.StrictMode](#patchingstrictmode) ## Patching.AllowStringCompilation diff --git a/docs/server/configuration/performance-hints-configuration.mdx b/docs/server/configuration/performance-hints-configuration.mdx index c1ddfa8291..c98583065f 100644 --- a/docs/server/configuration/performance-hints-configuration.mdx +++ b/docs/server/configuration/performance-hints-configuration.mdx @@ -16,15 +16,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [PerformanceHints.Documents.HugeDocumentsCollectionSize](../../server/configuration/performance-hints-configuration.mdx#performancehintsdocumentshugedocumentscollectionsize) - * [PerformanceHints.Documents.HugeDocumentSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehintsdocumentshugedocumentsizeinmb) - * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingalertwhensourcedocumentincludedinoutput) - * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxdepthofrecursioninlinqselect) - * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) - * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxnumberofloadsperreference) - * [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) - * [PerformanceHints.Memory.MinSwapSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehintsmemoryminswapsizeinmb) - * [PerformanceHints.TooLongRequestThresholdInSec](../../server/configuration/performance-hints-configuration.mdx#performancehintstoolongrequestthresholdinsec) + * [PerformanceHints.Documents.HugeDocumentsCollectionSize](#performancehintsdocumentshugedocumentscollectionsize) + * [PerformanceHints.Documents.HugeDocumentSizeInMb](#performancehintsdocumentshugedocumentsizeinmb) + * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](#performancehintsindexingalertwhensourcedocumentincludedinoutput) + * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](#performancehintsindexingmaxdepthofrecursioninlinqselect) + * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](#performancehintsindexingmaxindexoutputsperdocument) + * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](#performancehintsindexingmaxnumberofloadsperreference) + * [PerformanceHints.MaxNumberOfResults](#performancehintsmaxnumberofresults) + * [PerformanceHints.Memory.MinSwapSizeInMb](#performancehintsmemoryminswapsizeinmb) + * [PerformanceHints.TooLongRequestThresholdInSec](#performancehintstoolongrequestthresholdinsec) ## PerformanceHints.Documents.HugeDocumentsCollectionSize diff --git a/docs/server/configuration/security-configuration.mdx b/docs/server/configuration/security-configuration.mdx index 86f12a069c..cc2e78cb64 100644 --- a/docs/server/configuration/security-configuration.mdx +++ b/docs/server/configuration/security-configuration.mdx @@ -20,50 +20,50 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Security.AuditLog: - [Security.AuditLog.EnableArchiveFileCompression](../../server/configuration/security-configuration.mdx#securityauditlogenablearchivefilecompression) - [Security.AuditLog.FolderPath](../../server/configuration/security-configuration.mdx#securityauditlogfolderpath) - [Security.AuditLog.ArchiveAboveSizeInMb](../../server/configuration/security-configuration.mdx#securityauditlogarchiveabovesizeinmb) - [Security.AuditLog.MaxArchiveDays](../../server/configuration/security-configuration.mdx#securityauditlogmaxarchivedays) + [Security.AuditLog.EnableArchiveFileCompression](#securityauditlogenablearchivefilecompression) + [Security.AuditLog.FolderPath](#securityauditlogfolderpath) + [Security.AuditLog.ArchiveAboveSizeInMb](#securityauditlogarchiveabovesizeinmb) + [Security.AuditLog.MaxArchiveDays](#securityauditlogmaxarchivedays) * Security.Certificate: - [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) - [Security.Certificate.Change.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificatechangeexecarguments) - [Security.Certificate.Exec](../../server/configuration/security-configuration.mdx#securitycertificateexec) - [Security.Certificate.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitycertificateexectimeoutinsec) - [Security.Certificate.ExpiringThresholdInDays](../../server/configuration/security-configuration.mdx#securitycertificateexpiringthresholdindays) - [Security.Certificate.LetsEncrypt.Email](../../server/configuration/security-configuration.mdx#securitycertificateletsencryptemail) - [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) - [Security.Certificate.Load.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificateloadexecarguments) - [Security.Certificate.Password](../../server/configuration/security-configuration.mdx#securitycertificatepassword) - [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) - [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) - [Security.Certificate.Renew.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) - [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexec) - [Security.Certificate.Validation.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) - [Security.Certificate.Validation.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexectimeoutinsec) - [Security.Certificate.Validation.KeyUsages](../../server/configuration/security-configuration.mdx#securitycertificatevalidationkeyusages) + [Security.Certificate.Change.Exec](#securitycertificatechangeexec) + [Security.Certificate.Change.Exec.Arguments](#securitycertificatechangeexecarguments) + [Security.Certificate.Exec](#securitycertificateexec) + [Security.Certificate.Exec.TimeoutInSec](#securitycertificateexectimeoutinsec) + [Security.Certificate.ExpiringThresholdInDays](#securitycertificateexpiringthresholdindays) + [Security.Certificate.LetsEncrypt.Email](#securitycertificateletsencryptemail) + [Security.Certificate.Load.Exec](#securitycertificateloadexec) + [Security.Certificate.Load.Exec.Arguments](#securitycertificateloadexecarguments) + [Security.Certificate.Password](#securitycertificatepassword) + [Security.Certificate.Path](#securitycertificatepath) + [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) + [Security.Certificate.Renew.Exec.Arguments](#securitycertificaterenewexecarguments) + [Security.Certificate.Validation.Exec](#securitycertificatevalidationexec) + [Security.Certificate.Validation.Exec.Arguments](#securitycertificatevalidationexecarguments) + [Security.Certificate.Validation.Exec.TimeoutInSec](#securitycertificatevalidationexectimeoutinsec) + [Security.Certificate.Validation.KeyUsages](#securitycertificatevalidationkeyusages) * Security.Csrf: - [Security.Csrf.AdditionalOriginHeaders](../../server/configuration/security-configuration.mdx#securitycsrfadditionaloriginheaders) - [Security.Csrf.Enabled](../../server/configuration/security-configuration.mdx#securitycsrfenabled) - [Security.Csrf.TrustedOrigins](../../server/configuration/security-configuration.mdx#securitycsrftrustedorigins) + [Security.Csrf.AdditionalOriginHeaders](#securitycsrfadditionaloriginheaders) + [Security.Csrf.Enabled](#securitycsrfenabled) + [Security.Csrf.TrustedOrigins](#securitycsrftrustedorigins) * Security.MasterKey: - [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) - [Security.MasterKey.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitymasterkeyexecarguments) - [Security.MasterKey.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitymasterkeyexectimeoutinsec) - [Security.MasterKey.Path](../../server/configuration/security-configuration.mdx#securitymasterkeypath) + [Security.MasterKey.Exec](#securitymasterkeyexec) + [Security.MasterKey.Exec.Arguments](#securitymasterkeyexecarguments) + [Security.MasterKey.Exec.TimeoutInSec](#securitymasterkeyexectimeoutinsec) + [Security.MasterKey.Path](#securitymasterkeypath) * Security.TwoFactor: - [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactordefaultsessiondurationinmin) - [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactormaxsessiondurationinmin) + [Security.TwoFactor.DefaultSessionDurationInMin](#securitytwofactordefaultsessiondurationinmin) + [Security.TwoFactor.MaxSessionDurationInMin](#securitytwofactormaxsessiondurationinmin) * Certificate and issuer validation: - [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) - [Security.WellKnownIssuerHashes.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuerhashesadmin) - [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) - [Security.WellKnownIssuers.Admin.ValidateCertificateNames](../../server/configuration/security-configuration.mdx#securitywellknownissuersadminvalidatecertificatenames) + [Security.WellKnownCertificates.Admin](#securitywellknowncertificatesadmin) + [Security.WellKnownIssuerHashes.Admin](#securitywellknownissuerhashesadmin) + [Security.WellKnownIssuers.Admin](#securitywellknownissuersadmin) + [Security.WellKnownIssuers.Admin.ValidateCertificateNames](#securitywellknownissuersadminvalidatecertificatenames) * Other: - [Security.DisableHsts](../../server/configuration/security-configuration.mdx#securitydisablehsts) - [Security.DisableHttpsRedirection](../../server/configuration/security-configuration.mdx#securitydisablehttpsredirection) - [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror) - [Security.TlsCipherSuites](../../server/configuration/security-configuration.mdx#securitytlsciphersuites) - [Security.UnsecuredAccessAllowed](../../server/configuration/security-configuration.mdx#securityunsecuredaccessallowed) + [Security.DisableHsts](#securitydisablehsts) + [Security.DisableHttpsRedirection](#securitydisablehttpsredirection) + [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](#securitydonotconsidermemorylockfailureascatastrophicerror) + [Security.TlsCipherSuites](#securitytlsciphersuites) + [Security.UnsecuredAccessAllowed](#securityunsecuredaccessallowed) ## Security.AuditLog.EnableArchiveFileCompression @@ -128,7 +128,7 @@ or set it to `null` to refrain from removing audit log files. A command or executable that handles cluster certificate changes. This executable allows you to implement your own custom logic for persisting the new certificate on all nodes. -Note: it will only be triggered if [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) is not defined. +Note: it will only be triggered if [Security.Certificate.Path](#securitycertificatepath) is not defined. - **Type**: `string` - **Default**: `null` @@ -138,7 +138,7 @@ Note: it will only be triggered if [Security.Certificate.Path](../../server/conf ## Security.Certificate.Change.Exec.Arguments -The command line arguments for the [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) command or executable. +The command line arguments for the [Security.Certificate.Change.Exec](#securitycertificatechangeexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -149,9 +149,9 @@ The command line arguments for the [Security.Certificate.Change.Exec](../../serv ## Security.Certificate.Exec Deprecated. -Use [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) -along with [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) -and [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) instead. +Use [Security.Certificate.Load.Exec](#securitycertificateloadexec) +along with [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) +and [Security.Certificate.Change.Exec](#securitycertificatechangeexec) instead. @@ -159,9 +159,9 @@ and [Security.Certificate.Change.Exec](../../server/configuration/security-confi * The number of seconds to wait for the certificate executables to exit. * Applies to: - * [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) - * [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) - * [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) + * [Security.Certificate.Load.Exec](#securitycertificateloadexec) + * [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) + * [Security.Certificate.Change.Exec](#securitycertificatechangeexec) - **Type**: `int` - **Default**: `30` - **Scope**: Server-wide only @@ -194,7 +194,7 @@ Used for renewal requests. * A command or executable that provides the `.pfx` cluster certificate when invoked by RavenDB. If specified, RavenDB will use HTTPS/SSL for all network activities. -* The [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) setting takes precedence over this executable. +* The [Security.Certificate.Path](#securitycertificatepath) setting takes precedence over this executable. * Learn more in [get certificate via loader](../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage). - **Type**: `string` @@ -205,7 +205,7 @@ Used for renewal requests. ## Security.Certificate.Load.Exec.Arguments -The command line arguments for the [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) command or executable. +The command line arguments for the [Security.Certificate.Load.Exec](#securitycertificateloadexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -243,7 +243,7 @@ Certificate setting priority order: * The [leader node](../../server/clustering/rachis/cluster-topology.mdx#leader) will invoke this executable once every hour, and if a new certificate is received, it will be sent to all other nodes. -* The executable specified in [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) +* The executable specified in [Security.Certificate.Change.Exec](#securitycertificatechangeexec) will then be used to persist the certificate across the cluster on all nodes. - **Type**: `string` - **Default**: `null` @@ -253,7 +253,7 @@ Certificate setting priority order: ## Security.Certificate.Renew.Exec.Arguments -The command line arguments for the [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) command or executable. +The command line arguments for the [Security.Certificate.Renew.Exec](#securitycertificaterenewexecarguments) command or executable. - **Type**: `string` - **Default**: `null` @@ -280,7 +280,7 @@ The executable will return a case-insensitive boolean string through the standar EXPERT ONLY: -The optional user arguments for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) command or executable. +The optional user arguments for the [Security.Certificate.Validation.Exec](#securitycertificatevalidationexecarguments) command or executable. The arguments must be escaped for the command line. - **Type**: `string` @@ -291,7 +291,7 @@ The arguments must be escaped for the command line. ## Security.Certificate.Validation.Exec.TimeoutInSec -The number of seconds to wait for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) executable to exit. +The number of seconds to wait for the [Security.Certificate.Validation.Exec](#securitycertificatevalidationexecarguments) executable to exit. - **Type**: `int` - **Default**: `5` @@ -356,7 +356,7 @@ If specified, RavenDB will use this key to protect secrets. ## Security.MasterKey.Exec.Arguments -The command line arguments for the [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) command or executable. +The command line arguments for the [Security.MasterKey.Exec](#securitymasterkeyexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -423,7 +423,7 @@ Specify well-known certificate thumbprints that will be trusted by the server as OBSOLETE. This is no longer supported or used. -Use [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) instead. +Use [Security.WellKnownIssuers.Admin](#securitywellknownissuersadmin) instead. diff --git a/docs/server/configuration/server-configuration.mdx b/docs/server/configuration/server-configuration.mdx index 2a7adeb5ae..0daf6830da 100644 --- a/docs/server/configuration/server-configuration.mdx +++ b/docs/server/configuration/server-configuration.mdx @@ -18,12 +18,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Various configuration options for the server's behavior. * In this page: - * [Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec](../../server/configuration/server-configuration.mdx#servermaxtimefortasktowaitfordatabasetoloadinsec) - * [Server.ProcessAffinityMask](../../server/configuration/server-configuration.mdx#serverprocessaffinitymask) - * [Server.IndexingAffinityMask](../../server/configuration/server-configuration.mdx#serverindexingaffinitymask) - * [Server.NumberOfUnusedCoresByIndexes](../../server/configuration/server-configuration.mdx#servernumberofunusedcoresbyindexes) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../../server/configuration/server-configuration.mdx#servercpucreditsexhaustionbackupdelayinmin) - * [Server.Tcp.Compression.Disable](../../server/configuration/server-configuration.mdx#servertcpcompressiondisable) + * [Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec](#servermaxtimefortasktowaitfordatabasetoloadinsec) + * [Server.ProcessAffinityMask](#serverprocessaffinitymask) + * [Server.IndexingAffinityMask](#serverindexingaffinitymask) + * [Server.NumberOfUnusedCoresByIndexes](#servernumberofunusedcoresbyindexes) + * [Server.CpuCredits.ExhaustionBackupDelayInMin](#servercpucreditsexhaustionbackupdelayinmin) + * [Server.Tcp.Compression.Disable](#servertcpcompressiondisable) ## Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec diff --git a/docs/server/configuration/subscription-configuration.mdx b/docs/server/configuration/subscription-configuration.mdx index d52a001d98..f28c0a1ba0 100644 --- a/docs/server/configuration/subscription-configuration.mdx +++ b/docs/server/configuration/subscription-configuration.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more about subscriptions in [Data subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx). * In this article: - * [Subscriptions.ArchivedDataProcessingBehavior](../../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) - * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptionsmaxnumberofconcurrentconnections) + * [Subscriptions.ArchivedDataProcessingBehavior](#subscriptionsarchiveddataprocessingbehavior) + * [Subscriptions.MaxNumberOfConcurrentConnections](#subscriptionsmaxnumberofconcurrentconnections) diff --git a/docs/server/content/_embedded-csharp.mdx b/docs/server/content/_embedded-csharp.mdx index 6613c7a0e4..9c02d1a8ab 100644 --- a/docs/server/content/_embedded-csharp.mdx +++ b/docs/server/content/_embedded-csharp.mdx @@ -9,22 +9,22 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../server/embedded.mdx#overview) - * [Prerequisites and Recommendations](../../server/embedded.mdx#prerequisites-and-recommendations) - * [Installation](../../server/embedded.mdx#installation) - * [Starting the server](../../server/embedded.mdx#starting-the-server) - * [Server options](../../server/embedded.mdx#server-options) - * [Setting server directory](../../server/embedded.mdx#setting-server-directory) - * [Restarting the server](../../server/embedded.mdx#restarting-the-server) - * [ServerProcessExited Event](../../server/embedded.mdx#serverprocessexited-event) - * [Embedded server licensing](../../server/embedded.mdx#embedded-server-licensing) - * [Licensing configuration options](../../server/embedded.mdx#licensing-configuration-options) - * [License an embedded server using an Environment variable](../../server/embedded.mdx#license-an-embedded-server-using-an-environment-variable) - * [`.NET` FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) - * [Security](../../server/embedded.mdx#security) - * [Document store](../../server/embedded.mdx#document-store) - * [Get server URL and process ID](../../server/embedded.mdx#get-server-url-and-process-id) - * [Remarks](../../server/embedded.mdx#remarks) + * [Overview](#overview) + * [Prerequisites and Recommendations](#prerequisites-and-recommendations) + * [Installation](#installation) + * [Starting the server](#starting-the-server) + * [Server options](#server-options) + * [Setting server directory](#setting-server-directory) + * [Restarting the server](#restarting-the-server) + * [ServerProcessExited Event](#serverprocessexited-event) + * [Embedded server licensing](#embedded-server-licensing) + * [Licensing configuration options](#licensing-configuration-options) + * [License an embedded server using an Environment variable](#license-an-embedded-server-using-an-environment-variable) + * [`.NET` FrameworkVersion](#net-frameworkversion) + * [Security](#security) + * [Document store](#document-store) + * [Get server URL and process ID](#get-server-url-and-process-id) + * [Remarks](#remarks) ## Overview @@ -67,14 +67,14 @@ using (var store = await EmbeddedServer.Instance.GetDocumentStoreAsync("Embedded * **Prerequisites** * Install [`.NET` Core runtime](https://dotnet.microsoft.com/en-us/download), - either manually or [along with a RavenDB full version](../embedded.mdx#setting-server-directory). - * Verify that the RavenDB server [FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) + either manually or [along with a RavenDB full version](#setting-server-directory). + * Verify that the RavenDB server [FrameworkVersion](#net-frameworkversion) definition matches the `.NET` Core version that you install. * **Recommendations** * Projects targeting `.NET Framework 4.6.1+` that use the old `packages.config` for NuGet packages maintenance, should migrate to `PackageReference` package management. - Find additional details [below](../../server/embedded.mdx#migrating-from--to--in-old-csproj-projects). + Find additional details [below](#migrating-from--to--in-old-csproj-projects). ### `.NET` Core Runtime: RavenDB Embedded **does not include** the `.NET` Core runtime engine required for its operation. @@ -175,7 +175,7 @@ and additional options. | **ServerUrl** | `string` | What address we want to start our server (default `127.0.0.1:0`) | | **MaxServerStartupTimeDuration** | `TimeSpan` | The timeout for the server to start | | **CommandLineArgs** | `List` | The [command lines arguments](../../server/configuration/configuration-options.mdx#command-line-arguments) to start the server with | -| **ServerDirectory** | `string` | The path to the server binary files<sup>[*](../../server/embedded.mdx#setting-server-directory) | +| **ServerDirectory** | `string` | The path to the server binary files<sup>[*](#setting-server-directory) | diff --git a/docs/server/extensions/content/_expiration-csharp.mdx b/docs/server/extensions/content/_expiration-csharp.mdx index 2652a382ec..a34339b38d 100644 --- a/docs/server/extensions/content/_expiration-csharp.mdx +++ b/docs/server/extensions/content/_expiration-csharp.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * You can enable or disable the expiration feature while the database is already live with data. * In this page: - * [Expiration feature usages](../../../server/extensions/expiration.mdx#expiration-feature-usages) - * [Configuring the expiration feature](../../../server/extensions/expiration.mdx#configuring-the-expiration-feature) - * [Configure expiration settings using the client API](../../../server/extensions/expiration.mdx#configure-expiration-settings-using-the-client-api) - * [Setting the document expiration time](../../../server/extensions/expiration.mdx#setting-the-document-expiration-time) - * [Eventual consistency considerations](../../../server/extensions/expiration.mdx#eventual-consistency-considerations) + * [Expiration feature usages](#expiration-feature-usages) + * [Configuring the expiration feature](#configuring-the-expiration-feature) + * [Configure expiration settings using the client API](#configure-expiration-settings-using-the-client-api) + * [Setting the document expiration time](#setting-the-document-expiration-time) + * [Eventual consistency considerations](#eventual-consistency-considerations) ## Expiration feature usages @@ -101,7 +101,7 @@ object and sending it to RavenDB using a `ConfigureExpirationOperation` operatio * If and when the expiration feature is enabled, it will process all documents carrying the `@expires` flag and automatically delete each document - [by its expiration time](../../../server/extensions/expiration.mdx#eventual-consistency-considerations). + [by its expiration time](#eventual-consistency-considerations). * To set the document expiration time from the client, use the following code: diff --git a/docs/server/extensions/content/_refresh-csharp.mdx b/docs/server/extensions/content/_refresh-csharp.mdx index 7b5e51c496..84dda44c34 100644 --- a/docs/server/extensions/content/_refresh-csharp.mdx +++ b/docs/server/extensions/content/_refresh-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Refresh is scheduled using the `@refresh` flag in a document's [metadata](../../../client-api/session/how-to/get-and-modify-entity-metadata.mdx). * In this page: - * [Overview](../../../server/extensions/refresh.mdx#overview) - * [Examples](../../../server/extensions/refresh.mdx#examples) - * [Syntax](../../../server/extensions/refresh.mdx#syntax) - * [Configure from Studio](../../../server/extensions/refresh.mdx#configure-from-studio) + * [Overview](#overview) + * [Examples](#examples) + * [Syntax](#syntax) + * [Configure from Studio](#configure-from-studio) @@ -35,7 +35,7 @@ import CodeBlock from '@theme/CodeBlock'; 1. The refresh time value set for the `@refresh` property. - 2. The way you set the [Refresh Configuration](../../../server/extensions/refresh.mdx#syntax), + 2. The way you set the [Refresh Configuration](#syntax), including - - The interval by which the server refreshes documents (set by default to 60 seconds). - The way you set **maximal items to process**, potentially limiting the number diff --git a/docs/server/kb/content/_document-identifier-generation-csharp.mdx b/docs/server/kb/content/_document-identifier-generation-csharp.mdx index ede36ea509..d938fda326 100644 --- a/docs/server/kb/content/_document-identifier-generation-csharp.mdx +++ b/docs/server/kb/content/_document-identifier-generation-csharp.mdx @@ -15,18 +15,18 @@ import Panel from '@site/src/components/Panel'; To create a document from the Studio, see [Create new document](../../../studio/database/documents/create-new-document.mdx#create-new-document). * In this article: - * [Overview](../../../server/kb/document-identifier-generation.mdx#overview) - * [ID types](../../../server/kb/document-identifier-generation.mdx#id-types) - * [ID structure](../../../server/kb/document-identifier-generation.mdx#id-structure) - * [ID limitations](../../../server/kb/document-identifier-generation.mdx#id-limitations) - * [Document IDs:](../../../server/kb/document-identifier-generation.mdx#document-ids) - * [Semantic ID](../../../server/kb/document-identifier-generation.mdx#semantic-id) - * [GUID](../../../server/kb/document-identifier-generation.mdx#guid) - * [Server-side ID](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * [Identity ID](../../../server/kb/document-identifier-generation.mdx#identity-id) - * [HiLo algorithm ID](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) - * [Artificial document ID](../../../server/kb/document-identifier-generation.mdx#artificial-document-id) - * [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character) + * [Overview](#overview) + * [ID types](#id-types) + * [ID structure](#id-structure) + * [ID limitations](#id-limitations) + * [Document IDs:](#document-ids) + * [Semantic ID](#semantic-id) + * [GUID](#guid) + * [Server-side ID](#server-side-id) + * [Identity ID](#identity-id) + * [HiLo algorithm ID](#hilo-algorithm-id) + * [Artificial document ID](#artificial-document-id) + * [Customizing the separator character](#customizing-the-separator-character) @@ -39,22 +39,22 @@ RavenDB supports several document ID types, where the ID string can be generated * **Defined by the user**: You explicitly specify the document ID. - * [Semantic ID](../../../server/kb/document-identifier-generation.mdx#semantic-id) + * [Semantic ID](#semantic-id) * **Generated by the server**: The server generates the document ID based on the ID string format you provide when creating the document. - * [GUID](../../../server/kb/document-identifier-generation.mdx#guid) - * [Server-side ID](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * [Identity ID](../../../server/kb/document-identifier-generation.mdx#identity-id) + * [GUID](#guid) + * [Server-side ID](#server-side-id) + * [Identity ID](#identity-id) * **Generated by the client (from a range provided by the server)**: The server assigns a range of IDs to the client upon request. The client then uses that range to generate document IDs locally within the session. - * [HiLo algorithm ID](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) + * [HiLo algorithm ID](#hilo-algorithm-id) * **Generated from a Map-Reduce index output**: The ID is generated by the server when saving map-reduce results as artificial documents. - * [Artificial document ID](../../../server/kb/document-identifier-generation.mdx#artificial-document-id) + * [Artificial document ID](#artificial-document-id) @@ -67,9 +67,9 @@ For example: `users/123-A` (HiLo ID), or `users/000000000001-A` (Server-side ID) This structure is common but not mandatory: * RavenDB does not require the ID to include a collection prefix. - * The default slash separator (`/`) can be **customized** for [HiLo IDs](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) - and [Identity IDs](../../../server/kb/document-identifier-generation.mdx#identity-id). - See [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character) below. + * The default slash separator (`/`) can be **customized** for [HiLo IDs](#hilo-algorithm-id) + and [Identity IDs](#identity-id). + See [Customizing the separator character](#customizing-the-separator-character) below. @@ -80,8 +80,8 @@ The following limitations apply to document IDs: * Maximum length: `512` bytes (in UTF-8) * Document IDs cannot end with the following reserved characters: - * `/` - reserved for [Server-side ID generation](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * `|` - reserved for [Identity ID generation](../../../server/kb/document-identifier-generation.mdx#identity-id) + * `/` - reserved for [Server-side ID generation](#server-side-id) + * `|` - reserved for [Identity ID generation](#identity-id) @@ -230,7 +230,7 @@ using (var session = store.OpenSession()) The leading zeros in server-side generated IDs help reduce the risk of such accidental collisions. * **Customizing the separator character**: - The separator character can be customized. See: [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + The separator character can be customized. See: [Customizing the separator character](#customizing-the-separator-character). If it was modified (e.g., to `$`), you must end your ID string with that character instead of `/`. --- @@ -308,7 +308,7 @@ using (var session = store.OpenSession()) * **Customizing the separator character**: The separator character used in the identity IDs can be customized. - Learn more in [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + Learn more in [Customizing the separator character](#customizing-the-separator-character). * **Customizing the identity number**: The numeric part of an identity ID is an always-incrementing value managed by the server. @@ -375,7 +375,7 @@ using (var session = store.OpenSession()) * **Customizing the separator character**: The separator character used in the HiLo document IDs can be customized. - Learn more in [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + Learn more in [Customizing the separator character](#customizing-the-separator-character). --- @@ -425,8 +425,8 @@ using (var session = store.OpenSession()) -The separator character used in the [Identity](../../../server/kb/document-identifier-generation.mdx#identity-id), -[HiLo](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id), and [Server-side](../../../server/kb/document-identifier-generation.mdx#server-side-id) document IDs can be customized. +The separator character used in the [Identity](#identity-id), +[HiLo](#hilo-algorithm-id), and [Server-side](#server-side-id) document IDs can be customized. By default, the separator is a _slash_ (`/`), but this can be changed to any other character, except _pipe_ (`|`). There are several ways to customize the separator. diff --git a/docs/server/kb/javascript-engine.mdx b/docs/server/kb/javascript-engine.mdx index cb97d5cfa1..cd9cd145e7 100644 --- a/docs/server/kb/javascript-engine.mdx +++ b/docs/server/kb/javascript-engine.mdx @@ -30,8 +30,8 @@ import ContentFrame from "@site/src/components/ContentFrame"; RavenDB uses [Jint](https://github.com/sebastienros/jint), an open source JavaScript interpreter supporting ECMAScript 5.1. * In this article: - * [How RavenDB uses Jint](../../server/kb/javascript-engine.mdx#how-ravendb-uses-jint) - * [Predefined JavaScript functions](../../server/kb/javascript-engine.mdx#predefined-javascript-functions) + * [How RavenDB uses Jint](#how-ravendb-uses-jint) + * [Predefined JavaScript functions](#predefined-javascript-functions) * [Document operations](../../server/kb/javascript-engine#document-operations) * [Counter operations](../../server/kb/javascript-engine#counter-operations) * [Time series operations](../../server/kb/javascript-engine#time-series-operations) diff --git a/docs/server/kb/numbers-in-ravendb.mdx b/docs/server/kb/numbers-in-ravendb.mdx index 2e9e8fc491..e2a12d7ac6 100644 --- a/docs/server/kb/numbers-in-ravendb.mdx +++ b/docs/server/kb/numbers-in-ravendb.mdx @@ -25,12 +25,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [About numbers](../../server/kb/numbers-in-ravendb.mdx#about-numbers) -* [Numbers in documents](../../server/kb/numbers-in-ravendb.mdx#numbers-in-documents) -* [Numbers in JavaScript](../../server/kb/numbers-in-ravendb.mdx#numbers-in-javascript-engine) -* [Numbers in indexes and queries](../../server/kb/numbers-in-ravendb.mdx#numbers-in-indexes-and-queries) -* [Numbers in studio](../../server/kb/numbers-in-ravendb.mdx#numbers-in-management-studio) -* [Numbers in client API](../../server/kb/numbers-in-ravendb.mdx#numbers-in-client-api) +* [About numbers](#about-numbers) +* [Numbers in documents](#numbers-in-documents) +* [Numbers in JavaScript](#numbers-in-javascript-engine) +* [Numbers in indexes and queries](#numbers-in-indexes-and-queries) +* [Numbers in studio](#numbers-in-management-studio) +* [Numbers in client API](#numbers-in-client-api) diff --git a/docs/server/ongoing-tasks/etl/basics.mdx b/docs/server/ongoing-tasks/etl/basics.mdx index a269723d89..2ea60b16d4 100644 --- a/docs/server/ongoing-tasks/etl/basics.mdx +++ b/docs/server/ongoing-tasks/etl/basics.mdx @@ -30,13 +30,13 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more about how ETL works on a sharded database [here](../../../sharding/etl.mdx). * In this article: - * [Why use ETL](../../../server/ongoing-tasks/etl/basics.mdx#why-use-etl) - * [Defining ETL Tasks](../../../server/ongoing-tasks/etl/basics.mdx#defining-etl-tasks) - * [ETL Stages:](../../../server/ongoing-tasks/etl/basics.mdx#etl-stages) - * [Extract](../../../server/ongoing-tasks/etl/basics.mdx#extract) - * [Transform](../../../server/ongoing-tasks/etl/basics.mdx#transform) - * [Load](../../../server/ongoing-tasks/etl/basics.mdx#load) - * [Troubleshooting](../../../server/ongoing-tasks/etl/basics.mdx#troubleshooting) + * [Why use ETL](#why-use-etl) + * [Defining ETL Tasks](#defining-etl-tasks) + * [ETL Stages:](#etl-stages) + * [Extract](#extract) + * [Transform](#transform) + * [Load](#load) + * [Troubleshooting](#troubleshooting) @@ -90,9 +90,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; ETL's three stages are: -* [Extract](../../../server/ongoing-tasks/etl/basics.mdx#extract) - Extract the documents from the database -* [Transform](../../../server/ongoing-tasks/etl/basics.mdx#transform) - Transform & filter the documents data according to the supplied script (optional) -* [Load](../../../server/ongoing-tasks/etl/basics.mdx#load) - Load (write) the transformed data into the target destination +* [Extract](#extract) - Extract the documents from the database +* [Transform](#transform) - Transform & filter the documents data according to the supplied script (optional) +* [Load](#load) - Load (write) the transformed data into the target destination --- @@ -162,7 +162,7 @@ These are not part of the general JavaScript engine and **apply to ETL scripts o | Function / Member | Type | Description | |-----------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `loadTo` | function | Loads an object to the specified target. An object will only be sent to the destination if this method is called.
This command has several syntax options,
see [The loadTo method](../../../server/ongoing-tasks/etl/basics.mdx#theloadtomethod) below. | +| `loadTo` | function | Loads an object to the specified target. An object will only be sent to the destination if this method is called.
This command has several syntax options,
see [The loadTo method](#theloadtomethod) below. | | **Attachments:** | | | | `loadAttachment(name)` | function | Loads an attachment of the current document. | | `hasAttachment(name)` | function | Returns `true` if an attachment with the given name exists on the current document. | diff --git a/docs/server/ongoing-tasks/etl/elasticsearch.mdx b/docs/server/ongoing-tasks/etl/elasticsearch.mdx index 51750436aa..12b9f1e339 100644 --- a/docs/server/ongoing-tasks/etl/elasticsearch.mdx +++ b/docs/server/ongoing-tasks/etl/elasticsearch.mdx @@ -22,39 +22,39 @@ import LanguageContent from "@site/src/components/LanguageContent"; or your [client](../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-elasticsearch-etl-task). * In this page: - * [Elasticsearch ETL](../../../server/ongoing-tasks/etl/elasticsearch.mdx#elasticsearch-etl) - * [Transformation Script](../../../server/ongoing-tasks/etl/elasticsearch.mdx#transformation-script) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/elasticsearch.mdx#alternative-syntax) - * [Data Delivery](../../../server/ongoing-tasks/etl/elasticsearch.mdx#data-delivery) - * [What is Transferred](../../../server/ongoing-tasks/etl/elasticsearch.mdx#what-is-transferred) - * [Document Identifiers](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) - * [Transactions](../../../server/ongoing-tasks/etl/elasticsearch.mdx#transactions) - * [Insert Only Mode](../../../server/ongoing-tasks/etl/elasticsearch.mdx#insert-only-mode) - * [Elasticsearch Index Definition](../../../server/ongoing-tasks/etl/elasticsearch.mdx#elasticsearch-index-definition) - * [Client API](../../../server/ongoing-tasks/etl/elasticsearch.mdx#client-api) - * [Add an Elasticsearch ETL Task](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) - * [Add an Elasticsearch Connection String](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) - * [Supported Elasticsearch Versions](../../../server/ongoing-tasks/etl/elasticsearch.mdx#supported-elasticsearch-versions) + * [Elasticsearch ETL](#elasticsearch-etl) + * [Transformation Script](#transformation-script) + * [Alternative Syntax](#alternative-syntax) + * [Data Delivery](#data-delivery) + * [What is Transferred](#what-is-transferred) + * [Document Identifiers](#document-identifiers) + * [Transactions](#transactions) + * [Insert Only Mode](#insert-only-mode) + * [Elasticsearch Index Definition](#elasticsearch-index-definition) + * [Client API](#client-api) + * [Add an Elasticsearch ETL Task](#add-an-elasticsearch-etl-task) + * [Add an Elasticsearch Connection String](#add-an-elasticsearch-connection-string) + * [Supported Elasticsearch Versions](#supported-elasticsearch-versions) ## Elasticsearch ETL * The following steps are required when creating an Elasticsearch ETL task: - * Define a [connection string](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) which includes: + * Define a [connection string](#add-an-elasticsearch-connection-string) which includes: * URLs to Elasticsearch nodes. * Authentication method required by the Elasticsearch nodes. * **Define the Elasticsearch Indexes** * Indexes are used by Elasticsearch to store and locate documents. * The ETL task will send new documents to the specified Elasticsearch indexes. * If not otherwise specified, existing Elasticsearch documents will be removed before adding new documents. - * A [document identifier](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) + * A [document identifier](#document-identifiers) field property is defined per document, and used by the delete command to locate the matching documents. * **Define Transformation Scripts**. The transformation script determines which RavenDB documents will be transferred, to which Elasticsearch Indexes, and in what form. * For a thorough step-by-step explanation: - * Learn [here](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) + * Learn [here](#add-an-elasticsearch-etl-task) to define an Elasticsearch ETL task using **code**. * Learn [here](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx) to define an Elasticsearch ETL task using **Studio**. @@ -149,7 +149,7 @@ adToOrders(orderData); * In addition to specifying this document property in the script, it must be defined for the ETL task: - * Either set `DocumentIdProperty` through code (see [code sample](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task)), + * Either set `DocumentIdProperty` through code (see [code sample](#add-an-elasticsearch-etl-task)), * or Set the [Document ID Property Name](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) field via Studio. ### Transactions @@ -177,7 +177,7 @@ OrderLinesCount":3,"TotalCost":0,"DocID":"orders/1-a"\} ### Insert Only Mode -You can enable the task's **Insert Only** mode using [code](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) +You can enable the task's **Insert Only** mode using [code](#add-an-elasticsearch-etl-task) or via [Studio](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes), to **omit** _delete_by_query commands and so refrain from deleting documents before the transfer. @@ -236,7 +236,7 @@ as **"keyword"** in your index definition. Pass it an `ElasticSearchEtlConfiguration`instance with - * The name of a defined **Connection String**. You can define a connection string - [using code](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) + [using code](#add-an-elasticsearch-connection-string) or via [Studio](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#define-the-elasticsearch-etl-task). * A list of **Elasticsearch Indexes**. * A list of **Transformation Scripts**. @@ -310,7 +310,7 @@ store.Maintenance.Send(operation); | Property | Type | Description | |:-------------|:-------------|:-------------| | **IndexName** | `string` | Elasticsearch Index name.
Name indexes **using lower-case characters only**, e.g. `orders`. | - | **DocumentIdProperty** | `string` | The [document ID property](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) defined on the transferred document object inside the transformation script. | + | **DocumentIdProperty** | `string` | The [document ID property](#document-identifiers) defined on the transferred document object inside the transformation script. | | **InsertOnlyMode** | `bool` | `true` - Do not delete existing documents before appending new ones.
`false` - Delete existing document versions before appending documents.| diff --git a/docs/server/ongoing-tasks/etl/olap.mdx b/docs/server/ongoing-tasks/etl/olap.mdx index 2ac428fce1..94d092733c 100644 --- a/docs/server/ongoing-tasks/etl/olap.mdx +++ b/docs/server/ongoing-tasks/etl/olap.mdx @@ -34,10 +34,10 @@ an alternative to CSV that is much faster to query. Unlike CSV, Parquet groups t column (by field) instead of by row (by document). * In this page: - * [Client API](../../../server/ongoing-tasks/etl/olap.mdx#client-api) - * [Transform Script](../../../server/ongoing-tasks/etl/olap.mdx#transform-script) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/olap.mdx#alternative-syntax) - * [Athena Examples](../../../server/ongoing-tasks/etl/olap.mdx#athena-examples) + * [Client API](#client-api) + * [Transform Script](#transform-script) + * [Alternative Syntax](#alternative-syntax) + * [Athena Examples](#athena-examples) ## Client API @@ -88,7 +88,7 @@ AddEtlOperationResult result = store.Maintenance.Send(operation); | Property | Type | Description | | - | - | - | | `RunFrequency` | `string` | Takes a [cron expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm) which determines how often the server will execute the ETL process. | -| `CustomPartitionValue` | `string` | A value that can be used as a partition name in multiple scripts. See [below](../../../server/ongoing-tasks/etl/olap.mdx#the-custom-partition-value). | +| `CustomPartitionValue` | `string` | A value that can be used as a partition name in multiple scripts. See [below](#the-custom-partition-value). | | `OlapTables` | `List` | List of naming configurations for individual tables. See more details below. | #### `OlapConnectionString` @@ -290,7 +290,7 @@ using this syntax: `loadTo('folder_name', key, object)` #### The Custom Partition Value The custom partition value is a string value that can be set in the -[`OlapEtlConfiguration` object](../../../server/ongoing-tasks/etl/olap.mdx#section). This value can be +[`OlapEtlConfiguration` object](#section). This value can be referenced in the transform script as `$customPartitionValue`. This setting gives you another way to distinguish data from different ETL tasks that use the same transform script. diff --git a/docs/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx b/docs/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx index 71f2e0f63a..996ce182d5 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx @@ -34,21 +34,21 @@ For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../ * In this page: - * [RavenDB ETL and Amazon SQS](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#ravendb-etl-and-amazon-sqs) - * [Queue methods](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#queue-methods) - * [Standard queueing](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#standard-queueing) - * [FIFO queueing](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#fifo-queueing) - * [Caution: ETL message size -vs- Queue message size](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#caution-etl-message-size--vs--queue-message-size) - * [Add an Amazon SQS connection string](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#add-an-amazon-sqs-connection-string) - * [Authentication methods](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#authentication-methods) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#syntax) - * [Add an Amazon SQS ETL task](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#add-an-amazon-sqs-etl-task) - * [Example: Add SQS ETL task](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#example-add-sqs-etl-task) - * [Delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#the-loadto-method) + * [RavenDB ETL and Amazon SQS](#ravendb-etl-and-amazon-sqs) + * [Queue methods](#queue-methods) + * [Standard queueing](#standard-queueing) + * [FIFO queueing](#fifo-queueing) + * [Caution: ETL message size -vs- Queue message size](#caution-etl-message-size--vs--queue-message-size) + * [Add an Amazon SQS connection string](#add-an-amazon-sqs-connection-string) + * [Authentication methods](#authentication-methods) + * [Example](#example) + * [Syntax](#syntax) + * [Add an Amazon SQS ETL task](#add-an-amazon-sqs-etl-task) + * [Example: Add SQS ETL task](#example-add-sqs-etl-task) + * [Delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) ## RavenDB ETL and Amazon SQS @@ -91,7 +91,7 @@ the delivery of each message exactly once, in exchange for a much slower transfe than that of the Standard Queueing method. To load messages to a FIFO queue, add `.fifo` to the queue name while calling the -transformation script's [loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#the-loadto-method): +transformation script's [loadTo method](#the-loadto-method): {`Script = @"// Create an orderData object @@ -451,7 +451,7 @@ Source: '/promotion-campaigns/summer-sale' like `'-'` and `'.'` in target names. This is not possible when the `loadTo<QueueName>` syntax is used because including special characters in the name of a JavaScript function makes it invalid. - * To deliver messages to a [FIFO queue](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#fifo-queueing), + * To deliver messages to a [FIFO queue](#fifo-queueing), use this format and add `.fifo` to the queue name. `loadTo('QueueName.fifo', obj, {attributes})` diff --git a/docs/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx b/docs/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx index dc5d51655f..4049943386 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx @@ -38,16 +38,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this page: - * [Add an Azure Queue Storage connection string](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#add-an-azure-queue-storage-connection-string) - * [Authentication methods](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#authentication-methods) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#syntax) - * [Add an Azure Queue Storage ETL task](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#add-an-azure-queue-storage-etl-task) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#example-basic) - * [Delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-loadto-method) + * [Add an Azure Queue Storage connection string](#add-an-azure-queue-storage-connection-string) + * [Authentication methods](#authentication-methods) + * [Example](#example) + * [Syntax](#syntax) + * [Add an Azure Queue Storage ETL task](#add-an-azure-queue-storage-etl-task) + * [Example](#example-basic) + * [Delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) ## Add an Azure Queue Storage connection string @@ -173,7 +173,7 @@ public class Passwordless * Extract source documents from the "Orders" collection in RavenDB. * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersQueue" in an Azure Queue Storage. -* For more details about the script and the `loadTo` method, see the [transformation script](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-transformation-script) section below. +* For more details about the script and the `loadTo` method, see the [transformation script](#the-transformation-script) section below. diff --git a/docs/server/ongoing-tasks/etl/queue-etl/kafka.mdx b/docs/server/ongoing-tasks/etl/queue-etl/kafka.mdx index c808cc13e1..d27c6b8317 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/kafka.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/kafka.mdx @@ -36,26 +36,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this article: - * [Setup workflow](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#setup-workflow) - * [Creating a Kafka ETL task using the Client API](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#creating-a-kafka-etl-task-using-the-client-api) - * [Add a Kafka connection string](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#add-a-kafka-connection-string) - * [Example: connecting to a secure Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-secure-kafka-cluster) - * [Use RavenDB Certificate](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#use-ravendb-certificate) - * [Add a Kafka ETL task](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#add-a-kafka-etl-task) - * [Example: basic](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-basic) - * [Example: delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#delete-processed-documents) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-loadto-method) - * [Prerequisites for a secure Kafka server](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#prerequisites-for-a-secure-kafka-server) - * [What needs to be granted](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#what-needs-to-be-granted) - * [Computing the transactional IDs](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#computing-the-transactional-ids) - * [Example: building the transactional ID](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-building-the-transactional-id) - * [Entering the grants on the Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#entering-the-grants-on-the-kafka-cluster) - * [Single-node Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#single-node-kafka-cluster) - * [SSL/TLS required for encrypted RavenDB databases](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#ssl-tls-for-encrypted-databases) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#syntax) - * [Connection string classes](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#connection-string-classes) - * [ETL task classes](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#etl-task-classes) + * [Setup workflow](#setup-workflow) + * [Creating a Kafka ETL task using the Client API](#creating-a-kafka-etl-task-using-the-client-api) + * [Add a Kafka connection string](#add-a-kafka-connection-string) + * [Example: connecting to a secure Kafka cluster](#example-secure-kafka-cluster) + * [Use RavenDB Certificate](#use-ravendb-certificate) + * [Add a Kafka ETL task](#add-a-kafka-etl-task) + * [Example: basic](#example-basic) + * [Example: delete processed documents](#delete-processed-documents) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) + * [Prerequisites for a secure Kafka server](#prerequisites-for-a-secure-kafka-server) + * [What needs to be granted](#what-needs-to-be-granted) + * [Computing the transactional IDs](#computing-the-transactional-ids) + * [Example: building the transactional ID](#example-building-the-transactional-id) + * [Entering the grants on the Kafka cluster](#entering-the-grants-on-the-kafka-cluster) + * [Single-node Kafka cluster](#single-node-kafka-cluster) + * [SSL/TLS required for encrypted RavenDB databases](#ssl-tls-for-encrypted-databases) + * [Syntax](#syntax) + * [Connection string classes](#connection-string-classes) + * [ETL task classes](#etl-task-classes) @@ -193,7 +193,7 @@ In this example, the Kafka ETL Task will: * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersTopic" in a Kafka broker. -For more details about the script and the `loadTo` method, see [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-transformation-script) below. +For more details about the script and the `loadTo` method, see [The transformation script](#the-transformation-script) below. ```csharp // Define a transformation script for the task: diff --git a/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx b/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx index 572024f97d..15c31bb2ab 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -33,19 +33,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Azure Queue Storage** * **Amazon SQS** -* This functionality is achieved by defining [Queue ETL tasks](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#queue-etl-tasks) within a RavenDB database. +* This functionality is achieved by defining [Queue ETL tasks](#queue-etl-tasks) within a RavenDB database. * RavenDB can also function as a _Consumer_. To learn about RavenDB's role as a _Consumer_ please refer to the [Queue Sink section](../../../../server/ongoing-tasks/queue-sink/overview.mdx). * In this page: - * [Queue ETL tasks](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#queue-etl-tasks) - * [Data delivery](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#data-delivery) - * [What is transferred](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#what-is-transferred) - * [How are messages produced and consumed](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#how-are-messages-produced-and-consumed) - * [Idempotence and message duplication](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#idempotence-and-message-duplication) - * [CloudEvents](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#cloudevents) - * [Task statistics](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#task-statistics) + * [Queue ETL tasks](#queue-etl-tasks) + * [Data delivery](#data-delivery) + * [What is transferred](#what-is-transferred) + * [How are messages produced and consumed](#how-are-messages-produced-and-consumed) + * [Idempotence and message duplication](#idempotence-and-message-duplication) + * [CloudEvents](#cloudevents) + * [Task statistics](#task-statistics) ## Queue ETL tasks @@ -82,7 +82,7 @@ The above ETL tasks: Document extensions like attachments, counters, or time series, will not be transferred. * **CloudEvents messages** JSON objects produced by the task's transformation script are wrapped - and delivered as [CloudEvents Messages](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#cloudevents). + and delivered as [CloudEvents Messages](#cloudevents). #### How are messages produced and consumed: diff --git a/docs/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx b/docs/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx index 09fc383aec..4911ef14fb 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx @@ -31,16 +31,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this page: - * [Add a RabbitMQ connection string](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#add-a-rabbitmq-connection-string) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#syntax) - * [Add a RabbitMQ ETL task](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#add-a-rabbitmq-etl-task) - * [Example - basic](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#example-basic) - * [Example - delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-loadto-method) - * [Available method overloads](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#available-method-overloads) + * [Add a RabbitMQ connection string](#add-a-rabbitmq-connection-string) + * [Example](#example) + * [Syntax](#syntax) + * [Add a RabbitMQ ETL task](#add-a-rabbitmq-etl-task) + * [Example - basic](#example-basic) + * [Example - delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) + * [Available method overloads](#available-method-overloads) ## Add a RabbitMQ connection string @@ -127,7 +127,7 @@ var res = store.Maintenance.Send( * Extract source documents from the "Orders" collection in RavenDB. * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersExchange" in a RabbitMQ broker. -* For more details about the script and the `loadTo` method overloads, see the [transformation script](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-transformation-script) section below. +* For more details about the script and the `loadTo` method overloads, see the [transformation script](#the-transformation-script) section below. diff --git a/docs/server/ongoing-tasks/etl/raven.mdx b/docs/server/ongoing-tasks/etl/raven.mdx index dc9e152409..8a897ad31b 100644 --- a/docs/server/ongoing-tasks/etl/raven.mdx +++ b/docs/server/ongoing-tasks/etl/raven.mdx @@ -31,24 +31,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; * RavenDB ETL tasks can be defined via the Client API or the [Studio](../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx). * In this article: - * [Transformation script options](../../../server/ongoing-tasks/etl/raven.mdx#transformation-script-options) - * [Empty Script](../../../server/ongoing-tasks/etl/raven.mdx#empty-script) - * [Attachments](../../../server/ongoing-tasks/etl/raven.mdx#attachments) - * [Counters](../../../server/ongoing-tasks/etl/raven.mdx#counters) - * [Time Series](../../../server/ongoing-tasks/etl/raven.mdx#time-series) - * [Revisions](../../../server/ongoing-tasks/etl/raven.mdx#revisions) - * [Deletions](../../../server/ongoing-tasks/etl/raven.mdx#deletions) + * [Transformation script options](#transformation-script-options) + * [Empty Script](#empty-script) + * [Attachments](#attachments) + * [Counters](#counters) + * [Time Series](#time-series) + * [Revisions](#revisions) + * [Deletions](#deletions) -* [Loading documents to the destination database](../../../server/ongoing-tasks/etl/raven.mdx#loading-documents-to-the-destination-database) -* [Document identifiers](../../../server/ongoing-tasks/etl/raven.mdx#document-identifiers) -* [Filtering](../../../server/ongoing-tasks/etl/raven.mdx#filtering) -* [Loading data from related documents](../../../server/ongoing-tasks/etl/raven.mdx#loading-data-from-related-documents) -* [Accessing metadata](../../../server/ongoing-tasks/etl/raven.mdx#accessing-metadata) -* [Creating multiple documents from a single document](../../../server/ongoing-tasks/etl/raven.mdx#creating-multiple-documents-from-a-single-document) +* [Loading documents to the destination database](#loading-documents-to-the-destination-database) +* [Document identifiers](#document-identifiers) +* [Filtering](#filtering) +* [Loading data from related documents](#loading-data-from-related-documents) +* [Accessing metadata](#accessing-metadata) +* [Creating multiple documents from a single document](#creating-multiple-documents-from-a-single-document) --- @@ -170,7 +170,7 @@ loadToEmployees({ ### Document Identifiers Document IDs assigned to documents written to the destination depend on whether the source and destination collections share the same name. -You can also configure a [postfix](../../../server/ongoing-tasks/etl/raven.mdx#setting-a-destination-document-id-postfix) to further modify the resulting ID. +You can also configure a [postfix](#setting-a-destination-document-id-postfix) to further modify the resulting ID. @@ -203,7 +203,7 @@ the destination ID will look like: `employees/1-A/people/00000000000000000024-A` This happens because the ETL task appends `/` to the source ID, signaling the destination server to generate an [identity-based ID](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids). Since the destination ID differs from the source ID, the old document version is deleted on the destination database and replaced with each update. -This behavior can be changed - see [Deletions](../../../server/ongoing-tasks/etl/raven.mdx#deletions). +This behavior can be changed - see [Deletions](#deletions). ```js @@ -431,10 +431,10 @@ var managerMeta = getMetadata(manager); * If you use a script you can indicate that an attachment should also be sent by using dedicated functions: - `loadAttachment(name)` returns a reference to an attachment that is meant be passed to `addAttachment()` - `.addAttachment([name,] attachmentRef)` adds an attachment to a document that will be sent in the process, `` is a reference returned by `loadTo()` -* [Sending attachments together with documents](../../../server/ongoing-tasks/etl/raven.mdx#sending-attachments-together-with-documents) -* [Changing attachment name](../../../server/ongoing-tasks/etl/raven.mdx#changing-attachment-name) -* [Loading non-existent attachment](../../../server/ongoing-tasks/etl/raven.mdx#loading-non-existent-attachment) -* [Accessing attachments from metadata](../../../server/ongoing-tasks/etl/raven.mdx#accessing-attachments-from-metadata) +* [Sending attachments together with documents](#sending-attachments-together-with-documents) +* [Changing attachment name](#changing-attachment-name) +* [Loading non-existent attachment](#loading-non-existent-attachment) +* [Accessing attachments from metadata](#accessing-attachments-from-metadata) ### Sending attachments together with documents @@ -491,13 +491,13 @@ var attachments = this['@metadata']['@attachments']; * Counters are sent automatically when you send a _full_ collection to the destination using an _empty_ script. * If a script is defined RavenDB doesn't send counters by default. -* To indicate that a counter should also be sent, the [behavior function](../../../server/ongoing-tasks/etl/raven.mdx#counter-behavior-function) +* To indicate that a counter should also be sent, the [behavior function](#counter-behavior-function) (e.g. by increment operation). If the relevant function doesn't exist, a counter isn't loaded. * The reason that counters require special functions is that incrementing a counter _doesn't_ modify the change vector of a related document so the document _isn't_ processed by ETL on a change in the counter. * Another option of sending a counter is to explicitly add it in a script to a loaded document. -* [Counter behavior function](../../../server/ongoing-tasks/etl/raven.mdx#counter-behavior-function) -* [Adding counter explicitly in a script](../../../server/ongoing-tasks/etl/raven.mdx#adding-counter-explicitly-in-a-script) +* [Counter behavior function](#counter-behavior-function) +* [Adding counter explicitly in a script](#adding-counter-explicitly-in-a-script) ### Counter behavior function @@ -557,7 +557,7 @@ function loadCountersOfProductsBehavior(docId, counterName) { Counter behavior functions typically handle counters of documents that are loaded to the same collection. If a transformation script for `Employees` collection specifies that they are loaded to the `People` collection in a target database, - then due to document ID generation strategy by ETL process (see [Documents Identifiers](../../../server/ongoing-tasks/etl/raven.mdx#documents-identifiers)), + then due to document ID generation strategy by ETL process (see [Documents Identifiers](#documents-identifiers)), the counters won't be sent because the final ID of a loaded document isn't known on the source side. You can use special functions in the script code to deal with counters on documents that are loaded into different collections: @@ -596,8 +596,8 @@ but it **sets the value using a** `put` command. * If the transformation script is empty, time series are transferred along with their documents by default. * When the script is not empty, ETL can be set for time series via: - * [Time Series Load Behavior Function](../../../server/ongoing-tasks/etl/raven.mdx#time-series-load-behavior-function) - * [Adding Time Series to Documents](../../../server/ongoing-tasks/etl/raven.mdx#adding-time-series-to-documents) + * [Time Series Load Behavior Function](#time-series-load-behavior-function) + * [Adding Time Series to Documents](#adding-time-series-to-documents) ### Time Series Load Behavior Function @@ -722,12 +722,12 @@ Upon source document modifications, ETL is set to delete and replace the destina If you want to control the way deletions are handled in the destination database, you can change the default settings with the configurable functions described in this section. -* [Why documents are deleted by default](../../../server/ongoing-tasks/etl/raven.mdx#deletions-why-documents-are-deleted-by-default-in-the-destination-database) -* [When destination collections are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) -* [Collection specific function](../../../server/ongoing-tasks/etl/raven.mdx#deletions-collection-specific-function) -* [Generic function](../../../server/ongoing-tasks/etl/raven.mdx#deletions-generic-function) -* [Filtering deletions in the destination database](../../../server/ongoing-tasks/etl/raven.mdx#deletions-filtering-deletions-in-the-destination-database) -* [Deletions Example: ETL script with deletion behavior defined](../../../server/ongoing-tasks/etl/raven.mdx#deletions-example-etl-script-with-deletion-behavior-defined) +* [Why documents are deleted by default](#deletions-why-documents-are-deleted-by-default-in-the-destination-database) +* [When destination collections are different](#when-destination-collections-are-different) +* [Collection specific function](#deletions-collection-specific-function) +* [Generic function](#deletions-generic-function) +* [Filtering deletions in the destination database](#deletions-filtering-deletions-in-the-destination-database) +* [Deletions Example: ETL script with deletion behavior defined](#deletions-example-etl-script-with-deletion-behavior-defined) --- @@ -748,9 +748,9 @@ The functions in this section were created to allow developers this control. **If we ETL to a different collection than the source**, the source isn't aware of the new IDs created. This forces us to load new documents with incremented IDs instead of overwriting the fields in existing documents. -RavenDB has to create a new, updated document in the destination with an [incremented server-made identity](../../../server/ongoing-tasks/etl/raven.mdx#documents-identifiers). +RavenDB has to create a new, updated document in the destination with an [incremented server-made identity](#documents-identifiers). You can then choose if you want to delete the old version in the destination by selecting -`return false` in the transform script function [deleteDocumentsBehavior](../../../server/ongoing-tasks/etl/raven.mdx#deletions-generic-function). +`return false` in the transform script function [deleteDocumentsBehavior](#deletions-generic-function). * Each updated version of the document gets a [server generated ID](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids) in which the number at the end is incremented with each version. @@ -776,7 +776,7 @@ sending a single delete command in the destination for a given ID. If documents are updated and not deleted in the source, they will simply be updated in the destination with no change to the destination document ID. Deletions can be controlled by defining deletion behavior functions in the ETL script. -* See a [sample ETL script with deletion behavior defined](../../../server/ongoing-tasks/etl/raven.mdx#deletions-example-etl-script-with-deletion-behavior-defined). +* See a [sample ETL script with deletion behavior defined](#deletions-example-etl-script-with-deletion-behavior-defined). --- @@ -794,7 +794,7 @@ function deleteDocumentsOfBehavior(docId, deleted) { `` needs to be substituted by a real collection name that the ETL script is working on -(same convention as for [loadTo](../../../server/ongoing-tasks/etl/raven.mdx#transformation-script-options) method). +(same convention as for [loadTo](#transformation-script-options) method). e.g. `function deleteDocumentsOfOrdersBehavior(docId, deleted) {return false;}` | Parameter | Type | Description | Notes | @@ -862,7 +862,7 @@ trigger the command regardless of whether the source document was deleted. ### Example - Generic deletions behavior function -[If the source and destination collection names are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) +[If the source and destination collection names are different](#when-destination-collections-are-different) and deletions behavior is set to false, each document change will load a new document with an incremented document identity, thus saving a history. @@ -959,7 +959,7 @@ function deleteDocumentsBehavior(docId, collection, deleted) { The following example will check if the source document was deleted or just updated before loading the transformed document. This function can be used if the destination collection is the same or different from the source. -> [In this example, the source and destination collection names are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) +> [In this example, the source and destination collection names are different](#when-destination-collections-are-different) and deletions behavior is set to false if the source is deleted, so source deletions won't delete the destination document, thus saving a history of documents even if they're deleted in the source. diff --git a/docs/server/ongoing-tasks/etl/snowflake.mdx b/docs/server/ongoing-tasks/etl/snowflake.mdx index 179a50e6f5..52ac3b5e84 100644 --- a/docs/server/ongoing-tasks/etl/snowflake.mdx +++ b/docs/server/ongoing-tasks/etl/snowflake.mdx @@ -27,20 +27,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Snowflake ETL is enabled with a RavenDB [Enterprise License](https://ravendb.net/buy). * In this page: - * [Creating a Task](../../../server/ongoing-tasks/etl/snowflake.mdx#creating-a-task) - * [Snowflake warehouse setup](../../../server/ongoing-tasks/etl/snowflake.mdx#snowflake-warehouse-setup) - * [Snowflake Tables](../../../server/ongoing-tasks/etl/snowflake.mdx#snowflake-tables) - * [Performance improvement suggestions](../../../server/ongoing-tasks/etl/snowflake.mdx#performance-improvement-suggestions) - * [Transformation Scripts](../../../server/ongoing-tasks/etl/snowflake.mdx#transformation-scripts) - * [`loadTo` Method](../../../server/ongoing-tasks/etl/snowflake.mdx#method) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/snowflake.mdx#alternative-syntax) - * [Filtering](../../../server/ongoing-tasks/etl/snowflake.mdx#filtering) - * [Loading Other Documents](../../../server/ongoing-tasks/etl/snowflake.mdx#loading-other-documents) - * [Accessing Metadata](../../../server/ongoing-tasks/etl/snowflake.mdx#accessing-metadata) - * [Loading to Multiple Tables](../../../server/ongoing-tasks/etl/snowflake.mdx#loading-to-multiple-tables) - * [Document Extensions](../../../server/ongoing-tasks/etl/snowflake.mdx#document-extensions) - * [Transaction Processing](../../../server/ongoing-tasks/etl/snowflake.mdx#transaction-processing) - * [Advanced Options](../../../server/ongoing-tasks/etl/snowflake.mdx#advanced-options) + * [Creating a Task](#creating-a-task) + * [Snowflake warehouse setup](#snowflake-warehouse-setup) + * [Snowflake Tables](#snowflake-tables) + * [Performance improvement suggestions](#performance-improvement-suggestions) + * [Transformation Scripts](#transformation-scripts) + * [`loadTo` Method](#method) + * [Alternative Syntax](#alternative-syntax) + * [Filtering](#filtering) + * [Loading Other Documents](#loading-other-documents) + * [Accessing Metadata](#accessing-metadata) + * [Loading to Multiple Tables](#loading-to-multiple-tables) + * [Document Extensions](#document-extensions) + * [Transaction Processing](#transaction-processing) + * [Advanced Options](#advanced-options) ## Creating a Task diff --git a/docs/server/ongoing-tasks/etl/sql.mdx b/docs/server/ongoing-tasks/etl/sql.mdx index 50d08c6960..40167d1fa9 100644 --- a/docs/server/ongoing-tasks/etl/sql.mdx +++ b/docs/server/ongoing-tasks/etl/sql.mdx @@ -15,24 +15,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **SQL ETL** is a task that creates an [ETL process](../../../server/ongoing-tasks/etl/basics.mdx) where data from a RavenDB database is extracted, transformed, and loaded into a relational database as the destination. * In this article: - * [Supported relational databases](../../../server/ongoing-tasks/etl/sql.mdx#supported-relational-databases) - * [Creating the SQL ETL task](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task) - * [Configuring the SQL tables](../../../server/ongoing-tasks/etl/sql.mdx#configuring-the-sql-tables) - * [Document ID column](../../../server/ongoing-tasks/etl/sql.mdx#document-id-column) - * [Insert only](../../../server/ongoing-tasks/etl/sql.mdx#insert-only) - * [Transformation scripts](../../../server/ongoing-tasks/etl/sql.mdx#transformation-scripts) - * [The `loadTo` method](../../../server/ongoing-tasks/etl/sql.mdx#the-loadto-method) - * [Loading to multiple tables](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-multiple-tables) - * [Loading related documents](../../../server/ongoing-tasks/etl/sql.mdx#loading-related-documents) - * [Loading attachments](../../../server/ongoing-tasks/etl/sql.mdx#loading-attachments) - * [Loading to VARCHAR and NVARCHAR columns](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-varchar-and-nvarchar-columns) - * [Loading to specific column types](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-specific-column-types) - * [Filtering](../../../server/ongoing-tasks/etl/sql.mdx#filtering) - * [Accessing the metadata](../../../server/ongoing-tasks/etl/sql.mdx#accessing-the-metadata) - * [Document extensions](../../../server/ongoing-tasks/etl/sql.mdx#document-extensions) - * [Advanced options](../../../server/ongoing-tasks/etl/sql.mdx#advanced-options) - * [Transaction processing](../../../server/ongoing-tasks/etl/sql.mdx#transaction-processing) - * [Creating the SQL ETL task from the Client API](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task-from-the-client-api) + * [Supported relational databases](#supported-relational-databases) + * [Creating the SQL ETL task](#creating-the-sql-etl-task) + * [Configuring the SQL tables](#configuring-the-sql-tables) + * [Document ID column](#document-id-column) + * [Insert only](#insert-only) + * [Transformation scripts](#transformation-scripts) + * [The `loadTo` method](#the-loadto-method) + * [Loading to multiple tables](#loading-to-multiple-tables) + * [Loading related documents](#loading-related-documents) + * [Loading attachments](#loading-attachments) + * [Loading to VARCHAR and NVARCHAR columns](#loading-to-varchar-and-nvarchar-columns) + * [Loading to specific column types](#loading-to-specific-column-types) + * [Filtering](#filtering) + * [Accessing the metadata](#accessing-the-metadata) + * [Document extensions](#document-extensions) + * [Advanced options](#advanced-options) + * [Transaction processing](#transaction-processing) + * [Creating the SQL ETL task from the Client API](#creating-the-sql-etl-task-from-the-client-api) @@ -59,7 +59,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; -To create an SQL ETL task using the Client API, see [Creating the SQL ETL task from the Client API](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task-from-the-client-api). +To create an SQL ETL task using the Client API, see [Creating the SQL ETL task from the Client API](#creating-the-sql-etl-task-from-the-client-api). To create an SQL ETL task from Studio, open `Tasks` > `Ongoing Tasks`. ![Configure SQL ETL task](./assets/sql-etl-setup.png) diff --git a/docs/server/ongoing-tasks/etl/test-scripts.mdx b/docs/server/ongoing-tasks/etl/test-scripts.mdx index 3ae5c12c73..1f37f845f9 100644 --- a/docs/server/ongoing-tasks/etl/test-scripts.mdx +++ b/docs/server/ongoing-tasks/etl/test-scripts.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * ETL transformations can be tested with the usage of `Test script` option. Edit your script in the Studio to enter test mode. * In this page: - * [Testing Raven ETL Scripts](../../../server/ongoing-tasks/etl/test-scripts.mdx#testing-raven-etl-scripts) - * [Testing SQL ETL Scripts](../../../server/ongoing-tasks/etl/test-scripts.mdx#testing-sql-etl-scripts) + * [Testing Raven ETL Scripts](#testing-raven-etl-scripts) + * [Testing SQL ETL Scripts](#testing-sql-etl-scripts) diff --git a/docs/server/ongoing-tasks/external-replication.mdx b/docs/server/ongoing-tasks/external-replication.mdx index eb442b619b..3268ef8b6a 100644 --- a/docs/server/ongoing-tasks/external-replication.mdx +++ b/docs/server/ongoing-tasks/external-replication.mdx @@ -27,17 +27,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; For additional functionality such as filtration and two-way replication consider [Hub/Sink Replication](../../server/ongoing-tasks/hub-sink-replication.mdx). * To replicate between two separate, secure RavenDB servers, - you need to [pass a client certificate](../../server/ongoing-tasks/external-replication.mdx#step-by-step-guide) from the source server to the destination. + you need to [pass a client certificate](#step-by-step-guide) from the source server to the destination. * The External Replication task **does _not_ create a backup** of your data and indexes. See more in [Backup -vs- Replication](../../backup/faq#is-an-external-replication-task-a-good-substitute-for-a-backup-task) * In this page: - * [General Information about External Replication Task](../../server/ongoing-tasks/external-replication.mdx#general-information-about-external-replication-task) - * [Code Sample](../../server/ongoing-tasks/external-replication.mdx#code-sample) - * [Step-by-Step Guide](../../server/ongoing-tasks/external-replication.mdx#step-by-step-guide) - * [Definition](../../server/ongoing-tasks/external-replication.mdx#definition) - * [Offline Behavior](../../server/ongoing-tasks/external-replication.mdx#offline-behavior) - * [Delayed Replication](../../server/ongoing-tasks/external-replication.mdx#delayed-replication) + * [General Information about External Replication Task](#general-information-about-external-replication-task) + * [Code Sample](#code-sample) + * [Step-by-Step Guide](#step-by-step-guide) + * [Definition](#definition) + * [Offline Behavior](#offline-behavior) + * [Delayed Replication](#delayed-replication) @@ -167,7 +167,7 @@ To create an external replication task via the RavenDB Studio, see the [Step-by- ## Definition -To learn how to define an external replication task via code, see [code sample](../../server/ongoing-tasks/external-replication.mdx#code-sample). +To learn how to define an external replication task via code, see [code sample](#code-sample). You can also configure external eplication tasks [via RavenDB Studio](../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition). diff --git a/docs/server/ongoing-tasks/hub-sink-replication.mdx b/docs/server/ongoing-tasks/hub-sink-replication.mdx index cfe147a6cc..a0fade2b55 100644 --- a/docs/server/ongoing-tasks/hub-sink-replication.mdx +++ b/docs/server/ongoing-tasks/hub-sink-replication.mdx @@ -36,14 +36,14 @@ Hub whenever they are online. * In this page: * [What is and is not replicated?](../../server/ongoing-tasks/hub-sink-replication.mdx#what-is-and-is-not-replicated?) - * [Defining Replication Tasks](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-replication-tasks) - * [Defining a Replication Hub](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-replication-hub) - * [Defining a Hub Access](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-hub-access) - * [Defining a Replication Sink](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-replication-sink) - * [Defining a Connection String](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-connection-string) - * [Usage Sample](../../server/ongoing-tasks/hub-sink-replication.mdx#usage-sample) - * [Failover](../../server/ongoing-tasks/hub-sink-replication.mdx#failover) - * [Backward Compatibility](../../server/ongoing-tasks/hub-sink-replication.mdx#backward-compatibility) + * [Defining Replication Tasks](#defining-replication-tasks) + * [Defining a Replication Hub](#defining-a-replication-hub) + * [Defining a Hub Access](#defining-a-hub-access) + * [Defining a Replication Sink](#defining-a-replication-sink) + * [Defining a Connection String](#defining-a-connection-string) + * [Usage Sample](#usage-sample) + * [Failover](#failover) + * [Backward Compatibility](#backward-compatibility) ## What is and is not replicated? diff --git a/docs/server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx b/docs/server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx index 6087adc4be..c283a07821 100644 --- a/docs/server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx +++ b/docs/server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx @@ -41,19 +41,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Queue Sink overview](../../../server/ongoing-tasks/queue-sink/overview.mdx). * In this article: - * [The Azure Service Bus Sink Task](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#the-azure-service-bus-sink-task) - * [Connecting an Azure Service Bus namespace](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#connecting-an-azure-service-bus-namespace) - * [Selecting message sources](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#selecting-message-sources) - * [Retrieving enqueued messages](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#retrieving-enqueued-messages) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#client-api) - * [Adding an Azure Service Bus connection string](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#adding-an-azure-service-bus-connection-string) - * [Adding an Azure Service Bus sink task](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#adding-an-azure-service-bus-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#configuration-options) - * [Syntax](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#syntax) - * [Methods](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#methods) - * [Classes](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#classes) + * [The Azure Service Bus Sink Task](#the-azure-service-bus-sink-task) + * [Connecting an Azure Service Bus namespace](#connecting-an-azure-service-bus-namespace) + * [Selecting message sources](#selecting-message-sources) + * [Retrieving enqueued messages](#retrieving-enqueued-messages) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Adding an Azure Service Bus connection string](#adding-an-azure-service-bus-connection-string) + * [Adding an Azure Service Bus sink task](#adding-an-azure-service-bus-sink-task) + * [Configuration Options](#configuration-options) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -70,7 +70,7 @@ The task connects to an Azure Service Bus namespace using a connection string th register with RavenDB. The connection string identifies the namespace and holds the credentials that the task authenticates with. -Read [below](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#adding-an-azure-service-bus-connection-string) +Read [below](#adding-an-azure-service-bus-connection-string) about adding a connection string via the client API. @@ -89,7 +89,7 @@ A source is either: One script can read from several sources, and a sink task can run several scripts, so a single task can consume from any mix of queues and subscriptions in the same namespace. -Learn [below](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#adding-an-azure-service-bus-sink-task) +Learn [below](#adding-an-azure-service-bus-sink-task) how to specify each source via the client API. @@ -190,7 +190,7 @@ Because the task acknowledges a message only after its document is persisted, ev is processed **at least once**, even if the sink fails partway through a batch. The number of messages in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). @@ -293,9 +293,9 @@ store.Maintenance.Send( For the full property reference, see the -[Connection string](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#connection-string) +[Connection string](#connection-string) and -[Authentication credentials](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#authentication-credentials) +[Authentication credentials](#authentication-credentials) classes in the Syntax section. --- @@ -365,7 +365,7 @@ Queues = new List For the `QueueSinkConfiguration` and `QueueSinkScript` property reference, see the -[Sink task](../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx#sink-task) +[Sink task](#sink-task) classes in the Syntax section. diff --git a/docs/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx b/docs/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx index ee57c3c09f..3fdbba5d85 100644 --- a/docs/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx +++ b/docs/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx @@ -29,17 +29,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; user-defined scripts, and store the documents in RavenDB collections. * In this article: - * [The Queue Sink Task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#the-queue-sink-task) - * [Connecting a Kafka broker](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#connecting-a-kafka-broker) - * [Retrieving enqueued messages from selected Kafka topics](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#retrieving-enqueued-messages-from-selected-kafka-topics) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#client-api) - * [Adding a Kafka connection string](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#adding-a-kafka-connection-string) - * [Adding a Kafka sink task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#adding-a-kafka-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#configuration-options) - * [Syntax](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#syntax) - * [Classes](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#classes) + * [The Queue Sink Task](#the-queue-sink-task) + * [Connecting a Kafka broker](#connecting-a-kafka-broker) + * [Retrieving enqueued messages from selected Kafka topics](#retrieving-enqueued-messages-from-selected-kafka-topics) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Adding a Kafka connection string](#adding-a-kafka-connection-string) + * [Adding a Kafka sink task](#adding-a-kafka-sink-task) + * [Configuration Options](#configuration-options) + * [Syntax](#syntax) + * [Classes](#classes) @@ -58,7 +58,7 @@ In the message broker architecture, RavenDB sinks take the role of data consumer A sink would connect a Kafka broker using a connection string, and retrieve messages from the broker's Topics. -Read [below](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#adding-a-kafka-connection-string) +Read [below](#adding-a-kafka-connection-string) about adding a connection string via API. Read [here](../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-a-kafka-sink-task) about adding a connection string using Studio. @@ -174,7 +174,7 @@ user in Studio, but **continue processing the batch**. Once a batch is consumed, the task confirms it by calling `kafkaConsumer.Commit()`. Note that the number of documents included in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). Producers may enqueue @@ -218,7 +218,7 @@ var res = store.Maintenance.Send(
For the full property reference, see the -[Connection string](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#connection-string) +[Connection string](#connection-string) class in the Syntax section. --- @@ -283,7 +283,7 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = For the `QueueSinkConfiguration` and `QueueSinkScript` property reference, see the -[Sink task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#sink-task) +[Sink task](#sink-task) classes in the Syntax section. diff --git a/docs/server/ongoing-tasks/queue-sink/overview.mdx b/docs/server/ongoing-tasks/queue-sink/overview.mdx index 1530862e36..6c9bc8bbd4 100644 --- a/docs/server/ongoing-tasks/queue-sink/overview.mdx +++ b/docs/server/ongoing-tasks/queue-sink/overview.mdx @@ -40,9 +40,9 @@ ability to process this data, reveal and exploit its value. * In this page: - * [Supported Message Brokers](../../../server/ongoing-tasks/queue-sink/overview.mdx#supported-message-brokers) - * [Task Statistics](../../../server/ongoing-tasks/queue-sink/overview.mdx#task-statistics) - * [Licensing](../../../server/ongoing-tasks/queue-sink/overview.mdx#licensing) + * [Supported Message Brokers](#supported-message-brokers) + * [Task Statistics](#task-statistics) + * [Licensing](#licensing) ## Supported Message Brokers diff --git a/docs/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx b/docs/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx index fab177a75f..8f59a26282 100644 --- a/docs/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx +++ b/docs/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx @@ -29,17 +29,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; using user-defined scripts, and store the documents in RavenDB collections. * In this article: - * [The RabbitMQ Sink Task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#the-rabbitmq-sink-task) - * [Connecting a RabbitMQ broker](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#connecting-a-rabbitmq-broker) - * [Retrieving messages from RabbitMQ queues](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#retrieving-messages-from-rabbitmq-queues) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#client-api) - * [Adding a RabbitMQ connection string](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#adding-a-rabbitmq-connection-string) - * [Adding a RabbitMQ sink task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#adding-a-rabbitmq-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#configuration-options) - * [Syntax](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#syntax) - * [Classes](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#classes) + * [The RabbitMQ Sink Task](#the-rabbitmq-sink-task) + * [Connecting a RabbitMQ broker](#connecting-a-rabbitmq-broker) + * [Retrieving messages from RabbitMQ queues](#retrieving-messages-from-rabbitmq-queues) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Adding a RabbitMQ connection string](#adding-a-rabbitmq-connection-string) + * [Adding a RabbitMQ sink task](#adding-a-rabbitmq-sink-task) + * [Configuration Options](#configuration-options) + * [Syntax](#syntax) + * [Classes](#classes) @@ -58,7 +58,7 @@ In the message broker architecture, RavenDB sinks take the role of data consumer A sink would connect a RabbitMQ broker using a connection string, and retrieve messages from the broker's queues. -Read [below](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#adding-a-rabbitmq-connection-string) +Read [below](#adding-a-rabbitmq-connection-string) about adding a connection string via API. Read [here](../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-a-rabbitmq-sink-task) about adding a connection string using Studio. @@ -161,7 +161,7 @@ user in Studio, but **continue processing the batch**. Once a batch is consumed, the task confirms it by sending `_channel.BasicAck`. Note that the number of documents included in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). Producers may enqueue @@ -205,7 +205,7 @@ var res = store.Maintenance.Send(
For the full property reference, see the -[Connection string](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#connection-string) +[Connection string](#connection-string) class in the Syntax section. --- @@ -270,7 +270,7 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = For the `QueueSinkConfiguration` and `QueueSinkScript` property reference, see the -[Sink task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#sink-task) +[Sink task](#sink-task) classes in the Syntax section. diff --git a/docs/server/security/audit-log/audit-log-overview.mdx b/docs/server/security/audit-log/audit-log-overview.mdx index 72c1f6b3c2..3ef64e5ac0 100644 --- a/docs/server/security/audit-log/audit-log-overview.mdx +++ b/docs/server/security/audit-log/audit-log-overview.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; See the full list of what is being logged below. * In this page: - * [Enabling the audit log](../../../server/security/audit-log/audit-log-overview.mdx#enabling-the-audit-log) - * [What is being logged](../../../server/security/audit-log/audit-log-overview.mdx#what-is-being-logged) - * [Things to consider](../../../server/security/audit-log/audit-log-overview.mdx#things-to-consider) + * [Enabling the audit log](#enabling-the-audit-log) + * [What is being logged](#what-is-being-logged) + * [Things to consider](#things-to-consider) ## Enabling the audit log diff --git a/docs/server/security/authentication/certificate-configuration.mdx b/docs/server/security/authentication/certificate-configuration.mdx index bf26c8c1fd..f7a3036502 100644 --- a/docs/server/security/authentication/certificate-configuration.mdx +++ b/docs/server/security/authentication/certificate-configuration.mdx @@ -24,12 +24,12 @@ authentication in a much easier and faster way with automatic certificate renewa If you choose manual setup and/or to provide your own certificate, **you are responsible for its periodic renewal**. * In this page: - * [Prerequisites](../../../server/security/authentication/certificate-configuration.mdx#prerequisites) - * [Standard Manual Setup With Certificate Stored Locally](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) - * [Certificate Requirements](../../../server/security/authentication/certificate-configuration.mdx#certificate-requirements) - * [Certificate Location](../../../server/security/authentication/certificate-configuration.mdx#certificate-location) - * [With Logic Foreign to RavenDB or External Certificate Storage](../../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage) - * [Step-by-step Guide to Installing Certificate](../../../server/security/authentication/certificate-configuration.mdx#step-by-step-guide-to-installing-certificate) + * [Prerequisites](#prerequisites) + * [Standard Manual Setup With Certificate Stored Locally](#standard-manual-setup-with-certificate-stored-locally) + * [Certificate Requirements](#certificate-requirements) + * [Certificate Location](#certificate-location) + * [With Logic Foreign to RavenDB or External Certificate Storage](#with-logic-foreign-to-ravendb-or-external-certificate-storage) + * [Step-by-step Guide to Installing Certificate](#step-by-step-guide-to-installing-certificate) @@ -40,7 +40,7 @@ To enable authentication, either `Security.Certificate.Path` or `Security.Certif #### Setting up Client Certificates When the server is manually set up with a server certificate for the first time, there are no client certificates registered in the server yet. The first action an administrator will do is to [generate/register a new client certificate](../../../server/security/authentication/client-certificate-usage.mdx). -Find detailed instructions of the process [below](../../../server/security/authentication/certificate-configuration.mdx#step-by-step-guide-to-installing-certificate). +Find detailed instructions of the process [below](#step-by-step-guide-to-installing-certificate). You can set up various client certificates with different security clearance levels and database permissions. See [Certificate Management](../../../server/security/authentication/certificate-management.mdx) for more about permissions. @@ -181,7 +181,7 @@ In all secure configurations, the `ServerUrl` must contain the same domain name - Extract the .zip into the folders on each machine where the server nodes will permanently live. - Store server certificate in your desired location with secure permissions. -2. In each node `Server` folder, create the `settings.json` file which you will configure like the [examples](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. +2. In each node `Server` folder, create the `settings.json` file which you will configure like the [examples](#standard-manual-setup-with-certificate-stored-locally) above. * You can do this by going into the node `Server` folder > right-click > **New** > **Text Document** > name it `settings.json` instead of ...txt > click **Yes** > open it and begin configuring. * Place the `settings.json` inside each node's `Server` folder because when you run the server, RavenDB is programmed to find the settings there. @@ -190,12 +190,12 @@ In all secure configurations, the `ServerUrl` must contain the same domain name - Set the `ServerUrl`. Make sure to use `https` and that it matches the domain established in your certificate. - Set `Setup.Mode` to `None` to deactivate the RavenDB Setup Wizard. - Set `DataDir` to the desired database storage folder on each machine. - - Set the `Security.Certificate.Path` to the **.pfx** that you placed in each server folder if certificate is stored with [RavenDB logic on local machines](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) - or `Security.Certificate.Load.Exec` if using [external location or logic](../../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage). + - Set the `Security.Certificate.Path` to the **.pfx** that you placed in each server folder if certificate is stored with [RavenDB logic on local machines](#standard-manual-setup-with-certificate-stored-locally) + or `Security.Certificate.Load.Exec` if using [external location or logic](#with-logic-foreign-to-ravendb-or-external-certificate-storage). - Make sure that the certificate .path or .load script lead to the correct certificate location. `.Path` should look something like this: `"Security.Certificate.Path": "C:/Windows/MyDomainName/A/Server/ravendb.domain.com.pfx"` - See [.json example for a .Path situation](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. - - Setting a **password** on the certificate is optional. See [settings.json example](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. + See [.json example for a .Path situation](#standard-manual-setup-with-certificate-stored-locally) above. + - Setting a **password** on the certificate is optional. See [settings.json example](#standard-manual-setup-with-certificate-stored-locally) above. Run 4. Right-click and run the `run.ps1` (or `run.sh` in Linux) in the extracted server package. In Windows, it runs in PowerShell as a default. diff --git a/docs/server/security/authentication/certificate-management.mdx b/docs/server/security/authentication/certificate-management.mdx index 80929aac5b..33ac02a5c8 100644 --- a/docs/server/security/authentication/certificate-management.mdx +++ b/docs/server/security/authentication/certificate-management.mdx @@ -18,26 +18,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Once authentication is set up, it's the administrator's responsibility to issue and manage client certificates. Each client certificate can be configured to specify which databases the certificate can access and its authorization clearance level. -* Read about the logic and rationale behind RavenDB's client certificates in [The RavenDB Security Authorization Approach](../../../server/security/authentication/certificate-management.mdx#the-ravendb-security-authorization-approach) to ensure that you configure them appropriately. +* Read about the logic and rationale behind RavenDB's client certificates in [The RavenDB Security Authorization Approach](#the-ravendb-security-authorization-approach) to ensure that you configure them appropriately. * See the API article for integrating a client certificate into an application via the [document store](../../../client-api/creating-document-store.mdx). In this page: -* [Studio Certificate Management View](../../../server/security/authentication/certificate-management.mdx#studio-certificates-management-view) -* [The RavenDB Security Authorization Approach](../../../server/security/authentication/certificate-management.mdx#the-ravendb-security-authorization-approach) - * [Authorization Levels in Client Certificates](../../../server/security/authentication/certificate-management.mdx#authorization-levels-in-client-certificates) - * [Partial Access to Database](../../../server/security/authentication/certificate-management.mdx#partial-access-to-database) -* [Create and Configure Certificates](../../../server/security/authentication/certificate-management.mdx#create-and-configure-certificates) - * [List of Registered Certificates](../../../server/security/authentication/certificate-management.mdx#list-of-registered-certificates) - * [Generate Client Certificate](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) - * [Edit Certificate](../../../server/security/authentication/certificate-management.mdx#edit-certificate) +* [Studio Certificate Management View](#studio-certificates-management-view) +* [The RavenDB Security Authorization Approach](#the-ravendb-security-authorization-approach) + * [Authorization Levels in Client Certificates](#authorization-levels-in-client-certificates) + * [Partial Access to Database](#partial-access-to-database) +* [Create and Configure Certificates](#create-and-configure-certificates) + * [List of Registered Certificates](#list-of-registered-certificates) + * [Generate Client Certificate](#generate-client-certificate) + * [Edit Certificate](#edit-certificate) * [Enabling Communication Between Servers: Importing and Exporting Certificates](../../../server/security/authentication/certificate-management.mdx#enabling-communication-between-servers:-importing-and-exporting-certificates) - * [Export Server Certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) - * [Upload an Existing Certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) - * [Certificate Collections](../../../server/security/authentication/certificate-management.mdx#certificate-collections) - * [Private Keys](../../../server/security/authentication/certificate-management.mdx#private-keys) - * [Client Certificate Chain of Trust](../../../server/security/authentication/certificate-management.mdx#client-certificate-chain-of-trust) + * [Export Server Certificates](#export-server-certificates) + * [Upload an Existing Certificate](#upload-an-existing-certificate) + * [Certificate Collections](#certificate-collections) + * [Private Keys](#private-keys) + * [Client Certificate Chain of Trust](#client-certificate-chain-of-trust) ## Studio Certificates Management View @@ -49,19 +49,19 @@ In this page: 3. **Client certificate** ![Client Certificate Button Options](./assets/client-certificate-button-options.png) * **Generate client certificate** - [Create and configure](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) a new client certificate + [Create and configure](#generate-client-certificate) a new client certificate * **Upload client certificate** - [Import a client certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) that was exported from another server so that they can communicate. + [Import a client certificate](#upload-an-existing-certificate) that was exported from another server so that they can communicate. 4. **Server certificates** ![Server Certificates Button Options](./assets/server-certificates-button-options.png) * **Export server certificates** - [Download server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) so that you can download and then import them into another server. + [Download server certificates](#export-server-certificates) so that you can download and then import them into another server. * **Replace server certificates** [Replace server certificates](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) by uploading another `.pfx` certificate. 5. Status of the current server certificate. * Click [Renew now](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) to renew a server certificate's expiration period. If you did not set up your server with the RavenDB Installation Wizard and Let's Encrypt then **you are responsible** to renew your certificates periodically. -6. Status of current client certificates active in this server. You can remove or [edit client certificates](../../../server/security/authentication/certificate-management.mdx#edit-certificate), +6. Status of current client certificates active in this server. You can remove or [edit client certificates](#edit-certificate), including configuring databases permissions and [authorization (security clearance) levels](../../../server/security/authorization/security-clearance-and-permissions.mdx#authorization-security-clearance-and-permissions) here. @@ -91,7 +91,7 @@ does not really exist within RavenDB in this manner. Instead, cluster admins or * [User](../../../server/security/authorization/security-clearance-and-permissions.mdx#user) Lowest levels of privileges. * "User" certificates are configured to specify which databases people can access with each certificate. - * ["User" authorization levels](../../../server/security/authentication/certificate-management.mdx#setting-user-access-levels) are also configured per database. + * ["User" authorization levels](#setting-user-access-levels) are also configured per database. In most cases, users do not access RavenDB directly. Aside from admins and developers during the development process, all access to the data inside RavenDB is expected to be done through your applications. A security mechanism on a per-user basis is not practical in complex systems @@ -122,19 +122,19 @@ any and all documents in that database unless protection is explicitly configure There are two approaches to giving partial access to a database: - * [Using ETL for selective, one-way data transfer](../../../server/security/authentication/certificate-management.mdx#using-etl-for-selective-one-way-data-transfer) - * [Setting "User" Access Levels](../../../server/security/authentication/certificate-management.mdx#setting-user-access-levels) + * [Using ETL for selective, one-way data transfer](#using-etl-for-selective-one-way-data-transfer) + * [Setting "User" Access Levels](#setting-user-access-levels) #### *Using ETL for selective, one-way data transfer* Some developers need to provide partial access to a database that also contains sensitive data. One approach is to set up an [Extract, Transform, Load (ETL) task](../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx): 1. [Create](../../../studio/database/create-new-database/general-flow.mdx) a dedicated database that the public will be able to access. -2. [Generate a client certificate](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) with "User" security clearance so that +2. [Generate a client certificate](#generate-client-certificate) with "User" security clearance so that you can configure it to give access only to the dedicated, public-facing database. 3. If the dedicated database is on a different cluster than the source database: (This is optional. If both databases are on the same cluster, skip to step 4.) - * [Export (download) server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) from the **destination server**. - * [Upload the .pfx certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) to the **source server** to enable the two to connect. + * [Export (download) server certificates](#export-server-certificates) from the **destination server**. + * [Upload the .pfx certificate](#upload-an-existing-certificate) to the **source server** to enable the two to connect. * While uploading, configure the certificate to give access to the target source database. 4. Then set up an [ETL](../../../server/ongoing-tasks/etl/raven.mdx) task from the source database to the exposed, destination database. * Set up a Javascript [Transform script](../../../server/ongoing-tasks/etl/basics.mdx#transform) in the ETL to automatically filter the information passed from the source to destination databases. @@ -165,12 +165,12 @@ With this clearance, you can set a different access level to each database. The -This approach is similar to the HR Manager and Customers certificates in the example given [above](../../../server/security/authentication/certificate-management.mdx#authorization-levels-in-client-certificates). +This approach is similar to the HR Manager and Customers certificates in the example given [above](#authorization-levels-in-client-certificates). It enables developers to control access levels by configuring client certificates. -* To learn how to configure each client certificate's database permissions and authorization levels via the RavenDB Studio GUI, see [Create and Configure Certificates](../../../server/security/authentication/certificate-management.mdx#create-and-configure-certificates). +* To learn how to configure each client certificate's database permissions and authorization levels via the RavenDB Studio GUI, see [Create and Configure Certificates](#create-and-configure-certificates). * To learn how to configure client certificates via CLI, see [Authentication: Client Certificate Usage](../../../server/security/authentication/client-certificate-usage.mdx#authentication-client-certificate-usage) @@ -288,8 +288,8 @@ The following section explains how to give configurable access that enables comm To connect two secure databases, the destination cluster needs to trust the source cluster. To achieve that you need to: -a. **Export** ([download](../../../server/security/authentication/certificate-management.mdx#export-server-certificates)) the server certificate **from the source server**. -b. **Upload** ([import](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate)) the downloaded certificate **into the destination server**. +a. **Export** ([download](#export-server-certificates)) the server certificate **from the source server**. +b. **Upload** ([import](#upload-an-existing-certificate)) the downloaded certificate **into the destination server**. @@ -299,19 +299,19 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana 2. Click **Server certificates** in the source server. ![Server Certificates Button Options](./assets/server-certificates-button-options.png) * **Export server certificates** - [Download server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) + [Download server certificates](#export-server-certificates) so that you can download and then import them into another server. 3. Click **Client certificate** in the destination server. ![Client Certificate Button Options](./assets/client-certificate-button-options.png) * **Upload client certificate** - [Import a client certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) + [Import a client certificate](#upload-an-existing-certificate) that was exported from another server so that the two can communicate. ### Export Server Certificates ![Figure 6. Export Server Certificates](./assets/export-server-certificates.png) This option allows you to export the server certificate as a .pfx file. In the case of a cluster which contains several different server certificates, -a .pfx [collection](../../../server/security/authentication/certificate-management.mdx#certificate-collections) will be exported. +a .pfx [collection](#certificate-collections) will be exported. ### Upload an Existing Certificate Click the **Client certificate** button, select **Upload client certificate** and you will see the following window. diff --git a/docs/server/security/authentication/lets-encrypt-certificates.mdx b/docs/server/security/authentication/lets-encrypt-certificates.mdx index 17a9d205ce..31540a1eaa 100644 --- a/docs/server/security/authentication/lets-encrypt-certificates.mdx +++ b/docs/server/security/authentication/lets-encrypt-certificates.mdx @@ -108,7 +108,7 @@ When your server uses a Let's Encrypt certificate obtained via the Setup Wizard, ravendb> triggerCertificateRefresh [-replaceImmediately] ``` -Both methods trigger the same certificate replacement process described [above](../../../server/security/authentication/lets-encrypt-certificates.mdx#automatic-renewal-for-lets-encrypt-certificates-obtained-via-ravendb). +Both methods trigger the same certificate replacement process described [above](#automatic-renewal-for-lets-encrypt-certificates-obtained-via-ravendb). If a node is down when renewal is triggered, the cluster will complete the operation without that node. **When bringing that node up, the certificate must be replaced manually.** diff --git a/docs/server/security/authentication/recover-from-expired-certificate.mdx b/docs/server/security/authentication/recover-from-expired-certificate.mdx index bb03a50a4f..338c8945eb 100644 --- a/docs/server/security/authentication/recover-from-expired-certificate.mdx +++ b/docs/server/security/authentication/recover-from-expired-certificate.mdx @@ -37,12 +37,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; the server machine. * In this article: - * [What happens when the server certificate expires](../../../server/security/authentication/recover-from-expired-certificate.mdx#what-happens-when-the-server-certificate-expires) - * [Recover the server](../../../server/security/authentication/recover-from-expired-certificate.mdx#recover-the-server) - * [Obtain a valid certificate](../../../server/security/authentication/recover-from-expired-certificate.mdx#obtain-a-valid-certificate) - * [Install the new certificate](../../../server/security/authentication/recover-from-expired-certificate.mdx#install-the-new-certificate) - * [Recover a cluster](../../../server/security/authentication/recover-from-expired-certificate.mdx#recover-a-cluster) - * [Prevent recurrence](../../../server/security/authentication/recover-from-expired-certificate.mdx#prevent-recurrence) + * [What happens when the server certificate expires](#what-happens-when-the-server-certificate-expires) + * [Recover the server](#recover-the-server) + * [Obtain a valid certificate](#obtain-a-valid-certificate) + * [Install the new certificate](#install-the-new-certificate) + * [Recover a cluster](#recover-a-cluster) + * [Prevent recurrence](#prevent-recurrence) diff --git a/docs/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx b/docs/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx index 3515fb20ce..c9fb772186 100644 --- a/docs/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx +++ b/docs/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx @@ -18,13 +18,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; your own Let's Encrypt certificates as client certificates, the next certificate renewal may cause permission issues that need to be handled manually. -* Find [whether this issue is relevant for you](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#current-situation) - and if so, [how to handle it](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#solutions). +* Find [whether this issue is relevant for you](#current-situation) + and if so, [how to handle it](#solutions). * **In this page**: - * [Errors Relevant To This Issue](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#errors-relevant-to-this-issue) - * [Background And Current Situation](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#background-and-current-situation) - * [Solutions](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#solutions) + * [Errors Relevant To This Issue](#errors-relevant-to-this-issue) + * [Background And Current Situation](#background-and-current-situation) + * [Solutions](#solutions) ## Errors Relevant To This Issue diff --git a/docs/server/security/authorization/security-clearance-and-permissions.mdx b/docs/server/security/authorization/security-clearance-and-permissions.mdx index ac1a5ad36f..975a694fcf 100644 --- a/docs/server/security/authorization/security-clearance-and-permissions.mdx +++ b/docs/server/security/authorization/security-clearance-and-permissions.mdx @@ -25,12 +25,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A client certificate's security clearance can be one of the following: Cluster Admin, Operator, User. * In this page: - * [Cluster Admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) - * [Operator](../../../server/security/authorization/security-clearance-and-permissions.mdx#operator) - * [User](../../../server/security/authorization/security-clearance-and-permissions.mdx#user) - * [Admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#section) - * [Read/Write](../../../server/security/authorization/security-clearance-and-permissions.mdx#section-1) - * [Read Only](../../../server/security/authorization/security-clearance-and-permissions.mdx#section-2) + * [Cluster Admin](#cluster-admin) + * [Operator](#operator) + * [User](#user) + * [Admin](#section) + * [Read/Write](#section-1) + * [Read Only](#section-2) ## Cluster Admin diff --git a/docs/server/security/common-errors-and-faq.mdx b/docs/server/security/common-errors-and-faq.mdx index 0ca1f9e4a5..48331f0c82 100644 --- a/docs/server/security/common-errors-and-faq.mdx +++ b/docs/server/security/common-errors-and-faq.mdx @@ -18,20 +18,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This article explains some of the common security configuration errors and how to handle them. * In this page - * [Setup Wizard Issues](../../server/security/common-errors-and-faq.mdx#setup-wizard-issues) - * [Changing Configurations and Renewals Issues](../../server/security/common-errors-and-faq.mdx#changing-configurations-and-renewals-issues) - * [Authentication Issues](../../server/security/common-errors-and-faq.mdx#authentication-issues) - * [Encryption Issues](../../server/security/common-errors-and-faq.mdx#encryption-issues) + * [Setup Wizard Issues](#setup-wizard-issues) + * [Changing Configurations and Renewals Issues](#changing-configurations-and-renewals-issues) + * [Authentication Issues](#authentication-issues) + * [Encryption Issues](#encryption-issues) ## Setup Wizard Issues -* [Server cannot bind to the provided private IP address](../../server/security/common-errors-and-faq.mdx#server-cannot-bind-to-the-provided-private-ip-address) -* [Ports are blocked by the firewall](../../server/security/common-errors-and-faq.mdx#ports-are-blocked-by-the-firewall) -* [DNS is cached locally](../../server/security/common-errors-and-faq.mdx#dns-is-cached-locally) -* [Long DNS propagation time](../../server/security/common-errors-and-faq.mdx#long-dns-propagation-time) -* [If I already have the Zip file, can I avoid repeating the setup process?](../../server/security/common-errors-and-faq.mdx#if-i-already-have-the-zip-file-can-i-avoid-repeating-the-setup-process) +* [Server cannot bind to the provided private IP address](#server-cannot-bind-to-the-provided-private-ip-address) +* [Ports are blocked by the firewall](#ports-are-blocked-by-the-firewall) +* [DNS is cached locally](#dns-is-cached-locally) +* [Long DNS propagation time](#long-dns-propagation-time) +* [If I already have the Zip file, can I avoid repeating the setup process?](#if-i-already-have-the-zip-file-can-i-avoid-repeating-the-setup-process) ### Server cannot bind to the provided private IP address If the IP/port is not accessible on your machine, you'll get the following error. @@ -131,12 +131,12 @@ When building a cluster, repeat this step with nodes B, C, and so on. ## Changing Configurations and Renewals Issues -* [After installing with Let's Encrypt, can I change the DNS records?](../../server/security/common-errors-and-faq.mdx#after-installing-with-lets-encrypt-can-i-change-the-dns-records) -* [Can I change the (private) IP address RavenDB binds to?](../../server/security/common-errors-and-faq.mdx#can-i-change-the-private-ip-address-ravendb-binds-to) -* [The Let's Encrypt certificate is about to expire but doesn't renew automatically](../../server/security/common-errors-and-faq.mdx#the-lets-encrypt-certificate-is-about-to-expire-but-doesnt-renew-automatically) -* [What should I do when my license expires?](../../server/security/common-errors-and-faq.mdx#what-should-i-do-when-my-license-expires) -* [Let's Encrypt certificate permission errors after renewal](../../server/security/common-errors-and-faq.mdx#lets-encrypt-certificate-permission-errors-after-renewal) -* [How do I recover from an expired server certificate?](../../server/security/common-errors-and-faq.mdx#how-do-i-recover-from-an-expired-server-certificate) +* [After installing with Let's Encrypt, can I change the DNS records?](#after-installing-with-lets-encrypt-can-i-change-the-dns-records) +* [Can I change the (private) IP address RavenDB binds to?](#can-i-change-the-private-ip-address-ravendb-binds-to) +* [The Let's Encrypt certificate is about to expire but doesn't renew automatically](#the-lets-encrypt-certificate-is-about-to-expire-but-doesnt-renew-automatically) +* [What should I do when my license expires?](#what-should-i-do-when-my-license-expires) +* [Let's Encrypt certificate permission errors after renewal](#lets-encrypt-certificate-permission-errors-after-renewal) +* [How do I recover from an expired server certificate?](#how-do-i-recover-from-an-expired-server-certificate) ### After installing with Let's Encrypt, can I change the DNS records? Yes. @@ -230,16 +230,16 @@ See [recover from an expired certificate](../../server/security/authentication/r ## Authentication Issues -* [Authentication Error Occurred using Edge](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-edge) -* [Authentication Error Occurred using Chrome](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-chrome) -* [RavenDB is running as a service in Windows and Chrome doesn't use the client certificate from the OS store](../../server/security/common-errors-and-faq.mdx#ravendb-is-running-as-a-service-in-windows-and-chrome-doesnt-use-the-client-certificate-from-the-os-store) -* [Authentication Error Occurred in Firefox](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-in-firefox) -* [Cannot Import the Client Certificate to Firefox](../../server/security/common-errors-and-faq.mdx#cannot-import-the-client-certificate-to-firefox) -* [Getting the full error using PowerShell](../../server/security/common-errors-and-faq.mdx#getting-the-full-error-using-powershell) -* [Not using TLS](../../server/security/common-errors-and-faq.mdx#not-using-tls) -* [How to regain access to a server when you have physical access but no client certificate](../../server/security/common-errors-and-faq.mdx#how-to-regain-access-to-a-server-when-you-have-physical-access-but-no-client-certificate) -* [Certificate is not recognized when setting up on Azure App Services](../../server/security/common-errors-and-faq.mdx#certificate-is-not-recognized-when-setting-up-on-azure-app-services) -* [Automatic cluster certificate renewal following migration to 4.2](../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-42) +* [Authentication Error Occurred using Edge](#authentication-error-occurred-using-edge) +* [Authentication Error Occurred using Chrome](#authentication-error-occurred-using-chrome) +* [RavenDB is running as a service in Windows and Chrome doesn't use the client certificate from the OS store](#ravendb-is-running-as-a-service-in-windows-and-chrome-doesnt-use-the-client-certificate-from-the-os-store) +* [Authentication Error Occurred in Firefox](#authentication-error-occurred-in-firefox) +* [Cannot Import the Client Certificate to Firefox](#cannot-import-the-client-certificate-to-firefox) +* [Getting the full error using PowerShell](#getting-the-full-error-using-powershell) +* [Not using TLS](#not-using-tls) +* [How to regain access to a server when you have physical access but no client certificate](#how-to-regain-access-to-a-server-when-you-have-physical-access-but-no-client-certificate) +* [Certificate is not recognized when setting up on Azure App Services](#certificate-is-not-recognized-when-setting-up-on-azure-app-services) +* [Automatic cluster certificate renewal following migration to 4.2](#automatic-cluster-certificate-renewal-following-migration-to-42) ### Authentication Error Occurred using Edge You cannot access Studio using Edge, though during @@ -341,7 +341,7 @@ looks for the certificate not at the OS root but at the Chrome root store. To solve these issues: Using a user that the service is available for, install or import the certificate PFX -[as described above](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-chrome). +[as described above](#authentication-error-occurred-using-chrome). ### Authentication Error Occurred in Firefox You cannot access the Studio using Firefox even though you have finished the setup wizard successfully and you also checked the box saying "Automatically register the admin client certificate in this (local) OS". diff --git a/docs/server/security/encryption/encryption-at-rest.mdx b/docs/server/security/encryption/encryption-at-rest.mdx index 2894c002af..f762a57e59 100644 --- a/docs/server/security/encryption/encryption-at-rest.mdx +++ b/docs/server/security/encryption/encryption-at-rest.mdx @@ -33,7 +33,7 @@ As long as the database is idle and there are no requests to serve, everything i Once a request is made, RavenDB will start a transaction (either read or write) and decrypt just the necessary data into memory. Then it will serve the request, and when the transaction is finished, modified pages are encrypted and written back to the datafile. The data is -[locked](../../../server/security/encryption/encryption-at-rest.mdx#locking-memory) during the transaction by default, and it is zeroed when the transaction completes. +[locked](#locking-memory) during the transaction by default, and it is zeroed when the transaction completes. 1. RavenDB makes sure that **no data is written to disk as plain text**. It will always be encrypted. diff --git a/docs/server/security/encryption/secret-key-management.mdx b/docs/server/security/encryption/secret-key-management.mdx index d1a919873a..63e3a2f261 100644 --- a/docs/server/security/encryption/secret-key-management.mdx +++ b/docs/server/security/encryption/secret-key-management.mdx @@ -21,8 +21,8 @@ If the key is to be encrypted, another key is needed, and so on. In RavenDB this can be handled in one of two ways: -1. [Providing a master key to RavenDB](../../../server/security/encryption/secret-key-management.mdx#providing-a-master-key-to-ravendb) -2. [Relying on the OS protection methods](../../../server/security/encryption/secret-key-management.mdx#relying-on-the-os-protection-methods) +1. [Providing a master key to RavenDB](#providing-a-master-key-to-ravendb) +2. [Relying on the OS protection methods](#relying-on-the-os-protection-methods) ## Providing a Master Key to RavenDB diff --git a/docs/server/storage/content/_documents-compression-csharp.mdx b/docs/server/storage/content/_documents-compression-csharp.mdx index 0d136ec0a6..b86d76fac9 100644 --- a/docs/server/storage/content/_documents-compression-csharp.mdx +++ b/docs/server/storage/content/_documents-compression-csharp.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; or by updating the database record from the Client API, see below. * In this page: - * [Overview](../../../server/storage/documents-compression.mdx#overview) - * [Compression -vs- Compaction](../../../server/storage/documents-compression.mdx#compression--vs--compaction) - * [Set compression for all collections](../../../server/storage/documents-compression.mdx#set-compression-for-all-collections) - * [Set compression for selected collections](../../../server/storage/documents-compression.mdx#set-compression-for-selected-collections) - * [Syntax](../../../server/storage/documents-compression.mdx#syntax) + * [Overview](#overview) + * [Compression -vs- Compaction](#compression--vs--compaction) + * [Set compression for all collections](#set-compression-for-all-collections) + * [Set compression for selected collections](#set-compression-for-selected-collections) + * [Syntax](#syntax) ## Overview diff --git a/docs/server/storage/content/_documents-compression-nodejs.mdx b/docs/server/storage/content/_documents-compression-nodejs.mdx index 41d6ab887b..d8a9eac073 100644 --- a/docs/server/storage/content/_documents-compression-nodejs.mdx +++ b/docs/server/storage/content/_documents-compression-nodejs.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; or by updating the database record from the Client API, see below. * In this page: - * [Overview](../../../server/storage/documents-compression.mdx#overview) - * [Compression -vs- Compaction](../../../server/storage/documents-compression.mdx#compression--vs--compaction) - * [Set compression for all collections](../../../server/storage/documents-compression.mdx#set-compression-for-all-collections) - * [Set compression for selected collections](../../../server/storage/documents-compression.mdx#set-compression-for-selected-collections) - * [Syntax](../../../server/storage/documents-compression.mdx#syntax) + * [Overview](#overview) + * [Compression -vs- Compaction](#compression--vs--compaction) + * [Set compression for all collections](#set-compression-for-all-collections) + * [Set compression for selected collections](#set-compression-for-selected-collections) + * [Syntax](#syntax) ## Overview diff --git a/docs/server/storage/customizing-raven-data-files-locations.mdx b/docs/server/storage/customizing-raven-data-files-locations.mdx index 34f65916a8..bb46681637 100644 --- a/docs/server/storage/customizing-raven-data-files-locations.mdx +++ b/docs/server/storage/customizing-raven-data-files-locations.mdx @@ -22,12 +22,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A script can be used to automate the different location definitions. * In this page: - * [Why store data on different devices](../../server/storage/customizing-raven-data-files-locations.mdx#why-store-data-on-different-devices) - * [Configuring temp files location](../../server/storage/customizing-raven-data-files-locations.mdx#configuring-temp-files-location) - * [Configuring data files location](../../server/storage/customizing-raven-data-files-locations.mdx#configuring-data-files-location) - * [Automate storage definitions](../../server/storage/customizing-raven-data-files-locations.mdx#automate-storage-definitions) - * [Script example - Basic usage](../../server/storage/customizing-raven-data-files-locations.mdx#script-example---basic-usage) - * [Script example - Point Indexes to different location](../../server/storage/customizing-raven-data-files-locations.mdx#script-example---point-indexes-to-different-location) + * [Why store data on different devices](#why-store-data-on-different-devices) + * [Configuring temp files location](#configuring-temp-files-location) + * [Configuring data files location](#configuring-data-files-location) + * [Automate storage definitions](#automate-storage-definitions) + * [Script example - Basic usage](#script-example---basic-usage) + * [Script example - Point Indexes to different location](#script-example---point-indexes-to-different-location) ## Why store data on different devices diff --git a/docs/server/storage/directory-structure.mdx b/docs/server/storage/directory-structure.mdx index 0a5a370028..35fbf4f2ee 100644 --- a/docs/server/storage/directory-structure.mdx +++ b/docs/server/storage/directory-structure.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * RavenDB keeps all data under the location specified by the [DataDir](../../server/configuration/core-configuration.mdx#datadir) configuration value. * In this page: - * [On-disk Data Structure](../../server/storage/directory-structure.mdx#on-disk-data-structure) - * [Voron Storage Environment](../../server/storage/directory-structure.mdx#voron-storage-environment) + * [On-disk Data Structure](#on-disk-data-structure) + * [Voron Storage Environment](#voron-storage-environment) ## On-disk Data Structure diff --git a/docs/server/storage/storage-engine.mdx b/docs/server/storage/storage-engine.mdx index e2cb14d145..c7f1ad0608 100644 --- a/docs/server/storage/storage-engine.mdx +++ b/docs/server/storage/storage-engine.mdx @@ -27,11 +27,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; Fixed-Sized B+Trees. * In this page: - * [Transaction support](../../server/storage/storage-engine.mdx#transaction-support) - * [Single write model](../../server/storage/storage-engine.mdx#single-write-model) - * [Memory-mapped files](../../server/storage/storage-engine.mdx#memory-mapped-files) - * [Requirements](../../server/storage/storage-engine.mdx#requirements) - * [Limitations](../../server/storage/storage-engine.mdx#limitations) + * [Transaction support](#transaction-support) + * [Single write model](#single-write-model) + * [Memory-mapped files](#memory-mapped-files) + * [Requirements](#requirements) + * [Limitations](#limitations) ## Transaction support diff --git a/docs/server/tcp-compression.mdx b/docs/server/tcp-compression.mdx index 4c1acf5818..c8765a2995 100644 --- a/docs/server/tcp-compression.mdx +++ b/docs/server/tcp-compression.mdx @@ -27,10 +27,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [TCP Compression](../server/tcp-compression.mdx#tcp-compression) - * [Compression Algorithm and Ratio](../server/tcp-compression.mdx#compression-algorithm-and-ratio) - * [Enabling TCP Compression](../server/tcp-compression.mdx#enabling-tcp-compression) - * [Disabling TCP Compression](../server/tcp-compression.mdx#disabling-tcp-compression) + * [TCP Compression](#tcp-compression) + * [Compression Algorithm and Ratio](#compression-algorithm-and-ratio) + * [Enabling TCP Compression](#enabling-tcp-compression) + * [Disabling TCP Compression](#disabling-tcp-compression) ## TCP Compression diff --git a/docs/server/troubleshooting/collect-info.mdx b/docs/server/troubleshooting/collect-info.mdx index 006b6d340f..5813421cda 100644 --- a/docs/server/troubleshooting/collect-info.mdx +++ b/docs/server/troubleshooting/collect-info.mdx @@ -25,12 +25,12 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [Provide incident description](../../server/troubleshooting/collect-info.mdx#provide-incident-description) - * [Create debug package](../../server/troubleshooting/collect-info.mdx#create-debug-package) - * [Enable logs for ongoing issues](../../server/troubleshooting/collect-info.mdx#enable-logs-for-ongoing-issues) - * [Download logs](../../server/troubleshooting/collect-info.mdx#download-logs) - * [Reproduce scenario](../../server/troubleshooting/collect-info.mdx#reproduce-scenario) - * [Create failing test](../../server/troubleshooting/collect-info.mdx#create-failing-test) + * [Provide incident description](#provide-incident-description) + * [Create debug package](#create-debug-package) + * [Enable logs for ongoing issues](#enable-logs-for-ongoing-issues) + * [Download logs](#download-logs) + * [Reproduce scenario](#reproduce-scenario) + * [Create failing test](#create-failing-test) @@ -188,7 +188,7 @@ avoiding potential loss due to the retention configuration. * If the incident is over and you can reproduce it, then first verify logging level is set to '**Debug**'. -* See how to enable the logs in [Enable logs](../../server/troubleshooting/collect-info.mdx#enable-logs-for-ongoing-issues). +* See how to enable the logs in [Enable logs](#enable-logs-for-ongoing-issues). diff --git a/docs/server/troubleshooting/debug-routes.mdx b/docs/server/troubleshooting/debug-routes.mdx index 713eeb1b83..a65e9e880d 100644 --- a/docs/server/troubleshooting/debug-routes.mdx +++ b/docs/server/troubleshooting/debug-routes.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page contains a comprehensive list of endpoints for debugging and testing. * In this page: - * [Debug Endpoints](../../server/troubleshooting/debug-routes.mdx#debug-endpoints) - * [Production Endpoints](../../server/troubleshooting/debug-routes.mdx#production-endpoints) + * [Debug Endpoints](#debug-endpoints) + * [Production Endpoints](#production-endpoints) For the endpoints that begin with `/databases/*/`, replace `*` with the name of your database. diff --git a/docs/server/troubleshooting/logging.mdx b/docs/server/troubleshooting/logging.mdx index ea87b2c7b5..057fea14e2 100644 --- a/docs/server/troubleshooting/logging.mdx +++ b/docs/server/troubleshooting/logging.mdx @@ -18,7 +18,7 @@ import Panel from '@site/src/components/Panel'; * **Multiple logging levels** RavenDB provides a flexible logging system that lets you control the volume and detail of logged information - by selecting the most suitable logging level from a [scale of six](../../server/troubleshooting/logging.mdx#available-logging-levels). + by selecting the most suitable logging level from a [scale of six](#available-logging-levels). For example, the _Trace_ level captures all events, transactions, and database changes, producing logs that can be processed for auditing or detailed analysis, while _Warning_ level limits output to warnings and errors, helping keep logs focused and readable even in large or complex systems. @@ -31,21 +31,21 @@ import Panel from '@site/src/components/Panel'; Logging is asynchronous and is handled by a thread dedicated to the execution of I/O operations, minimizing its effect on server performance. * In this page: - * [Available logging destinations](../../server/troubleshooting/logging.mdx#available-logging-destinations) - * [Logging configuration](../../server/troubleshooting/logging.mdx#logging-configuration) - * [Available logging levels](../../server/troubleshooting/logging.mdx#available-logging-levels) - * [Customizing logging level after Migration](../../server/troubleshooting/logging.mdx#customizing-logging-level-after-migration) - * [Default values](../../server/troubleshooting/logging.mdx#default-values) - * [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) - * [CLI customization: immediate temporary changes](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) - * [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) - * [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#1-configure-ravendb-to-use-an-external-nlog-configuration-file) - * [Configure RavenDB to use NLog plugins for streaming log data](../../server/troubleshooting/logging.mdx#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) - * [Set your NLog configuration file](../../server/troubleshooting/logging.mdx#3-set-your-nlog-configuration-file) - * [An available template](../../server/troubleshooting/logging.mdx#an-available-template) - * [Mandatory `logger` definitions](../../server/troubleshooting/logging.mdx#mandatory-logger-definitions) - * [Your own loggers](../../server/troubleshooting/logging.mdx#your-own-loggers) - * [Studio: the Admin Logs view](../../server/troubleshooting/logging.mdx#studio-the-admin-logs-view) + * [Available logging destinations](#available-logging-destinations) + * [Logging configuration](#logging-configuration) + * [Available logging levels](#available-logging-levels) + * [Customizing logging level after Migration](#customizing-logging-level-after-migration) + * [Default values](#default-values) + * [Microsoft logs](#microsoft-logs) + * [CLI customization: immediate temporary changes](#cli-customization-immediate-temporary-changes) + * [Configuring and using NLog](#configuring-and-using-nlog) + * [Configure RavenDB to use an external NLog configuration file](#1-configure-ravendb-to-use-an-external-nlog-configuration-file) + * [Configure RavenDB to use NLog plugins for streaming log data](#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) + * [Set your NLog configuration file](#3-set-your-nlog-configuration-file) + * [An available template](#an-available-template) + * [Mandatory `logger` definitions](#mandatory-logger-definitions) + * [Your own loggers](#your-own-loggers) + * [Studio: the Admin Logs view](#studio-the-admin-logs-view) @@ -71,11 +71,11 @@ filtering and error handling tools, and a long list of applications that NLog is * Changing logging settings using an external configuration file is possible from version `7.0` on, as part of NLog's integration with RavenDB. * Once an external configuration file is applied, its settings override all the values set by internal configuration keys. - * To set an external configuration file, see [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog). + * To set an external configuration file, see [Configuring and using NLog](#configuring-and-using-nlog). * To **determine whether to use an NLog configuration file or internal configuration keys**, set the [Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logsconfigpath) configuration key with - - - a [path](../../server/troubleshooting/logging.mdx#use-external-config-file) to the configuration file you want to apply + - a [path](#use-external-config-file) to the configuration file you want to apply - or `null` to continue using internal configuration keys. @@ -83,7 +83,7 @@ filtering and error handling tools, and a long list of applications that NLog is * **Permanent changes** to the logging configuration, whether defined via configuration keys or an external configuration file, take effect only after restarting the server. * **Temporary changes** can be applied at runtime, without requiring a server restart, using: - * the [CLI](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) + * the [CLI](#cli-customization-immediate-temporary-changes) * the [Admin Logs view](../../studio/server/debug/admin-logs.mdx) in the Studio * the [`SetLogsConfigurationOperation`](../../client-api/operations/server-wide/logs/set-logs-configuration.mdx) in the Client API @@ -154,7 +154,7 @@ You **will** need to update the logging settings if you want to take advantage o - * To output log data to a destination such as a log aggragation tool using an NLog plugin, you will need to start using an [NLog configuration file](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog), + * To output log data to a destination such as a log aggragation tool using an NLog plugin, you will need to start using an [NLog configuration file](#configuring-and-using-nlog), and then configure any NLog-specific settings, including the logging level, in that file: @@ -180,7 +180,7 @@ You **will** need to update the logging settings if you want to take advantage o * **Default destination** Log entries are written by default to log files in the **Logs** folder on the server machine. To store log files in a different path, set the [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration key. - Learn how to log to additional destinations in [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog). + Learn how to log to additional destinations in [Configuring and using NLog](#configuring-and-using-nlog). * **Default time standard** The default time standard used for log entries is `UTC`. Changing this configuration is now available only using the NLog configuration file. @@ -194,7 +194,7 @@ You **will** need to update the logging settings if you want to take advantage o * **NLog configuration file defaults** - The default values provided for settings in the [NLog configuration file template](../../server/troubleshooting/logging.mdx#an-available-template) + The default values provided for settings in the [NLog configuration file template](#an-available-template) are **identical** to those used by RavenDB's internal configuration keys. See the full list in: [Logging configuration keys and their default values](../../server/configuration/logs-configuration.mdx). @@ -255,9 +255,9 @@ ravendb> log debug To use NLog you need to: -1. [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#use-external-config-file) -2. [Configure RavenDB to use NLog plugins for streaming log data](../../server/troubleshooting/logging.mdx#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) -3. [Set your NLog configuration file](../../server/troubleshooting/logging.mdx#set-nlog-config-file) +1. [Configure RavenDB to use an external NLog configuration file](#use-external-config-file) +2. [Configure RavenDB to use NLog plugins for streaming log data](#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) +3. [Set your NLog configuration file](#set-nlog-config-file) @@ -283,7 +283,7 @@ To use a configuration file named `NLog.config` located in the RavenDB server di * Learn how to set configuration keys [here](../../server/configuration/configuration-options.mdx). -* Learn how to create and modify an Nlog configuration file [below](../../server/troubleshooting/logging.mdx#set-nlog-config-file). +* Learn how to create and modify an Nlog configuration file [below](#set-nlog-config-file). * Note: once a configuration file is used, the logging settings defined in it will _override_ all [internal configuration keys](../../server/configuration/logs-configuration.mdx) values. diff --git a/docs/server/troubleshooting/traffic-watch.mdx b/docs/server/troubleshooting/traffic-watch.mdx index bd6e602fdb..0e93a90dd0 100644 --- a/docs/server/troubleshooting/traffic-watch.mdx +++ b/docs/server/troubleshooting/traffic-watch.mdx @@ -23,8 +23,8 @@ import Panel from '@site/src/components/Panel'; Both the live stream and log-to-file can be active at the same time. * In this page: - * [Accessing Traffic Watch](../../server/troubleshooting/traffic-watch.mdx#accessing-traffic-watch) - * [Performance impact](../../server/troubleshooting/traffic-watch.mdx#performance-impact) + * [Accessing Traffic Watch](#accessing-traffic-watch) + * [Performance impact](#performance-impact) diff --git a/docs/sharding/administration/anchoring-documents.mdx b/docs/sharding/administration/anchoring-documents.mdx index d2e363b437..18a0890980 100644 --- a/docs/sharding/administration/anchoring-documents.mdx +++ b/docs/sharding/administration/anchoring-documents.mdx @@ -24,10 +24,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To gain control over which specific shard a document will reside in, see [sharding by prefix](../../sharding/administration/sharding-by-prefix.mdx). * In this page: - * [Overview](../../sharding/administration/anchoring-documents.mdx#overview) - * [Anchor multiple documents to the same bucket as a specific document](../../sharding/administration/anchoring-documents.mdx#anchor-multiple-documents-to-the-same-bucket-as-a-specific-document) - * [Anchor multiple documents using a common suffix](../../sharding/administration/anchoring-documents.mdx#anchor-multiple-documents-using-a-common-suffix) - * [Examples](../../sharding/administration/anchoring-documents.mdx#examples) + * [Overview](#overview) + * [Anchor multiple documents to the same bucket as a specific document](#anchor-multiple-documents-to-the-same-bucket-as-a-specific-document) + * [Anchor multiple documents using a common suffix](#anchor-multiple-documents-using-a-common-suffix) + * [Examples](#examples) ## Overview diff --git a/docs/sharding/administration/api-admin.mdx b/docs/sharding/administration/api-admin.mdx index 59fa51eaad..05b6bec2e4 100644 --- a/docs/sharding/administration/api-admin.mdx +++ b/docs/sharding/administration/api-admin.mdx @@ -20,15 +20,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; a sharded database using Studio. * In this page: - * [Creating a Sharded Database](../../sharding/administration/api-admin.mdx#creating-a-sharded-database) - * [Orchestrator Administration](../../sharding/administration/api-admin.mdx#orchestrator-administration) - * [Adding an Orchestrator](../../sharding/administration/api-admin.mdx#adding-an-orchestrator) - * [Removing an Orchestrator](../../sharding/administration/api-admin.mdx#removing-an-orchestrator) - * [Shard Administration](../../sharding/administration/api-admin.mdx#shard-administration) - * [Adding a Shard](../../sharding/administration/api-admin.mdx#adding-a-shard) - * [Adding a Shard Replica](../../sharding/administration/api-admin.mdx#adding-a-shard-replica) - * [Promoting a Shard Replica](../../sharding/administration/api-admin.mdx#promoting-a-shard-replica) - * [Removing a Shard](../../sharding/administration/api-admin.mdx#removing-a-shard) + * [Creating a Sharded Database](#creating-a-sharded-database) + * [Orchestrator Administration](#orchestrator-administration) + * [Adding an Orchestrator](#adding-an-orchestrator) + * [Removing an Orchestrator](#removing-an-orchestrator) + * [Shard Administration](#shard-administration) + * [Adding a Shard](#adding-a-shard) + * [Adding a Shard Replica](#adding-a-shard-replica) + * [Promoting a Shard Replica](#promoting-a-shard-replica) + * [Removing a Shard](#removing-a-shard) ## Creating a Sharded Database diff --git a/docs/sharding/administration/sharding-by-prefix.mdx b/docs/sharding/administration/sharding-by-prefix.mdx index f1e5e72490..c93907a43a 100644 --- a/docs/sharding/administration/sharding-by-prefix.mdx +++ b/docs/sharding/administration/sharding-by-prefix.mdx @@ -25,20 +25,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * With prefixed sharding, you only control the shard where a document is stored. You cannot control the specific bucket within that shard where the document will reside. This can be partially addressed by [anchoring documents](../../sharding/administration/anchoring-documents.mdx) to a bucket. - Learn more [below](../../sharding/administration/sharding-by-prefix.mdx#prefixed-sharding-vs-anchoring-documents). + Learn more [below](#prefixed-sharding-vs-anchoring-documents). * In this page: - * [Why use prefixed sharding](../../sharding/administration/sharding-by-prefix.mdx#why-use-prefixed-sharding) - * [Overview](../../sharding/administration/sharding-by-prefix.mdx#overview) - * [Bucket management](../../sharding/administration/sharding-by-prefix.mdx#bucket-management) - * [Adding prefixes via Studio](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-studio) - * [Adding prefixes via Client API](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-client-api) - * [Add prefixes when creating a database](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-when-creating-a-database) - * [Add prefixes after database creation](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-after-database-creation) - * [Removing prefixes](../../sharding/administration/sharding-by-prefix.mdx#removing-prefixes) - * [Updating shard configurations for prefixes](../../sharding/administration/sharding-by-prefix.mdx#updating-shard-configurations-for-prefixes) - * [Querying selected shards by prefix](../../sharding/administration/sharding-by-prefix.mdx#querying-selected-shards-by-prefix) - * [Prefixed sharding vs Anchoring documents](../../sharding/administration/sharding-by-prefix.mdx#prefixed-sharding-vs-anchoring-documents) + * [Why use prefixed sharding](#why-use-prefixed-sharding) + * [Overview](#overview) + * [Bucket management](#bucket-management) + * [Adding prefixes via Studio](#adding-prefixes-via-studio) + * [Adding prefixes via Client API](#adding-prefixes-via-client-api) + * [Add prefixes when creating a database](#add-prefixes-when-creating-a-database) + * [Add prefixes after database creation](#add-prefixes-after-database-creation) + * [Removing prefixes](#removing-prefixes) + * [Updating shard configurations for prefixes](#updating-shard-configurations-for-prefixes) + * [Querying selected shards by prefix](#querying-selected-shards-by-prefix) + * [Prefixed sharding vs Anchoring documents](#prefixed-sharding-vs-anchoring-documents) ## Why use prefixed sharding @@ -72,7 +72,7 @@ reduces network latency for region-specific operations, and enhances overall sys * To store documents on a specific shard, define the target shard for each document ID prefix that you add. Documents with IDs matching any of the defined prefixes will be routed to the corresponding shard. - Learn how to [add prefixes](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-client-api) below. + Learn how to [add prefixes](#adding-prefixes-via-client-api) below. * For example, you can define that all documents with an ID starting with `users/us/` will be stored in shard **#0**. Consequently, the following sample documents will be stored in shard **#0**: @@ -393,7 +393,7 @@ await store.Maintenance.SendAsync(deletePrefixOp); * **When removing a shard from an existing prefix configuration**, you must first manually move the buckets from the removed shard to the other shards that are assigned to this prefix. -* In the below example, in addition to shard **#2** that was configured in the [previous](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-after-database-creation) example, +* In the below example, in addition to shard **#2** that was configured in the [previous](#add-prefixes-after-database-creation) example, we are adding shard **#0** as a destination for documents with prefix `users/eu/`. diff --git a/docs/sharding/administration/studio-admin.mdx b/docs/sharding/administration/studio-admin.mdx index 8287a7f19b..0ed727ea13 100644 --- a/docs/sharding/administration/studio-admin.mdx +++ b/docs/sharding/administration/studio-admin.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; a sharded database using API commands. * In this page: - * [Creating a sharded database](../../sharding/administration/studio-admin.mdx#creating-a-sharded-database) - * [Database View](../../sharding/administration/studio-admin.mdx#database-view) - * [Database Group](../../sharding/administration/studio-admin.mdx#database-group) + * [Creating a sharded database](#creating-a-sharded-database) + * [Database View](#database-view) + * [Database Group](#database-group) ## Creating a sharded database @@ -101,7 +101,7 @@ be available here: 6. **Backups view** Click to manage [backup tasks](../../backup/create/periodic-tasks/database-backup#creating-and-managing-periodic-backups-via-studio) and restore existing backups. 7. **Manage group** - Click to manage the database group ([see below](../../sharding/administration/studio-admin.mdx#database-group)). + Click to manage the database group ([see below](#database-group)). diff --git a/docs/sharding/backup-and-restore/backup.mdx b/docs/sharding/backup-and-restore/backup.mdx index 361ee7dfa7..16573b0cc1 100644 --- a/docs/sharding/backup-and-restore/backup.mdx +++ b/docs/sharding/backup-and-restore/backup.mdx @@ -34,15 +34,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; * A [one-time](../../backup/create/one-time-backup.mdx) backup **can** be created for a sharded database. * In this article: - * [Sharded and non-sharded backup tasks](../../sharding/backup-and-restore/backup.mdx#sharded-and-non-sharded-backup-tasks) - * [Backup storage: local and remote](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) - * [Backup files extension and structure](../../sharding/backup-and-restore/backup.mdx#backup-files-extension-and-structure) - * [Backup type](../../sharding/backup-and-restore/backup.mdx#backup-type) - * [Backup scope](../../sharding/backup-and-restore/backup.mdx#backup-scope) - * [Naming convention](../../sharding/backup-and-restore/backup.mdx#naming-convention) - * [Server-wide backup](../../sharding/backup-and-restore/backup.mdx#server-wide-backup) - * [Example](../../sharding/backup-and-restore/backup.mdx#example) - * [Backup options summary](../../sharding/backup-and-restore/backup.mdx#backup-options-summary) + * [Sharded and non-sharded backup tasks](#sharded-and-non-sharded-backup-tasks) + * [Backup storage: local and remote](#backup-storage-local-and-remote) + * [Backup files extension and structure](#backup-files-extension-and-structure) + * [Backup type](#backup-type) + * [Backup scope](#backup-scope) + * [Naming convention](#naming-convention) + * [Server-wide backup](#server-wide-backup) + * [Example](#example) + * [Backup options summary](#backup-options-summary) @@ -81,7 +81,7 @@ and keep backup files in manageable proportions no matter what the overall datab Backup files can be stored locally and remotely. -Find a code example [here](../../sharding/backup-and-restore/backup.mdx#example). +Find a code example [here](#example). * **Local backup** A shard's backup task may keep backup data locally, using the node's local storage. @@ -229,14 +229,14 @@ This type is specific to a sharded database, and casting it using a non-sharded | Option | Available on a Sharded Database | Comment | | ------ | ------------------------------- | ------- | | Store backup files created by shards in **local shard machine storage** | **Yes** | Shards can store the backups they create locally. | -| Store backup files of sharded databases [remotely](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Shards can store the backups they create on remote S3, Azure, or Google Cloud destinations. | +| Store backup files of sharded databases [remotely](#backup-storage-local-and-remote) | **Yes** | Shards can store the backups they create on remote S3, Azure, or Google Cloud destinations. | | Create [Full](../../backup/overview#full-backup) backups for sharded databases | **Yes** | | | Create [Incremental](../../backup/overview#incremental-backup) backups for sharded databases | **Yes** | | | Create [Logical](../../backup/overview#logical-backup) backups for sharded databases | **Yes** | | | Create [Snapshot](../../backup/overview#snapshot-image) backups for sharded databases | **No** | Snapshot backups CANNOT be created for (nor restored to) sharded databases. | | Create **periodic backup tasks** for sharded databases | **Yes** | | | Run a manual [one-time](../../backup/create/one-time-backup) backup operation on a sharded database | **Yes** | | -| Include sharded databases in a [server-wide backup operation](../../sharding/backup-and-restore/backup.mdx#server-wide-backup) | **Yes (logical only)** | A server-wide **logical** backup includes all databases, including sharded ones. Sharded databases are automatically **excluded** from server-wide **snapshot** backups. | +| Include sharded databases in a [server-wide backup operation](#server-wide-backup) | **Yes (logical only)** | A server-wide **logical** backup includes all databases, including sharded ones. Sharded databases are automatically **excluded** from server-wide **snapshot** backups. | diff --git a/docs/sharding/backup-and-restore/restore.mdx b/docs/sharding/backup-and-restore/restore.mdx index 47468f689a..a8e695b0fd 100644 --- a/docs/sharding/backup-and-restore/restore.mdx +++ b/docs/sharding/backup-and-restore/restore.mdx @@ -24,7 +24,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; can retrieve and restore them. Shards must be restored in their - [original order](../../sharding/backup-and-restore/restore.mdx#restore). + [original order](#restore). The backup of shard 1, for example, must be restored as shard 1. * Backup files can be restored from local shard node storage or from @@ -43,13 +43,13 @@ import ContentFrame from "@site/src/components/ContentFrame"; as a sharded database. * In this page: - * [Restore](../../sharding/backup-and-restore/restore.mdx#restore) - * [Set paths to backup files locations](../../sharding/backup-and-restore/restore.mdx#set-paths-to-backup-files-locations) - * [Define a restore configuration](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration) + * [Restore](#restore) + * [Set paths to backup files locations](#set-paths-to-backup-files-locations) + * [Define a restore configuration](#define-a-restore-configuration) * [Run `RestoreBackupOperation` with the restore configuration](../../sharding/backup-and-restore/restore#run-restorebackupoperation-with-the-restore-configuration) - * [Examples](../../sharding/backup-and-restore/restore.mdx#examples) - * [Restoring to a selected restore point](../../sharding/backup-and-restore/restore.mdx#restoring-to-a-selected-restore-point) - * [Restore options summary](../../sharding/backup-and-restore/restore.mdx#restore-options-summary) + * [Examples](#examples) + * [Restoring to a selected restore point](#restoring-to-a-selected-restore-point) + * [Restore options summary](#restore-options-summary) @@ -132,10 +132,10 @@ a **configuration object**. | Configuration Object | Backup Location | Additional Properties | | -------------------- | --------------- | --------------------- | - | `RestoreBackupConfiguration` | Local shard storage | None (see [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromS3Configuration` | AWS S3 Bucket | `S3Settings` (see S3 [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromAzureConfiguration` | MS Azure Blob | `AzureSettings` (see Azure [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromGoogleCloudConfiguration` | Google Cloud Bucket | `GoogleCloudSettings` (see Google Cloud [example](../../sharding/backup-and-restore/restore.mdx#examples)) | + | `RestoreBackupConfiguration` | Local shard storage | None (see [example](#examples)) | + | `RestoreFromS3Configuration` | AWS S3 Bucket | `S3Settings` (see S3 [example](#examples)) | + | `RestoreFromAzureConfiguration` | MS Azure Blob | `AzureSettings` (see Azure [example](#examples)) | + | `RestoreFromGoogleCloudConfiguration` | Google Cloud Bucket | `GoogleCloudSettings` (see Google Cloud [example](#examples)) |
@@ -194,7 +194,7 @@ public RestoreBackupOperation(RestoreBackupConfigurationBase restoreConfiguratio ``` * Instead of `RestoreBackupConfigurationBase`, use the configuration object - you [prepared](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration): + you [prepared](#define-a-restore-configuration): * `RestoreBackupConfiguration` for locally-stored backups * `RestoreFromS3Configuration` to restore from S3 * `RestoreFromAzureConfiguration` to restore from Azure @@ -626,7 +626,7 @@ backups that were added to it over time. | Option | Supported on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | | Restore from **local shard storage** | **Yes** | | -| Restore from a [remote location](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Define a [restore configuration](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration) with S3, Azure, or Google Cloud settings. | +| Restore from a [remote location](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Define a [restore configuration](#define-a-restore-configuration) with S3, Azure, or Google Cloud settings. | | Restore a **sharded database** backup
to a **sharded database** | **Yes** | | | Restore a **sharded database** backup
to a **non-sharded database** | **Yes** | | | Restore a **non-sharded database** backup
to a **sharded database** | **No** | A backup created for a non-sharded database **cannot** be restored to a sharded database. | diff --git a/docs/sharding/configuration.mdx b/docs/sharding/configuration.mdx index a74065efc8..9af46c56de 100644 --- a/docs/sharding/configuration.mdx +++ b/docs/sharding/configuration.mdx @@ -21,10 +21,10 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn how to apply configuration options in [Configuration Overview](../server/configuration/configuration-options.mdx). * In this article: - * [Sharding.Import.CompressionLevel](../sharding/configuration.mdx#shardingimportcompressionlevel) - * [Sharding.OrchestratorTimeoutInMin](../sharding/configuration.mdx#shardingorchestratortimeoutinmin) - * [Sharding.ShardExecutor.UseHttpCompression](../sharding/configuration.mdx#shardingshardexecutorusehttpcompression) - * [Sharding.ShardExecutor.UseHttpDecompression](../sharding/configuration.mdx#shardingshardexecutorusehttpdecompression) + * [Sharding.Import.CompressionLevel](#shardingimportcompressionlevel) + * [Sharding.OrchestratorTimeoutInMin](#shardingorchestratortimeoutinmin) + * [Sharding.ShardExecutor.UseHttpCompression](#shardingshardexecutorusehttpcompression) + * [Sharding.ShardExecutor.UseHttpDecompression](#shardingshardexecutorusehttpdecompression) diff --git a/docs/sharding/document-extensions.mdx b/docs/sharding/document-extensions.mdx index 87764bfb08..b1f3f0f899 100644 --- a/docs/sharding/document-extensions.mdx +++ b/docs/sharding/document-extensions.mdx @@ -34,10 +34,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; along with it to the new shard. * In this page: - * [Document Extensions and Resharding](../sharding/document-extensions.mdx#document-extensions-and-resharding) - * [Precautions and Recommendations](../sharding/document-extensions.mdx#precautions-and-recommendations) - * [Precautions](../sharding/document-extensions.mdx#precautions) - * [Recommendations](../sharding/document-extensions.mdx#recommendations) + * [Document Extensions and Resharding](#document-extensions-and-resharding) + * [Precautions and Recommendations](#precautions-and-recommendations) + * [Precautions](#precautions) + * [Recommendations](#recommendations) ## Document Extensions and Resharding diff --git a/docs/sharding/etl.mdx b/docs/sharding/etl.mdx index 12ddf8a3ed..f9ab26607a 100644 --- a/docs/sharding/etl.mdx +++ b/docs/sharding/etl.mdx @@ -25,17 +25,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; its own local ETL task, based on the user's settings. * Resharding may result in the transfer of some documents more than once to the ETL destination. It is the user's responsibility to - [detect and handle](../sharding/etl.mdx#etl-and-resharding) such duplicates. -* ETL tasks information is available [per database and per shard](../sharding/etl.mdx#retrieving-shard-specific-etl-task-info). + [detect and handle](#etl-and-resharding) such duplicates. +* ETL tasks information is available [per database and per shard](#retrieving-shard-specific-etl-task-info). * In this page: - * [ETL](../sharding/etl.mdx#etl) - * [Sharded and Non-Sharded ETL Tasks](../sharding/etl.mdx#sharded-and-non-sharded-etl-tasks) - * [Non-Sharded Database ETL Tasks](../sharding/etl.mdx#non-sharded-database-etl-tasks) - * [Sharded Database ETL Tasks](../sharding/etl.mdx#sharded-database-etl-tasks) - * [ETL and Resharding](../sharding/etl.mdx#etl-and-resharding) - * [ETL Queries](../sharding/etl.mdx#etl-queries) - * [Retrieving Shard-Specific ETL Task Info](../sharding/etl.mdx#retrieving-shard-specific-etl-task-info) + * [ETL](#etl) + * [Sharded and Non-Sharded ETL Tasks](#sharded-and-non-sharded-etl-tasks) + * [Non-Sharded Database ETL Tasks](#non-sharded-database-etl-tasks) + * [Sharded Database ETL Tasks](#sharded-database-etl-tasks) + * [ETL and Resharding](#etl-and-resharding) + * [ETL Queries](#etl-queries) + * [Retrieving Shard-Specific ETL Task Info](#retrieving-shard-specific-etl-task-info) ## ETL diff --git a/docs/sharding/external-replication.mdx b/docs/sharding/external-replication.mdx index e9f31b68d0..5363c71f0b 100644 --- a/docs/sharding/external-replication.mdx +++ b/docs/sharding/external-replication.mdx @@ -25,11 +25,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; their version is at least 6.0. * In this page: - * [Supported Versions](../sharding/external-replication.mdx#supported-versions) - * [External Replication Types](../sharding/external-replication.mdx#external-replication-types) - * [Non-Sharded Database to Sharded Database](../sharding/external-replication.mdx#non-sharded-database-to-sharded-database) - * [Sharded Database to Sharded Database](../sharding/external-replication.mdx#sharded-database-to-sharded-database) - * [Performance Considerations](../sharding/external-replication.mdx#performance-considerations) + * [Supported Versions](#supported-versions) + * [External Replication Types](#external-replication-types) + * [Non-Sharded Database to Sharded Database](#non-sharded-database-to-sharded-database) + * [Sharded Database to Sharded Database](#sharded-database-to-sharded-database) + * [Performance Considerations](#performance-considerations) ## Supported Versions diff --git a/docs/sharding/import-and-export.mdx b/docs/sharding/import-and-export.mdx index 49cd9d5fd0..1fca74facc 100644 --- a/docs/sharding/import-and-export.mdx +++ b/docs/sharding/import-and-export.mdx @@ -34,9 +34,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Behind the scenes, Studio uses Smuggler to perform these operations. * In this article: - * [Export](../sharding/import-and-export.mdx#export) - * [Import](../sharding/import-and-export.mdx#import) - * [Export and Import Options Summary](../sharding/import-and-export.mdx#export-and-import-options-summary) + * [Export](#export) + * [Import](#import) + * [Export and Import Options Summary](#export-and-import-options-summary) @@ -66,7 +66,7 @@ and casting it using a non-sharded type [will fail](../migration/client-api/prev ## Import Smuggler can be used to [import](../client-api/smuggler/what-is-smuggler.mdx#import) -data into a database from either a [.ravendbdump](../sharding/import-and-export.mdx#export) +data into a database from either a [.ravendbdump](#export) file or from backup files (full or incremental). When data is imported into a sharded database one of the shard nodes is appointed **orchestrator**; the orchestrator retrieves items from @@ -128,7 +128,7 @@ Import the full backup first, and then the incremental backups that complement i | Option | Available on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | -| Export and Import [.ravendbdump](../sharding/import-and-export.mdx#export) files using [Smuggler](../client-api/smuggler/what-is-smuggler.mdx) | **Yes** | Smuggler behaves just like it does on non-sharded databases. | +| Export and Import [.ravendbdump](#export) files using [Smuggler](../client-api/smuggler/what-is-smuggler.mdx) | **Yes** | Smuggler behaves just like it does on non-sharded databases. | | [Export](../studio/database/tasks/export-database.mdx) and [import](../studio/database/tasks/import-data/import-data-file.mdx) sharded database data using Studio | **Yes** | Behind the scenes, Studio uses Smuggler. | | Export to **client machine** | **Yes** | | | Export to **local shard node storage** | **No** | | diff --git a/docs/sharding/indexing.mdx b/docs/sharding/indexing.mdx index ede046926a..f46a06e331 100644 --- a/docs/sharding/indexing.mdx +++ b/docs/sharding/indexing.mdx @@ -23,9 +23,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; Unsupported features are listed below. * In this article: - * [Indexing in a sharded database](../sharding/indexing.mdx#indexing-in-a-sharded-database) - * [Map-Reduce indexes in a sharded database](../sharding/indexing.mdx#map-reduce-indexes-in-a-sharded-database) - * [Unsupported indexing features](../sharding/indexing.mdx#unsupported-indexing-features) + * [Indexing in a sharded database](#indexing-in-a-sharded-database) + * [Map-Reduce indexes in a sharded database](#map-reduce-indexes-in-a-sharded-database) + * [Unsupported indexing features](#unsupported-indexing-features) diff --git a/docs/sharding/migration.mdx b/docs/sharding/migration.mdx index ba60dcdd4f..48a39a2d27 100644 --- a/docs/sharding/migration.mdx +++ b/docs/sharding/migration.mdx @@ -32,9 +32,9 @@ database to the new one in several ways. of the replica. * In this page: - * [Export & Import](../sharding/migration.mdx#export--import) - * [Backup](../sharding/migration.mdx#backup) - * [External Replication](../sharding/migration.mdx#external-replication) + * [Export & Import](#export--import) + * [Backup](#backup) + * [External Replication](#external-replication) ## Export & Import diff --git a/docs/sharding/overview.mdx b/docs/sharding/overview.mdx index a15860eab8..26cd707eab 100644 --- a/docs/sharding/overview.mdx +++ b/docs/sharding/overview.mdx @@ -24,21 +24,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; (e.g., a 10-terabyte DB). * In this article: - * [Sharding](../sharding/overview.mdx#sharding) - * [Licensing](../sharding/overview.mdx#licensing) - * [Client compatibility](../sharding/overview.mdx#client-compatibility) - * [Client-Server communication](../sharding/overview.mdx#client-server-communication) - * [When should sharding be used?](../sharding/overview.mdx#when-should-sharding-be-used) - * [Shards](../sharding/overview.mdx#shards) - * [Shard replication](../sharding/overview.mdx#shard-replication) - * [How documents are distributed among shards](../sharding/overview.mdx#how-documents-are-distributed-among-shards) - * [Buckets allocation](../sharding/overview.mdx#buckets-allocation) - * [Buckets population](../sharding/overview.mdx#buckets-population) - * [Document extensions storage](../sharding/overview.mdx#document-extensions-storage) - * [Resharding](../sharding/overview.mdx#resharding) - * [Paging](../sharding/overview.mdx#paging) - * [Using local IP addresses](../sharding/overview.mdx#using-local-ip-addresses) - * [Creating a sharded database](../sharding/overview.mdx#creating-a-sharded-database) + * [Sharding](#sharding) + * [Licensing](#licensing) + * [Client compatibility](#client-compatibility) + * [Client-Server communication](#client-server-communication) + * [When should sharding be used?](#when-should-sharding-be-used) + * [Shards](#shards) + * [Shard replication](#shard-replication) + * [How documents are distributed among shards](#how-documents-are-distributed-among-shards) + * [Buckets allocation](#buckets-allocation) + * [Buckets population](#buckets-population) + * [Document extensions storage](#document-extensions-storage) + * [Resharding](#resharding) + * [Paging](#paging) + * [Using local IP addresses](#using-local-ip-addresses) + * [Creating a sharded database](#creating-a-sharded-database) @@ -48,7 +48,7 @@ As a database grows [very large](https://en.wikipedia.org/wiki/Very_large_databa System performance may suffer as resources like RAM, CPU, and storage are exhausted, routine chores like indexing and backup become massive tasks, responsiveness to client requests and queries slows down, and the system's throughput spreads thin serving an ever-growing number of clients. -With sharding, as the volume of stored data grows, the database can be scaled out by splitting it into [shards](../sharding/overview.mdx#shards). +With sharding, as the volume of stored data grows, the database can be scaled out by splitting it into [shards](#shards). This allows the database to be managed by multiple nodes and effectively removes most limits on its growth. In this manner, the size of the overall database, comprised of all shards, can reach dozens of terabytes and more, while keeping the resources of each shard in check and maintaining high performance and throughput. @@ -125,7 +125,7 @@ Take a 3-shard database, in which shard **1** is populated with documents `Users shard **2** contains documents `Users/2001`..`Users/4000`, and shard **3** contains `Users/4001`..`Users/6000`. A client that connects to this database to retrieve `Users/3000` and `Users/5000` would be served by an -automatically-appointed [orchestrator node](../sharding/overview.mdx#client-server-communication) +automatically-appointed [orchestrator node](#client-server-communication) that would seamlessly retrieve `Users/3000` from shard **2** and `Users/5000` from shard **3** and hand them to the client. diff --git a/docs/sharding/querying.mdx b/docs/sharding/querying.mdx index 92fae31260..812afb3711 100644 --- a/docs/sharding/querying.mdx +++ b/docs/sharding/querying.mdx @@ -20,23 +20,23 @@ import ContentFrame from "@site/src/components/ContentFrame"; so queries written for a non-sharded database can usually be used without modification. * Some querying features are not yet implemented. - Others, such as [filter](../sharding/querying.mdx#filter), behave a little differently in a sharded database. + Others, such as [filter](#filter), behave a little differently in a sharded database. These cases are described below. * In this article: - * [Querying a sharded database](../sharding/querying.mdx#querying-a-sharded-database) - * [Querying selected shards](../sharding/querying.mdx#querying-selected-shards) - * [Including items in a query](../sharding/querying.mdx#including-items-in-a-query) - * [Paging query results](../sharding/querying.mdx#paging-query-results) - * [Streaming query results](../sharding/querying.mdx#streaming-query-results) - * [Filtering query results](../sharding/querying.mdx#filtering-query-results) - * [`where`](../sharding/querying.mdx#where) - * [`filter`](../sharding/querying.mdx#filter) - * [`where` vs `filter` recommendations](../sharding/querying.mdx#wherevsfilterrecommendations) - * [Loading a document within a projection](../sharding/querying.mdx#loading-a-document-within-a-projection) - * [`order by` and `limit` in a Map-Reduce query](../sharding/querying.mdx#order-by-and-limit-in-a-map-reduce-query) - * [Timing queries](../sharding/querying.mdx#timing-queries) - * [Unsupported querying features](../sharding/querying.mdx#unsupported-querying-features) + * [Querying a sharded database](#querying-a-sharded-database) + * [Querying selected shards](#querying-selected-shards) + * [Including items in a query](#including-items-in-a-query) + * [Paging query results](#paging-query-results) + * [Streaming query results](#streaming-query-results) + * [Filtering query results](#filtering-query-results) + * [`where`](#where) + * [`filter`](#filter) + * [`where` vs `filter` recommendations](#wherevsfilterrecommendations) + * [Loading a document within a projection](#loading-a-document-within-a-projection) + * [`order by` and `limit` in a Map-Reduce query](#order-by-and-limit-in-a-map-reduce-query) + * [Timing queries](#timing-queries) + * [Unsupported querying features](#unsupported-querying-features) @@ -278,7 +278,7 @@ where Name == "Joe" * Although includes are supported in regular sharded queries, they are **not** supported when query results are **streamed**. - Learn more in [Streaming query results](../sharding/querying.mdx#streaming-query-results). + Learn more in [Streaming query results](#streaming-query-results). @@ -520,7 +520,7 @@ Both static index queries and dynamic queries (auto-indexes) are supported. -Data can be filtered using the [where](../sharding/querying.mdx#where) and [filter](../sharding/querying.mdx#filter) keywords on both non-sharded and sharded databases. +Data can be filtered using the [where](#where) and [filter](#filter) keywords on both non-sharded and sharded databases. However, in a sharded database, **when filtering results from a Map-Reduce index query or a dynamic aggregation query**, these commands behave differently. @@ -557,11 +557,11 @@ The server uses it to retrieve only items that match the specified conditions. * Each shard evaluates the `where` condition using only the data stored on that shard. * If a product was sold 4000 times on each shard, the query shown above will filter it out on every shard — even though its total sales across the database far exceed 5000. - * To address this, use the [filter](../sharding/querying.mdx#filter) keyword instead, + * To address this, use the [filter](#filter) keyword instead, whose behavior on sharded databases is designed for exactly this case. * Note: using `where` does **not** cause this problem when filtering on a `GroupBy` field (the reduce-key), and is actually the recommended approach in that case. - Learn more in [`where` vs `filter` recommendations](../sharding/querying.mdx#wherevsfilterrecommendations) below. + Learn more in [`where` vs `filter` recommendations](#wherevsfilterrecommendations) below. @@ -951,13 +951,13 @@ Querying features that are not supported or not yet implemented in sharded datab will throw a `NotSupportedInShardingException`. * **Loading a document within a Map-Reduce projection** - Read more about this topic in [Loading a document within a projection](../sharding/querying.mdx#loading-a-document-within-a-projection) above. + Read more about this topic in [Loading a document within a projection](#loading-a-document-within-a-projection) above. * **Ordering streamed Map-Reduce results by _non-reduce-key_ fields** - Read more about this topic in [Streaming query results](../sharding/querying.mdx#streaming-query-results) above. + Read more about this topic in [Streaming query results](#streaming-query-results) above. * **_Includes_ and _loads_ are not supported in sharded streaming queries** - Read more about this topic in [Streaming query results](../sharding/querying.mdx#streaming-query-results) above. + Read more about this topic in [Streaming query results](#streaming-query-results) above. * **Querying for similar documents with _MoreLikeThis_** [MoreLikeThis](../client-api/session/querying/how-to-use-morelikethis.mdx) is not supported in a sharded database. diff --git a/docs/sharding/resharding.mdx b/docs/sharding/resharding.mdx index c73fa01905..dda4b7bb79 100644 --- a/docs/sharding/resharding.mdx +++ b/docs/sharding/resharding.mdx @@ -30,14 +30,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; at a time, to avoid resource overuse. * In this page: - * [Resharding](../sharding/resharding.mdx#resharding) - * [The Resharding Process](../sharding/resharding.mdx#the-resharding-process) - * [Following Resharding Progress](../sharding/resharding.mdx#following-resharding-progress) - * [Racing](../sharding/resharding.mdx#racing) - * [Change Vector on a Sharded Database](../sharding/resharding.mdx#change-vector-on-a-sharded-database) - * [Resharding and Other Features](../sharding/resharding.mdx#resharding-and-other-features) - * [Executing Resharding](../sharding/resharding.mdx#executing-resharding) - * [Bucket Ownership](../sharding/resharding.mdx#bucket-ownership) + * [Resharding](#resharding) + * [The Resharding Process](#the-resharding-process) + * [Following Resharding Progress](#following-resharding-progress) + * [Racing](#racing) + * [Change Vector on a Sharded Database](#change-vector-on-a-sharded-database) + * [Resharding and Other Features](#resharding-and-other-features) + * [Executing Resharding](#executing-resharding) + * [Bucket Ownership](#bucket-ownership) ## Resharding @@ -83,7 +83,7 @@ using a database like the one shown below: You can follow the progress of the resharding progress using - * **Studio Popup Messages** - When [Studio is used for resharding](../sharding/resharding.mdx#executing-resharding) + When [Studio is used for resharding](#executing-resharding) the user interface produces popup messages to keep users informed of its progress. @@ -178,7 +178,7 @@ related to them, including revisions, time series, attachments, and so on, resharding a large document's bucket may take a considerable amount of time. During this time, checking which shard the bucket belongs to -[may show](../sharding/resharding.mdx#bucket-ownership) +[may show](#bucket-ownership) both the bucket's source and destination shards. However, if documents stored in this bucket are [queried](../sharding/querying.mdx) during this time, RavenDB will add them to the retrieved dataset diff --git a/docs/sharding/subscriptions.mdx b/docs/sharding/subscriptions.mdx index 3711a48ca2..0227182714 100644 --- a/docs/sharding/subscriptions.mdx +++ b/docs/sharding/subscriptions.mdx @@ -28,8 +28,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; that serve the workers, and shards that serve the orchestrators. * In this page: - * [Data Subscriptions in a Sharded Database](../sharding/subscriptions.mdx#data-subscriptions-in-a-sharded-database) - * [Unsupported Features](../sharding/subscriptions.mdx#unsupported-features) + * [Data Subscriptions in a Sharded Database](#data-subscriptions-in-a-sharded-database) + * [Unsupported Features](#unsupported-features) ## Data Subscriptions in a Sharded Database diff --git a/docs/sharding/unsupported.mdx b/docs/sharding/unsupported.mdx index 8a630d20e1..a143d71155 100644 --- a/docs/sharding/unsupported.mdx +++ b/docs/sharding/unsupported.mdx @@ -21,17 +21,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; The list below details these unsupported features. * In this article: - * [Unsupported Indexing Features](../sharding/unsupported.mdx#unsupported-indexing-features) - * [Unsupported Querying Features](../sharding/unsupported.mdx#unsupported-querying-features) - * [Unsupported Document Extensions Features](../sharding/unsupported.mdx#unsupported-document-extensions-features) - * [Unsupported Backup Features](../sharding/unsupported.mdx#unsupported-backup-features) - * [Unsupported Import & Export Features](../sharding/unsupported.mdx#unsupported-import--export-features) - * [Unsupported Migration Features](../sharding/unsupported.mdx#unsupported-migration-features) - * [Unsupported Data Subscription Features](../sharding/unsupported.mdx#unsupported-data-subscription-features) - * [Unsupported Integrations Features](../sharding/unsupported.mdx#unsupported-integrations-features) - * [Unsupported Patching Features](../sharding/unsupported.mdx#unsupported-patching-features) - * [Unsupported Replication Features](../sharding/unsupported.mdx#unsupported-replication-features) - * [Unsupported AI Features](../sharding/unsupported.mdx#unsupported-ai-features) + * [Unsupported Indexing Features](#unsupported-indexing-features) + * [Unsupported Querying Features](#unsupported-querying-features) + * [Unsupported Document Extensions Features](#unsupported-document-extensions-features) + * [Unsupported Backup Features](#unsupported-backup-features) + * [Unsupported Import & Export Features](#unsupported-import--export-features) + * [Unsupported Migration Features](#unsupported-migration-features) + * [Unsupported Data Subscription Features](#unsupported-data-subscription-features) + * [Unsupported Integrations Features](#unsupported-integrations-features) + * [Unsupported Patching Features](#unsupported-patching-features) + * [Unsupported Replication Features](#unsupported-replication-features) + * [Unsupported AI Features](#unsupported-ai-features) diff --git a/docs/start/containers/general-guide.mdx b/docs/start/containers/general-guide.mdx index cc437187fc..2f16dc99f6 100644 --- a/docs/start/containers/general-guide.mdx +++ b/docs/start/containers/general-guide.mdx @@ -22,10 +22,10 @@ This guide provides a comprehensive overview of running RavenDB in containers. I ## Contents -1. [Core Concepts & Difficulties](../../start/containers/general-guide.mdx#core-concepts) -2. [What We Offer](../../start/containers/general-guide.mdx#what-we-offer) -3. [What We Require](../../start/containers/general-guide.mdx#what-we-require) -4. [Benefits](../../start/containers/general-guide.mdx#benefits) +1. [Core Concepts & Difficulties](#core-concepts) +2. [What We Offer](#what-we-offer) +3. [What We Require](#what-we-require) +4. [Benefits](#benefits) ## 1. Core concepts #### Containers diff --git a/docs/start/content/_test-driver-csharp.mdx b/docs/start/content/_test-driver-csharp.mdx index 9b9df7d0d0..99fbcd8a5b 100644 --- a/docs/start/content/_test-driver-csharp.mdx +++ b/docs/start/content/_test-driver-csharp.mdx @@ -12,20 +12,20 @@ import CodeBlock from '@theme/CodeBlock'; [prerequisites](../../server/embedded.mdx#prerequisite) as embedded servers to run the tests. * In this page: - - [`RavenTestDriver`](../../start/test-driver.mdx#raventestdriver) + - [`RavenTestDriver`](#raventestdriver) - [Pre-initializing the store: `PreInitialize`](../../start/test-driver.mdx#pre-initializing-the-store:-preinitialize) - [Configure the server: `ConfigureServer`](../../start/test-driver.mdx#configure-the-server:-configureserver) - - [Unit test](../../start/test-driver.mdx#unit-test) - - [Complete example](../../start/test-driver.mdx#complete-example) + - [Unit test](#unit-test) + - [Complete example](#complete-example) - [Continuous Integration (CI) Servers](../../start/test-driver.mdx#continuous-integration-(ci)-servers) - - [Licensing](../../start/test-driver.mdx#licensing) + - [Licensing](#licensing) ## `RavenTestDriver` Start by creating a class that derives from `RavenTestDriver`. -Find below a list of test driver methods, followed by [samples](../../start/test-driver.mdx#complete-example). +Find below a list of test driver methods, followed by [samples](#complete-example). ### TestDriver Methods @@ -167,7 +167,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b * `ConfigureServer` can only be set once per test run. It needs to be set before `GetDocumentStore` is called. - See an [example](../../start/test-driver.mdx#complete-example) below. + See an [example](#complete-example) below. * If it is called twice, or within the `DocumentStore` scope, you will get the following error message: `System.InvalidOperationException : Cannot configure server after it was started. Please call 'ConfigureServer' method before any 'GetDocumentStore' is called.` @@ -175,7 +175,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of -how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). +how the embedded server is going to run with just a minor [definition change](#example-2). * To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#serveroptions). * It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. @@ -214,7 +214,7 @@ We use [xunit](https://www.nuget.org/packages/xunit/) for the test framework in Note that the test itself is meant to show different capabilities of the test driver and is not meant to be the most efficient. -The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](../../start/test-driver.mdx#complete-example) +The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](#complete-example) #### Example diff --git a/docs/start/content/_test-driver-java.mdx b/docs/start/content/_test-driver-java.mdx index 219f3b636b..482e18c114 100644 --- a/docs/start/content/_test-driver-java.mdx +++ b/docs/start/content/_test-driver-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; [prerequisites](../../server/embedded.mdx#prerequisites) as embedded servers to run the tests. * In this page: - - [RavenTestDriver](../../start/test-driver.mdx#raventestdriver) - - [Pre-initializing the store](../../start/test-driver.mdx#preinitialize) - - [ConfigureServer](../../start/test-driver.mdx#configureserver) - - [Unit test](../../start/test-driver.mdx#unittest) - - [Complete example](../../start/test-driver.mdx#complete-example) + - [RavenTestDriver](#raventestdriver) + - [Pre-initializing the store](#preinitialize) + - [ConfigureServer](#configureserver) + - [Unit test](#unittest) + - [Complete example](#complete-example) @@ -36,7 +36,7 @@ First, please make sure that the Raven TestDriver is added to your project depen Then, define a class that derives from the Raven TestDriver. We can start by reviewing TestDriver methods, and then get into implementation -(find a complete Raven TestDriver code sample [below](../../start/test-driver.mdx#complete-example)). +(find a complete Raven TestDriver code sample [below](#complete-example)). ### Methods | Signature | Description | @@ -83,7 +83,7 @@ protected void preInitialize(IDocumentStore documentStore) \{ We'll be using [JUnit](https://junit.org/) for my test framework in the below example. Note that the test itself is meant to show different capabilities of the test driver and is not meant to be the most efficient. -The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](../../start/test-driver.mdx#complete-example) +The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](#complete-example) ### Example diff --git a/docs/start/getting-started.mdx b/docs/start/getting-started.mdx index 7dbf350fd8..7493ce787e 100644 --- a/docs/start/getting-started.mdx +++ b/docs/start/getting-started.mdx @@ -20,17 +20,17 @@ Welcome to RavenDB! * This article will get you started with RavenDB, covering the essentials for a simple setup and basic usage. -* The [Server section](../start/getting-started.mdx#server) covers installation, setup, and configuration of the RavenDB server: - * [Prerequisites](../start/getting-started.mdx#prerequisites) - * [Installation & Setup](../start/getting-started.mdx#installation--setup) - * [Configuration](../start/getting-started.mdx#configuration) - * [Studio](../start/getting-started.mdx#studio) - * [Security Concerns](../start/getting-started.mdx#security-concerns) - -* The [Client section](../start/getting-started.mdx#client) shows how to connect your application to the RavenDB server +* The [Server section](#server) covers installation, setup, and configuration of the RavenDB server: + * [Prerequisites](#prerequisites) + * [Installation & Setup](#installation--setup) + * [Configuration](#configuration) + * [Studio](#studio) + * [Security Concerns](#security-concerns) + +* The [Client section](#client) shows how to connect your application to the RavenDB server and begin working with documents using a client library: - * [DocumentStore](../start/getting-started.mdx#documentstore) - * [Session](../start/getting-started.mdx#session) + * [DocumentStore](#documentstore) + * [Session](#session) @@ -220,7 +220,7 @@ Whenever you run the server folder script `run.ps1` the Studio opens automatical ### Security Concerns **We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start** to prevent potential future vulnerability. -[The process](../start/getting-started.mdx#installation--setup) in RavenDB only takes a few minutes and is free. +[The process](#installation--setup) in RavenDB only takes a few minutes and is free. To let a developer start coding an application quickly, RavenDB will run with the following default security mode: diff --git a/docs/start/guides/aws-lambda/overview.mdx b/docs/start/guides/aws-lambda/overview.mdx index f0e688a850..382757f844 100644 --- a/docs/start/guides/aws-lambda/overview.mdx +++ b/docs/start/guides/aws-lambda/overview.mdx @@ -22,19 +22,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this guide, you will learn how to deploy a .NET C# Lambda Handler Function using the [RavenDB AWS Lambda C# template][template] that is connected to your RavenDB database. -* Watch our tutorial video [below](../../../start/guides/aws-lambda/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=T2r9sqrTrYE). * In this page: - * [Before We Get Started](../../../start/guides/aws-lambda/overview.mdx#before-we-get-started) - * [Create a Local Lambda Function](../../../start/guides/aws-lambda/overview.mdx#create-a-local-lambda-function) - * [Configuring Local Connection to RavenDB](../../../start/guides/aws-lambda/overview.mdx#configuring-local-connection-to-ravendb) - * [Deploying to AWS](../../../start/guides/aws-lambda/overview.mdx#deploying-to-aws) - * [Configuring Production Connection to RavenDB](../../../start/guides/aws-lambda/overview.mdx#configuring-production-connection-to-ravendb) - * [Verify the Connection Works](../../../start/guides/aws-lambda/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Lambda Function](../../../start/guides/aws-lambda/overview.mdx#using-ravendb-in-the-lambda-function) - * [Next Steps](../../../start/guides/aws-lambda/overview.mdx#next-steps) - * [Tutorial Video](../../../start/guides/aws-lambda/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Lambda Function](#create-a-local-lambda-function) + * [Configuring Local Connection to RavenDB](#configuring-local-connection-to-ravendb) + * [Deploying to AWS](#deploying-to-aws) + * [Configuring Production Connection to RavenDB](#configuring-production-connection-to-ravendb) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Lambda Function](#using-ravendb-in-the-lambda-function) + * [Next Steps](#next-steps) + * [Tutorial Video](#tutorial-video) diff --git a/docs/start/guides/azure-functions/content/_existing-project-csharp.mdx b/docs/start/guides/azure-functions/content/_existing-project-csharp.mdx index 2260de98e4..3d4e13e915 100644 --- a/docs/start/guides/azure-functions/content/_existing-project-csharp.mdx +++ b/docs/start/guides/azure-functions/content/_existing-project-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; We assume you are familiar with .NET development techniques and the basics of Azure Function apps. * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../../start/guides/azure-functions/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../../start/guides/azure-functions/existing-project.mdx#initializing-the-document-store) - * [Adding Support for App Settings](../../../../start/guides/azure-functions/existing-project.mdx#adding-support-for-app-settings) - * [Configuring Support for Certificates](../../../../start/guides/azure-functions/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Azure](../../../../start/guides/azure-functions/existing-project.mdx#configuring-azure) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Adding Support for App Settings](#adding-support-for-app-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Azure](#configuring-azure) diff --git a/docs/start/guides/azure-functions/content/_existing-project-nodejs.mdx b/docs/start/guides/azure-functions/content/_existing-project-nodejs.mdx index 179a73d64c..de8072c188 100644 --- a/docs/start/guides/azure-functions/content/_existing-project-nodejs.mdx +++ b/docs/start/guides/azure-functions/content/_existing-project-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; We assume you are familiar with Node.js development techniques and the basics of Azure Function apps. * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../../start/guides/azure-functions/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../../start/guides/azure-functions/existing-project.mdx#initializing-the-document-store) - * [Adding Support for App Settings](../../../../start/guides/azure-functions/existing-project.mdx#adding-support-for-app-settings) - * [Configuring Support for Certificates](../../../../start/guides/azure-functions/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Azure](../../../../start/guides/azure-functions/existing-project.mdx#configuring-azure) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Adding Support for App Settings](#adding-support-for-app-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Azure](#configuring-azure) diff --git a/docs/start/guides/azure-functions/content/_overview-csharp.mdx b/docs/start/guides/azure-functions/content/_overview-csharp.mdx index 683be2d6d8..5b01b1f7eb 100644 --- a/docs/start/guides/azure-functions/content/_overview-csharp.mdx +++ b/docs/start/guides/azure-functions/content/_overview-csharp.mdx @@ -18,18 +18,18 @@ import CodeBlock from '@theme/CodeBlock'; basics of Azure Function apps. -* Watch our tutorial video [below](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=1vnpfsD3bSE&). * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/overview.mdx#before-we-get-started) - * [Create a Local Azure Function App](../../../../start/guides/azure-functions/overview.mdx#create-a-local-azure-function-app) - * [Configuring Local Connection to RavenDB](../../../../start/guides/azure-functions/overview.mdx#configuring-local-connection-to-ravendb) - * [Creating Function App Resources in Azure](../../../../start/guides/azure-functions/overview.mdx#creating-function-app-resources-in-azure) - * [Deploying to Azure](../../../../start/guides/azure-functions/overview.mdx#deploying-to-azure) - * [Verify the Connection Works](../../../../start/guides/azure-functions/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Azure Functions App](../../../../start/guides/azure-functions/overview.mdx#using-ravendb-in-the-azure-functions-app) - * [Tutorial Video](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Azure Function App](#create-a-local-azure-function-app) + * [Configuring Local Connection to RavenDB](#configuring-local-connection-to-ravendb) + * [Creating Function App Resources in Azure](#creating-function-app-resources-in-azure) + * [Deploying to Azure](#deploying-to-azure) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Azure Functions App](#using-ravendb-in-the-azure-functions-app) + * [Tutorial Video](#tutorial-video) diff --git a/docs/start/guides/azure-functions/content/_overview-nodejs.mdx b/docs/start/guides/azure-functions/content/_overview-nodejs.mdx index c1604d5040..63c2222eaa 100644 --- a/docs/start/guides/azure-functions/content/_overview-nodejs.mdx +++ b/docs/start/guides/azure-functions/content/_overview-nodejs.mdx @@ -18,18 +18,18 @@ import CodeBlock from '@theme/CodeBlock'; and the basics of Azure Function apps. -* Watch our tutorial video [below](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=TJdJ3TJK-Sg). * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/overview.mdx#before-we-get-started) - * [Create a Local Azure Function App](../../../../start/guides/azure-functions/overview.mdx#create-a-local-azure-function-app) - * [Connecting to RavenDB](../../../../start/guides/azure-functions/overview.mdx#connecting-to-ravendb) - * [Creating a Function App in Azure](../../../../start/guides/azure-functions/overview.mdx#creating-a-function-app-in-azure) - * [Deploying to Azure](../../../../start/guides/azure-functions/overview.mdx#deploying-to-azure) - * [Verify the Connection Works](../../../../start/guides/azure-functions/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Azure Functions App](../../../../start/guides/azure-functions/overview.mdx#using-ravendb-in-the-azure-functions-app) - * [Tutorial Video](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Azure Function App](#create-a-local-azure-function-app) + * [Connecting to RavenDB](#connecting-to-ravendb) + * [Creating a Function App in Azure](#creating-a-function-app-in-azure) + * [Deploying to Azure](#deploying-to-azure) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Azure Functions App](#using-ravendb-in-the-azure-functions-app) + * [Tutorial Video](#tutorial-video) diff --git a/docs/start/guides/azure-functions/deployment.mdx b/docs/start/guides/azure-functions/deployment.mdx index abea51c2f0..519b34dc6d 100644 --- a/docs/start/guides/azure-functions/deployment.mdx +++ b/docs/start/guides/azure-functions/deployment.mdx @@ -20,7 +20,7 @@ serverless workloads to Microsoft Azure Functions platform. * In this page: * [Linux or Windows?](../../../start/guides/azure-functions/deployment.mdx#linux-or-windows?) - * [Document Store Lifetime and Cold Starts](../../../start/guides/azure-functions/deployment.mdx#document-store-lifetime-and-cold-starts) + * [Document Store Lifetime and Cold Starts](#document-store-lifetime-and-cold-starts) diff --git a/docs/start/guides/cloudflare-workers/existing-project.mdx b/docs/start/guides/cloudflare-workers/existing-project.mdx index 3c1aa43667..46e91e983c 100644 --- a/docs/start/guides/cloudflare-workers/existing-project.mdx +++ b/docs/start/guides/cloudflare-workers/existing-project.mdx @@ -28,12 +28,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; We assume you are familiar with Node.js development techniques and the basics of Cloudflare Workers. * In this page: - * [Before We Get Started](../../../start/guides/cloudflare-workers/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../start/guides/cloudflare-workers/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../start/guides/cloudflare-workers/existing-project.mdx#initializing-the-document-store) - * [Updating Database Connection Settings](../../../start/guides/cloudflare-workers/existing-project.mdx#updating-database-connection-settings) - * [Configuring Support for Certificates](../../../start/guides/cloudflare-workers/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Cloudflare](../../../start/guides/cloudflare-workers/existing-project.mdx#configuring-cloudflare) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Updating Database Connection Settings](#updating-database-connection-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Cloudflare](#configuring-cloudflare) diff --git a/docs/start/guides/cloudflare-workers/overview.mdx b/docs/start/guides/cloudflare-workers/overview.mdx index e42ecff8c1..e9045442eb 100644 --- a/docs/start/guides/cloudflare-workers/overview.mdx +++ b/docs/start/guides/cloudflare-workers/overview.mdx @@ -26,17 +26,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; This guide assumes you are familiar with Node.js development techniques and the basics of Cloudflare Workers. -* Watch our tutorial video [below](../../../start/guides/cloudflare-workers/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=qMJfgQicjwk&t=1s). * In this page: - * [Before We Get Started](../../../start/guides/cloudflare-workers/overview.mdx#before-we-get-started) - * [Create a Cloudflare RavenDB Worker project](../../../start/guides/cloudflare-workers/overview.mdx#create-a-cloudflare-ravendb-worker-project) - * [Updating Database Connection Settings](../../../start/guides/cloudflare-workers/overview.mdx#updating-database-connection-settings) - * [Connecting to an Authenticated RavenDB Cluster](../../../start/guides/cloudflare-workers/overview.mdx#connecting-to-an-authenticated-ravendb-cluster) - * [Deploying to Production](../../../start/guides/cloudflare-workers/overview.mdx#deploying-to-production) - * [Using RavenDB in the Worker](../../../start/guides/cloudflare-workers/overview.mdx#using-ravendb-in-the-worker) - * [Tutorial Video](../../../start/guides/cloudflare-workers/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Cloudflare RavenDB Worker project](#create-a-cloudflare-ravendb-worker-project) + * [Updating Database Connection Settings](#updating-database-connection-settings) + * [Connecting to an Authenticated RavenDB Cluster](#connecting-to-an-authenticated-ravendb-cluster) + * [Deploying to Production](#deploying-to-production) + * [Using RavenDB in the Worker](#using-ravendb-in-the-worker) + * [Tutorial Video](#tutorial-video) diff --git a/docs/start/installation/deployment-considerations.mdx b/docs/start/installation/deployment-considerations.mdx index 05026eb54f..05294d62fc 100644 --- a/docs/start/installation/deployment-considerations.mdx +++ b/docs/start/installation/deployment-considerations.mdx @@ -16,12 +16,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Deployment Considerations](../../start/installation/deployment-considerations.mdx#deployment-considerations) - * [Performance Considerations](../../start/installation/deployment-considerations.mdx#performance-considerations) - * [Storage Considerations](../../start/installation/deployment-considerations.mdx#storage-considerations) - * [Network Considerations](../../start/installation/deployment-considerations.mdx#network-considerations) - * [Running RavenDB](../../start/installation/deployment-considerations.mdx#running-ravendb) - * [When the Database Grows Bigger](../../start/installation/deployment-considerations.mdx#when-the-database-grows-bigger) + * [Deployment Considerations](#deployment-considerations) + * [Performance Considerations](#performance-considerations) + * [Storage Considerations](#storage-considerations) + * [Network Considerations](#network-considerations) + * [Running RavenDB](#running-ravendb) + * [When the Database Grows Bigger](#when-the-database-grows-bigger) diff --git a/docs/start/installation/gnu-linux/deb.mdx b/docs/start/installation/gnu-linux/deb.mdx index 2557d75a90..5b71320961 100644 --- a/docs/start/installation/gnu-linux/deb.mdx +++ b/docs/start/installation/gnu-linux/deb.mdx @@ -25,18 +25,18 @@ import LanguageContent from "@site/src/components/LanguageContent"; a browser and complete the setup process using our setup wizard. * In this page: - * [Downloading and Installing RavenDB](../../../start/installation/gnu-linux/deb.mdx#downloading-and-installing-ravendb) - * [1. Download DEB Package](../../../start/installation/gnu-linux/deb.mdx#download-deb-package) - * [2. Install RavenDB](../../../start/installation/gnu-linux/deb.mdx#install-ravendb) - * [3. Complete the setup](../../../start/installation/gnu-linux/deb.mdx#complete-the-setup) - * [4. Entering RavenDB Studio When Setup is Complete](../../../start/installation/gnu-linux/deb.mdx#entering-ravendb-studio-when-setup-is-complete) - * [Upgrading RavenDB](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb) - * [Removing RavenDB](../../../start/installation/gnu-linux/deb.mdx#removing-ravendb) - * [Remove RavenDB and Leave its Data and Settings Intact](../../../start/installation/gnu-linux/deb.mdx#remove-ravendb-and-leave-its-data-and-settings-intact) - * [Remove RavenDB Completely](../../../start/installation/gnu-linux/deb.mdx#remove-ravendb-completely) - * [File System Locations](../../../start/installation/gnu-linux/deb.mdx#file-system-locations) - * [Default Settings](../../../start/installation/gnu-linux/deb.mdx#default-settings) - * [RavenDB Service Definitions](../../../start/installation/gnu-linux/deb.mdx#ravendb-service-definitions) + * [Downloading and Installing RavenDB](#downloading-and-installing-ravendb) + * [1. Download DEB Package](#download-deb-package) + * [2. Install RavenDB](#install-ravendb) + * [3. Complete the setup](#complete-the-setup) + * [4. Entering RavenDB Studio When Setup is Complete](#entering-ravendb-studio-when-setup-is-complete) + * [Upgrading RavenDB](#upgrading-ravendb) + * [Removing RavenDB](#removing-ravendb) + * [Remove RavenDB and Leave its Data and Settings Intact](#remove-ravendb-and-leave-its-data-and-settings-intact) + * [Remove RavenDB Completely](#remove-ravendb-completely) + * [File System Locations](#file-system-locations) + * [Default Settings](#default-settings) + * [RavenDB Service Definitions](#ravendb-service-definitions) ## Downloading and Installing RavenDB @@ -60,7 +60,7 @@ Find it here: [https://ravendb.net/download](https://ravendb.net/download) The same command, `sudo apt install `, is also used to - [Upgrade RavenDB](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb). + [Upgrade RavenDB](#upgrading-ravendb). * The RavenDB service will be created and activated automatically. @@ -166,7 +166,7 @@ To remove RavenDB and **leave its settings and data intact**, use: `sudo apt-get !["Leave Data and Settings Intact"](./assets/sudo_apt-get_remove_ravendb.png) -[Reinstalling](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb) +[Reinstalling](#upgrading-ravendb) RavenDB after removing it this way will **restore** its data and settings. ### Remove RavenDB Completely diff --git a/docs/start/installation/manual.mdx b/docs/start/installation/manual.mdx index 30f72e02ca..0d0363b9e6 100644 --- a/docs/start/installation/manual.mdx +++ b/docs/start/installation/manual.mdx @@ -25,11 +25,11 @@ If you choose manual setup and/or to provide your own certificate, **you are res In this page: -* [Downloading Server and Setting Up Node Folders](../../start/installation/manual.mdx#downloading-server-and-setting-up-node-folders) -* [Disabling 'Setup Wizard'](../../start/installation/manual.mdx#disabling-setup-wizard) -* [Server Url and Port](../../start/installation/manual.mdx#server-url-and-port) -* [Security](../../start/installation/manual.mdx#security) -* [Configuration](../../start/installation/manual.mdx#configuration) +* [Downloading Server and Setting Up Node Folders](#downloading-server-and-setting-up-node-folders) +* [Disabling 'Setup Wizard'](#disabling-setup-wizard) +* [Server Url and Port](#server-url-and-port) +* [Security](#security) +* [Configuration](#configuration) ## Downloading Server and Setting Up Node Folders Download the [RavenDB server package](https://ravendb.net/download) and extract it into permanent server folders on each machine. diff --git a/docs/start/installation/running-as-service.mdx b/docs/start/installation/running-as-service.mdx index 017912dbd5..f4367766b2 100644 --- a/docs/start/installation/running-as-service.mdx +++ b/docs/start/installation/running-as-service.mdx @@ -25,11 +25,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Windows](../../start/installation/running-as-service.mdx#windows) - * [Registering](../../start/installation/running-as-service.mdx#registering) - * [Unregistering](../../start/installation/running-as-service.mdx#unregistering) - * [Starting and Stopping](../../start/installation/running-as-service.mdx#starting-and-stopping) -* [Linux - Ubuntu](../../start/installation/running-as-service.mdx#linux---ubuntu) +* [Windows](#windows) + * [Registering](#registering) + * [Unregistering](#unregistering) + * [Starting and Stopping](#starting-and-stopping) +* [Linux - Ubuntu](#linux---ubuntu) diff --git a/docs/start/installation/setup-wizard/additional-settings.mdx b/docs/start/installation/setup-wizard/additional-settings.mdx index 27a6b194bb..5bfc2bb918 100644 --- a/docs/start/installation/setup-wizard/additional-settings.mdx +++ b/docs/start/installation/setup-wizard/additional-settings.mdx @@ -20,8 +20,8 @@ import Panel from '@site/src/components/Panel'; the next step is to **customize optional settings**. * In this article: - * [Additional settings](../../../start/installation/setup-wizard/additional-settings.mdx#additional-settings) - * [Configure advanced options](../../../start/installation/setup-wizard/additional-settings.mdx#configure-advanced-options) + * [Additional settings](#additional-settings) + * [Configure advanced options](#configure-advanced-options) @@ -62,7 +62,7 @@ import Panel from '@site/src/components/Panel'; 4. **Configure advanced options**: Toggle this option on to expand the section. - Learn more below in [Configure advanced options](../../../start/installation/setup-wizard/additional-settings.mdx#configure-advanced-options). + Learn more below in [Configure advanced options](#configure-advanced-options). 5. Click **"Continue"** to proceed to the next step: [Review setup](../../../start/installation/setup-wizard/review-setup.mdx). diff --git a/docs/start/installation/setup-wizard/choose-security-option.mdx b/docs/start/installation/setup-wizard/choose-security-option.mdx index ef51299471..2964efa13f 100644 --- a/docs/start/installation/setup-wizard/choose-security-option.mdx +++ b/docs/start/installation/setup-wizard/choose-security-option.mdx @@ -35,10 +35,10 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Choose a security method](../../../start/installation/setup-wizard/choose-security-option.mdx#choose-a-security-method) - * [Generate Let's Encrypt certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#generate-let-s-encrypt-certificate) - * [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate) - * [Don't use certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#don-t-use-certificate) + * [Choose a security method](#choose-a-security-method) + * [Generate Let's Encrypt certificate](#generate-let-s-encrypt-certificate) + * [Provide your own certificate](#provide-your-own-certificate) + * [Don't use certificate](#don-t-use-certificate) @@ -48,9 +48,9 @@ In this step, choose one of three security options: ![Select how to secure](./assets/security-1.png) -1. [Generate Let's Encrypt certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#generate-let-s-encrypt-certificate) -2. [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate) -3. [Don't use certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#don-t-use-certificate) +1. [Generate Let's Encrypt certificate](#generate-let-s-encrypt-certificate) +2. [Provide your own certificate](#provide-your-own-certificate) +3. [Don't use certificate](#don-t-use-certificate) 4. After selecting a security method, click **"Continue"** to proceed with its setup steps. 5. Click **"Back"** to return to the previous step - [Provide license key](../../../start/installation/setup-wizard/provide-license-key.mdx). @@ -62,7 +62,7 @@ Use this option to secure your server with a [Let's Encrypt certificate](../../. Let’s Encrypt is a free, automated certificate authority that provides trusted SSL/TLS certificates for HTTPS communication. To make this process as seamless as possible, **RavenDB provides a free domain name** for your cluster. -RavenDB will automatically issue and renew a trusted HTTPS certificate for the [domain you define in the next step](../../../start/installation/setup-wizard/choose-security-option.mdx#enter-a-domain-name), +RavenDB will automatically issue and renew a trusted HTTPS certificate for the [domain you define in the next step](#enter-a-domain-name), fully managing the certificate lifecycle so you don't need to provide or maintain your own. **When to use this option**: @@ -145,7 +145,7 @@ we recommend using your own certificates and domains, avoiding reliance on a thi * **Using your own domain** The free subdomain is provided only for the purpose of proving ownership to Let's Encrypt. If you prefer to use your own domain, you are welcome to acquire your own certificate and use it instead. - See [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate). + See [Provide your own certificate](#provide-your-own-certificate). diff --git a/docs/start/installation/setup-wizard/choose-setup-method.mdx b/docs/start/installation/setup-wizard/choose-setup-method.mdx index bc3163c755..556c048a9d 100644 --- a/docs/start/installation/setup-wizard/choose-setup-method.mdx +++ b/docs/start/installation/setup-wizard/choose-setup-method.mdx @@ -20,10 +20,10 @@ import Panel from '@site/src/components/Panel'; the next step is to choose the **setup method** you want to proceed with. * In this article: - * [Available setup methods](../../../start/installation/setup-wizard/choose-setup-method.mdx#available-setup-methods) - * [Set up a new cluster](../../../start/installation/setup-wizard/choose-setup-method.mdx#set-up-a-new-cluster) - * [Create a package for external setup](../../../start/installation/setup-wizard/choose-setup-method.mdx#create-a-package-for-external-setup) - * [Use an existing setup package](../../../start/installation/setup-wizard/choose-setup-method.mdx#use-an-existing-setup-package) + * [Available setup methods](#available-setup-methods) + * [Set up a new cluster](#set-up-a-new-cluster) + * [Create a package for external setup](#create-a-package-for-external-setup) + * [Use an existing setup package](#use-an-existing-setup-package) @@ -36,15 +36,15 @@ The following setup methods are available: 1. **Set up a new cluster** Configure a new cluster (single-node or multi-node) and start the **first RavenDB instance** on the machine where the Setup Wizard is running. - Learn more below in [Set up a new cluster](../../../start/installation/setup-wizard/choose-setup-method.mdx#set-up-a-new-cluster). + Learn more below in [Set up a new cluster](#set-up-a-new-cluster). 2. **Create a package for external setup** Prepare a configuration package without starting a server locally. - Learn more below in [Create a package for external setup](../../../start/installation/setup-wizard/choose-setup-method.mdx#create-a-package-for-external-setup). + Learn more below in [Create a package for external setup](#create-a-package-for-external-setup). 3. **Use an existing setup package** Apply a previously generated setup package to join a node to a cluster. - Learn more below in [Use an existing setup package](../../../start/installation/setup-wizard/choose-setup-method.mdx#use-an-existing-setup-package). + Learn more below in [Use an existing setup package](#use-an-existing-setup-package). 4. Click **"Continue"** to proceed to the next step in the wizard, which is [Providing the license key](../../../start/installation/setup-wizard/provide-license-key.mdx). diff --git a/docs/start/installation/setup-wizard/configure-node-addresses.mdx b/docs/start/installation/setup-wizard/configure-node-addresses.mdx index 41535f1d09..122da6cb64 100644 --- a/docs/start/installation/setup-wizard/configure-node-addresses.mdx +++ b/docs/start/installation/setup-wizard/configure-node-addresses.mdx @@ -31,13 +31,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Set up node addresses for a SECURE cluster](../../../start/installation/setup-wizard/configure-node-addresses.mdx#set-up-node-addresses-for-a-secure-cluster) + * [Set up node addresses for a SECURE cluster](#set-up-node-addresses-for-a-secure-cluster) * [Behind a firewall or load balancer](../../../start/installation/setup-wizard/configure-node-addresses#behind-a-firewall-or-load-balancer) * [In a Docker container](../../../start/installation/setup-wizard/configure-node-addresses#in-a-docker-container) - * [Set up node addresses for an UNSECURED cluster](../../../start/installation/setup-wizard/configure-node-addresses.mdx#set-up-node-addresses-for-an-unsecured-cluster) - * [Cluster topology](../../../start/installation/setup-wizard/configure-node-addresses.mdx#cluster-topology) - * [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes) - * [Node layout](../../..//start/installation/setup-wizard/configure-node-addresses.mdx#node-layout) + * [Set up node addresses for an UNSECURED cluster](#set-up-node-addresses-for-an-unsecured-cluster) + * [Cluster topology](#cluster-topology) + * [Number of nodes](#number-of-nodes) + * [Node layout](#node-layout) @@ -104,7 +104,7 @@ import Panel from '@site/src/components/Panel'; Nodes can use the same HTTPS/TCP ports as long as they listen on different IP addresses or hostnames. You can add nodes up to the limit allowed by your license. For production, it is recommended to start with at least 3 nodes. - Learn more in [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes). + Learn more in [Number of nodes](#number-of-nodes). 11. **Save**: When you finish configuring this node, click this button to save its settings. @@ -204,7 +204,7 @@ The following example shows a configuration of a 3-node cluster: Nodes can use the same HTTP/TCP ports as long as they listen on different IP addresses or hostnames. You can add nodes up to the limit allowed by your license. For production, it is recommended to start with at least 3 nodes. - Learn more in [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes). + Learn more in [Number of nodes](#number-of-nodes). 8. Click **"Continue"** to proceed to the next step - [Additional settings](../../../start/installation/setup-wizard/additional-settings.mdx). The "Continue" button is enabled after you click "Save". 9. Click **"Back"** to return to the previous step - [Choosing a security option](../../../start/installation/setup-wizard/choose-security-option.mdx). diff --git a/docs/start/installation/setup-wizard/finish-setup.mdx b/docs/start/installation/setup-wizard/finish-setup.mdx index 14636d2736..436775edc0 100644 --- a/docs/start/installation/setup-wizard/finish-setup.mdx +++ b/docs/start/installation/setup-wizard/finish-setup.mdx @@ -20,11 +20,11 @@ import Panel from '@site/src/components/Panel'; the wizard applies your configuration and either prepares the server for its first run or generates a setup package, depending on the flow you chose in earlier steps. * In this article: - * [Configuration in process](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-in-process) - * [Configuration is done](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-is-done) - * [The downloaded ZIP file](../../../start/installation/setup-wizard/finish-setup.mdx#the-downloaded-zip-file) - * [The "All Set!" screen](../../../start/installation/setup-wizard/finish-setup.mdx#the-all-set-screen) - * [Restarting the server](../../../start/installation/setup-wizard/finish-setup.mdx#restarting-the-server) + * [Configuration in process](#configuration-in-process) + * [Configuration is done](#configuration-is-done) + * [The downloaded ZIP file](#the-downloaded-zip-file) + * [The "All Set!" screen](#the-all-set-screen) + * [Restarting the server](#restarting-the-server) @@ -91,7 +91,7 @@ and [Chosen security method](../../../start/installation/setup-wizard/choose-sec **What happens next?** If all operations complete successfully, the wizard will automatically update the screen. -See the [Configuration is done](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-is-done) section below. +See the [Configuration is done](#configuration-is-done) section below. If an error occurs, the process will halt. The detailed configuration log will help you identify what went wrong. @@ -178,7 +178,7 @@ For example, when configuring a **multi-node secure cluster**, you will see the 3. **Restart server**: This button is now enabled. Click to apply the settings and restart the server on Node A. Once restarted, your browser will automatically open RavenDB Studio for this node. - Learn more in [Restarting the server](../../../start/installation/setup-wizard/finish-setup.mdx#restarting-the-server) below. + Learn more in [Restarting the server](#restarting-the-server) below. diff --git a/docs/start/installation/setup-wizard/overview.mdx b/docs/start/installation/setup-wizard/overview.mdx index da7a7af702..f9af743ef2 100644 --- a/docs/start/installation/setup-wizard/overview.mdx +++ b/docs/start/installation/setup-wizard/overview.mdx @@ -22,10 +22,10 @@ import Panel from '@site/src/components/Panel'; * If you prefer to configure RavenDB manually, see: [Manual setup](../../../start/installation/manual.mdx). * In this article: - * [How to run the Setup Wizard](../../../start/installation/setup-wizard/overview.mdx#how-to-run-the-setup-wizard) - * [License agreement (EULA)](../../../start/installation/setup-wizard/overview.mdx#license-agreement-eula) - * [Guided setup flow](../../../start/installation/setup-wizard/overview.mdx#guided-setup-flow) - * [RavenDB settings files](../../../start/installation/setup-wizard/overview.mdx#ravendb-settings-files) + * [How to run the Setup Wizard](#how-to-run-the-setup-wizard) + * [License agreement (EULA)](#license-agreement-eula) + * [Guided setup flow](#guided-setup-flow) + * [RavenDB settings files](#ravendb-settings-files) diff --git a/docs/start/installation/setup-wizard/provide-license-key.mdx b/docs/start/installation/setup-wizard/provide-license-key.mdx index a66d10edbb..b4694601fd 100644 --- a/docs/start/installation/setup-wizard/provide-license-key.mdx +++ b/docs/start/installation/setup-wizard/provide-license-key.mdx @@ -28,8 +28,8 @@ import Panel from '@site/src/components/Panel'; Learn more about licensing in [Licensing overview](../../../licensing/overview.mdx). * In this article: - * [Enter license key](../../../start/installation/setup-wizard/provide-license-key.mdx#enter-license-key) - * [Get a free license](../../../start/installation/setup-wizard/provide-license-key.mdx#get-a-free-license) + * [Enter license key](#enter-license-key) + * [Get a free license](#get-a-free-license) * [Running RavenDB without a license](../../../start/installation/setup-wizard/provide-license-key#running-ravendb-without-a-license) @@ -41,7 +41,7 @@ import Panel from '@site/src/components/Panel'; 1. Enter your license key, which was sent to the email address you provided when obtaining it. 2. If you do not have a license, select this option to obtain a free Developer or Community license. - Learn more below in [Get your free license](../../../start/installation/setup-wizard/provide-license-key.mdx#get-your-free-license). + Learn more below in [Get your free license](#get-your-free-license). 3. Click **"Continue"** to proceed to the next step in the wizard - [Choosing a security option](../../../start/installation/setup-wizard/choose-security-option.mdx). diff --git a/docs/start/installation/setup-wizard/review-setup.mdx b/docs/start/installation/setup-wizard/review-setup.mdx index ec06740cfb..f4dace0485 100644 --- a/docs/start/installation/setup-wizard/review-setup.mdx +++ b/docs/start/installation/setup-wizard/review-setup.mdx @@ -20,7 +20,7 @@ import Panel from '@site/src/components/Panel'; the next step is to **review all your settings before proceeding**. * In this article: - * [Review setup](../../../start/installation/setup-wizard/review-setup.mdx#review-setup) + * [Review setup](#review-setup) diff --git a/docs/start/installation/setup-wizard/use-setup-package.mdx b/docs/start/installation/setup-wizard/use-setup-package.mdx index 7894155cd0..f49e69c048 100644 --- a/docs/start/installation/setup-wizard/use-setup-package.mdx +++ b/docs/start/installation/setup-wizard/use-setup-package.mdx @@ -20,8 +20,8 @@ import Panel from '@site/src/components/Panel'; It allows you to initialize a RavenDB instance using a configuration ZIP file generated in a previous session. * In this article: - * [When to use](../../../start/installation/setup-wizard/use-setup-package.mdx#when-to-use) - * [Using an existing setup package](../../../start/installation/setup-wizard/use-setup-package.mdx#using-an-existing-setup-package) + * [When to use](#when-to-use) + * [Using an existing setup package](#using-an-existing-setup-package) diff --git a/docs/studio/ai-assistant.mdx b/docs/studio/ai-assistant.mdx index f8c80f37ee..fac17ac3fb 100644 --- a/docs/studio/ai-assistant.mdx +++ b/docs/studio/ai-assistant.mdx @@ -22,21 +22,21 @@ import ContentFrame from "@site/src/components/ContentFrame"; RavenDB `7.2` and above address this challenge via the **AI assistant**, an interactive context-aware guide, intended to minimize the time and effort spent on learning Studio and RavenDB. -You can approach the assistant from any Studio view for navigation instructions, explanations regarding your current location, and information about the database or other topics you may bring up. For example, you can ask for its assistance in views that require [specialized knowledge](../studio/ai-assistant.mdx#what-is-the-ai-assistant-for) such as RQL queries or ETL scripts. +You can approach the assistant from any Studio view for navigation instructions, explanations regarding your current location, and information about the database or other topics you may bring up. For example, you can ask for its assistance in views that require [specialized knowledge](#what-is-the-ai-assistant-for) such as RQL queries or ETL scripts. -Additionally, you can grant the assistant [read access](../studio/ai-assistant.mdx#add-context) to database resources such as documents or collections, to allow it to base its answers on your content. +Additionally, you can grant the assistant [read access](#add-context) to database resources such as documents or collections, to allow it to base its answers on your content. * In this article: - * [Overview](../studio/ai-assistant.mdx#overview) - * [What is the AI assistant for](../studio/ai-assistant.mdx#what-is-the-ai-assistant-for) - * [User consent](../studio/ai-assistant.mdx#user-consent) - * [Licenses and Usage tokens](../studio/ai-assistant.mdx#licenses-and-usage-tokens) - * [Services used](../studio/ai-assistant.mdx#services-used) - * [RavenDB backend service](../studio/ai-assistant.mdx#ravendb-backend-service) - * [LLM service provider](../studio/ai-assistant.mdx#llm-service-provider) - * [Using the AI assistant](../studio/ai-assistant.mdx#using-the-ai-assistant) - * [Configuration](../studio/ai-assistant.mdx#configuration) - * [Security concerns](../studio/ai-assistant.mdx#security-concerns) + * [Overview](#overview) + * [What is the AI assistant for](#what-is-the-ai-assistant-for) + * [User consent](#user-consent) + * [Licenses and Usage tokens](#licenses-and-usage-tokens) + * [Services used](#services-used) + * [RavenDB backend service](#ravendb-backend-service) + * [LLM service provider](#llm-service-provider) + * [Using the AI assistant](#using-the-ai-assistant) + * [Configuration](#configuration) + * [Security concerns](#security-concerns) @@ -73,7 +73,7 @@ The AI assistant is **disabled by default**. To enable it, you must provide expl * **Note** that consenting cannot be undone from the UI. To cancel your consent after approving it, [contact us](https://ravendb.net/contact). - * Also note that you **will** be able to disable or enable the AI assistant even after providing your consent, using [configuration keys](../studio/ai-assistant.mdx#configuration). + * Also note that you **will** be able to disable or enable the AI assistant even after providing your consent, using [configuration keys](#configuration). --- @@ -94,7 +94,7 @@ You can always see the consent statement and your current consent status in Stud * **Usage tokens** A monthly quota of usage tokens is allocated per customer. The tokens are consumed by AI assistant usage. - * When the tokens run out, assistant prompts are no longer processed by either the [backend service](../studio/ai-assistant.mdx#ravendb-backend-service) or the [LLM](../studio/ai-assistant.mdx#llm-service-provider). + * When the tokens run out, assistant prompts are no longer processed by either the [backend service](#ravendb-backend-service) or the [LLM](#llm-service-provider). * The usage token quota is automatically renewed each month. * You can always see the renewal date and your current token usage in Studio's **About** view: @@ -153,7 +153,7 @@ Make sure your RavenDB server can connect to the RavenDB backend service at `htt ![Chat settings](./assets/ai-assistant_chat-settings.png) These settings are applied per user and kept in the local browser storage. - For server-wide settings, use the [configuration keys](../studio/ai-assistant.mdx#configuration). + For server-wide settings, use the [configuration keys](#configuration). * **A.** **Always allow endpoints calls** Endpoints provide access to database resources. The assistant can call only `GET` endpoints. @@ -203,7 +203,7 @@ Use the following keys to configure the AI assistant server-wide. ### Ai.Assistant.Disable -Use this key to completely disable the AI assistant for all users regardless of individual [user consent](../studio/ai-assistant.mdx#user-consent) and to block the `AI assistant` option in Studio's Knowledge Center panel. +Use this key to completely disable the AI assistant for all users regardless of individual [user consent](#user-consent) and to block the `AI assistant` option in Studio's Knowledge Center panel. - **Type**: `bool` - **Default**: `false` @@ -215,7 +215,7 @@ Use this key to completely disable the AI assistant for all users regardless of ### Ai.Assistant.DisableDataSubmission -Use this key to prevent the transmission of any user data [exposed to the AI assistant](../studio/ai-assistant.mdx#add-context) to the RavenDB backend or LLM. The assistant can still provide general guidance but cannot analyze any user data. +Use this key to prevent the transmission of any user data [exposed to the AI assistant](#add-context) to the RavenDB backend or LLM. The assistant can still provide general guidance but cannot analyze any user data. - **Type**: `bool` - **Default**: `false` @@ -238,9 +238,9 @@ As user data is sent by the AI assistant to the RavenDB backend and the LLM that The user decides which database content, if any, is provided to the AI assistant and sent by it to the backend and LLM. The extent of the assistant's access to the database, its ability to send any data to the backend, and its ability to operate at all, are fully controlled by the user. * **Opt-in mechanism**: The AI assistant is disabled by default. To enable it, the user must explicitly consent to the [EULA](https://ravendb.net/legal/ravendb/ai-assistant-terms-of-use) (End-User License Agreement). - After consenting, the user can still disable data submission both from the chat settings (that apply to this user on this browser and are kept in the local browser storage) and using [configuration keys](../studio/ai-assistant.mdx#configuration) (applied server-wide). + After consenting, the user can still disable data submission both from the chat settings (that apply to this user on this browser and are kept in the local browser storage) and using [configuration keys](#configuration) (applied server-wide). * **Certificate authorization**: - Regardless of local and global assistant settings and [resource contexts](../studio/ai-assistant.mdx#add-context) added by the user, the assistant can only access resources authorized by its user's [client certificate](../server/security/authorization/security-clearance-and-permissions.mdx). + Regardless of local and global assistant settings and [resource contexts](#add-context) added by the user, the assistant can only access resources authorized by its user's [client certificate](../server/security/authorization/security-clearance-and-permissions.mdx). * **Awareness by legal transparency**: The EULA clearly discloses that the data analysis performed by the AI assistant requires it to send query results to third-party processing: the RavenDB backend service and the LLM it uses. diff --git a/docs/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx b/docs/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx index fe4f599baf..30a1a3b4ee 100644 --- a/docs/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx +++ b/docs/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx @@ -23,10 +23,10 @@ Customize the cluster dashboard according to your needs by: * **Repositioning** widgets * In this page: - * [Remove Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#remove-widget) - * [Add Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#add-widget) - * [Resize Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#resize-widget) - * [Reposition Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#reposition-widget) + * [Remove Widget](#remove-widget) + * [Add Widget](#add-widget) + * [Resize Widget](#resize-widget) + * [Reposition Widget](#reposition-widget) ## Remove Widget @@ -39,7 +39,7 @@ To remove a widget from the cluster dashboard - Removing a widget is **reversible**. - To return a widget that's been removed, [Add it](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#add-widget) + To return a widget that's been removed, [Add it](#add-widget) to the cluster dashboard. diff --git a/docs/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx b/docs/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx index 2668b2d9d7..6b1fe60444 100644 --- a/docs/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx +++ b/docs/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The cluster dashboard can be freely rearranged by adding, removing, relocating, and resizing widgets. * In this page: - * [Initial Display](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#cluster-dashboard-initial-display) - * [Widgets Display](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#cluster-dashboard-widgets-display) - * [Setup changes](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#setup-changes) + * [Initial Display](#cluster-dashboard-initial-display) + * [Widgets Display](#cluster-dashboard-widgets-display) + * [Setup changes](#setup-changes) ## Cluster Dashboard Initial Display diff --git a/docs/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx b/docs/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx index 0d44d5fb4f..f283604012 100644 --- a/docs/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx +++ b/docs/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx @@ -19,16 +19,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Information is displayed for all cluster nodes. * Available Widgets: - * [Let's Get Started Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#let) - * [CPU Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#cpu-widget) - * [Memory Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#memory-widget) - * [Traffic Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#traffic-widget) - * [Traffic Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#traffic-per-database-widget) - * [Indexing Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#indexing-widget) - * [Indexing Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#indexing-per-database-widget) - * [Storage Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#storage-widget) - * [Storage Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#storage-per-database-widget) - * [License Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#license-widget) + * [Let's Get Started Widget](#let) + * [CPU Widget](#cpu-widget) + * [Memory Widget](#memory-widget) + * [Traffic Widget](#traffic-widget) + * [Traffic Per Database Widget](#traffic-per-database-widget) + * [Indexing Widget](#indexing-widget) + * [Indexing Per Database Widget](#indexing-per-database-widget) + * [Storage Widget](#storage-widget) + * [Storage Per Database Widget](#storage-per-database-widget) + * [License Widget](#license-widget) ## Let's Get Started Widget diff --git a/docs/studio/cluster/cluster-view.mdx b/docs/studio/cluster/cluster-view.mdx index f37ed993a8..584e1df3d1 100644 --- a/docs/studio/cluster/cluster-view.mdx +++ b/docs/studio/cluster/cluster-view.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; working to achieve the same goal. * Using the Raft consensus protocol, the cluster distributes work among the various nodes, handles failures, recovery, and more. - The cluster Member nodes elect a [Leader](../../studio/cluster/cluster-view.mdx#cluster-nodes-types) - a node that manages the cluster state. + The cluster Member nodes elect a [Leader](#cluster-nodes-types) - a node that manages the cluster state. * This view shows your cluster's current state and structure. @@ -30,12 +30,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * And much more * In this page: - * [Cluster View Stats](../../studio/cluster/cluster-view.mdx#cluster-view-stats) - * [Cluster View Operations](../../studio/cluster/cluster-view.mdx#cluster-view-operations) - * [Reassign Cores](../../studio/cluster/cluster-view.mdx#reassign-cores) - * [Cluster Nodes Types](../../studio/cluster/cluster-view.mdx#cluster-nodes-types) - * [Cluster Nodes States & Types Flow](../../studio/cluster/cluster-view.mdx#cluster-nodes-states--types-flow) - * [Cluster-Wide operation -vs- Database Operations](../../studio/cluster/cluster-view.mdx#cluster-wide-operation--vs--database-operations) + * [Cluster View Stats](#cluster-view-stats) + * [Cluster View Operations](#cluster-view-operations) + * [Reassign Cores](#reassign-cores) + * [Cluster Nodes Types](#cluster-nodes-types) + * [Cluster Nodes States & Types Flow](#cluster-nodes-states--types-flow) + * [Cluster-Wide operation -vs- Database Operations](#cluster-wide-operation--vs--database-operations) ## Cluster View Stats diff --git a/docs/studio/cluster/setting-a-cluster.mdx b/docs/studio/cluster/setting-a-cluster.mdx index 9d61b33e54..4ee21e5243 100644 --- a/docs/studio/cluster/setting-a-cluster.mdx +++ b/docs/studio/cluster/setting-a-cluster.mdx @@ -28,9 +28,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Creating a database on this server * In this page: - * [Bootstrap Cluster](../../studio/cluster/setting-a-cluster.mdx#bootstrap-cluster) - * [Add Another Node to the Cluster](../../studio/cluster/setting-a-cluster.mdx#add-another-node-to-the-cluster) - * [A Cluster with 2 nodes](../../studio/cluster/setting-a-cluster.mdx#a-cluster-with-2-nodes) + * [Bootstrap Cluster](#bootstrap-cluster) + * [Add Another Node to the Cluster](#add-another-node-to-the-cluster) + * [A Cluster with 2 nodes](#a-cluster-with-2-nodes) ## Bootstrap Cluster diff --git a/docs/studio/configuration.mdx b/docs/studio/configuration.mdx index 94099af37f..5896c06674 100644 --- a/docs/studio/configuration.mdx +++ b/docs/studio/configuration.mdx @@ -21,10 +21,10 @@ Use the configuration keys listed below to set Studio-related options for your R Learn how to apply these keys in the [Configuration Overview](../server/configuration/configuration-options.mdx) article. * On this page: - * [Configuration keys](../studio/configuration.mdx#configuration-keys) - * [Studio.Path](../studio/configuration.mdx#studiopath) - * [Ai.Assistant.Disable](../studio/configuration.mdx#aiassistantdisable) - * [Ai.Assistant.DisableDataSubmission](../studio/configuration.mdx#aiassistantdisabledatasubmission) + * [Configuration keys](#configuration-keys) + * [Studio.Path](#studiopath) + * [Ai.Assistant.Disable](#aiassistantdisable) + * [Ai.Assistant.DisableDataSubmission](#aiassistantdisabledatasubmission) diff --git a/docs/studio/database/create-new-database/from-legacy-files.mdx b/docs/studio/database/create-new-database/from-legacy-files.mdx index e2605364d4..dccf5e34c4 100644 --- a/docs/studio/database/create-new-database/from-legacy-files.mdx +++ b/docs/studio/database/create-new-database/from-legacy-files.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; This database creation option is designed for importing database from data files from RavenDB v3.x. * In this page: - * [1. Creating New Database From Legacy Files](../../../studio/database/create-new-database/from-legacy-files.mdx#1-creating-new-database-from-legacy-files) - * [2. Data Source Configuration](../../../studio/database/create-new-database/from-legacy-files.mdx#2-data-source-configuration) + * [1. Creating New Database From Legacy Files](#1-creating-new-database-from-legacy-files) + * [2. Data Source Configuration](#2-data-source-configuration) ## 1. Creating New Database From Legacy Files diff --git a/docs/studio/database/create-new-database/general-flow.mdx b/docs/studio/database/create-new-database/general-flow.mdx index e6c192c106..5ae23e4cba 100644 --- a/docs/studio/database/create-new-database/general-flow.mdx +++ b/docs/studio/database/create-new-database/general-flow.mdx @@ -16,7 +16,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * From Studio, the database creation options are: - * **Regular** database - see [below](../../../studio/database/create-new-database/general-flow.mdx#1-new-database). + * **Regular** database - see [below](#1-new-database). * **Encrypted** database - see [Encrypted Database](../../../studio/database/create-new-database/encrypted.mdx). * Create a database from a **Backup** - see [Restore from backup](../../../backup/restore#restoring-from-backup-using-studio). * Create a database from a **Previous** RavenDB version database - see [From Legacy File](../../../studio/database/create-new-database/from-legacy-files.mdx). @@ -25,11 +25,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To create a new database using the Client API, see [Create database operation](../../../client-api/operations/server-wide/create-database.mdx). * In this article: - * [1. New Database](../../../studio/database/create-new-database/general-flow.mdx#1-new-database) - * [2. Database Name](../../../studio/database/create-new-database/general-flow.mdx#2-database-name) - * [3. Configure Replication](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) - * [4. Configure Path](../../../studio/database/create-new-database/general-flow.mdx#4-configure-path) - * [5. Create](../../../studio/database/create-new-database/general-flow.mdx#5-create) + * [1. New Database](#1-new-database) + * [2. Database Name](#2-database-name) + * [3. Configure Replication](#3-configure-replication) + * [4. Configure Path](#4-configure-path) + * [5. Create](#5-create) ## 1. New Database diff --git a/docs/studio/database/databases-list-view.mdx b/docs/studio/database/databases-list-view.mdx index feabfee44d..ac260cb29d 100644 --- a/docs/studio/database/databases-list-view.mdx +++ b/docs/studio/database/databases-list-view.mdx @@ -20,11 +20,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions can be performed on each database * In this page: - * [Database Stats](../../studio/database/databases-list-view.mdx#database-stats) - * [Database Actions](../../studio/database/databases-list-view.mdx#database-actions) - * [Creating New Database Options](../../studio/database/databases-list-view.mdx#creating-new-database-options) - * [More Actions](../../studio/database/databases-list-view.mdx#more-actions) - * [Remote Database](../../studio/database/databases-list-view.mdx#remote-database) + * [Database Stats](#database-stats) + * [Database Actions](#database-actions) + * [Creating New Database Options](#creating-new-database-options) + * [More Actions](#more-actions) + * [Remote Database](#remote-database) ## Database Stats @@ -38,7 +38,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * ***Disabled*** - the database has been disabled. * Note: - If the database is contained in a cluster's node that is different than the node that is currently viewed in this Studio instance, then 'Remote' will be indicated - see more [below](../../studio/database/databases-list-view.mdx#remote-database). + If the database is contained in a cluster's node that is different than the node that is currently viewed in this Studio instance, then 'Remote' will be indicated - see more [below](#remote-database). 2. **Containing nodes** These are the nodes that contain a copy of the database. @@ -71,7 +71,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Figure 2. Database Actions](./assets/database-actions-1.png) 1. **Create new database** - A new database can be created from scratch, from a backup copy, or from existing 3.x data - see more [below](../../studio/database/databases-list-view.mdx#creating-new-database-options). + A new database can be created from scratch, from a backup copy, or from existing 3.x data - see more [below](#creating-new-database-options). 2. **Manage group** Click to manage the nodes that contain this database - see more about [The Database Group](../../studio/database/settings/manage-database-group.mdx). @@ -80,7 +80,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; A disabled database cannot be accessed. 4. **More actions** - Pause indexing, Disable indexing, Compact database - see more [below](../../studio/database/databases-list-view.mdx#more-actions). + Pause indexing, Disable indexing, Compact database - see more [below](#more-actions). 5. **Refresh data** Refresh the database stats data in this view from the server. diff --git a/docs/studio/database/document-extensions/counters.mdx b/docs/studio/database/document-extensions/counters.mdx index 5928115057..766b8b5444 100644 --- a/docs/studio/database/document-extensions/counters.mdx +++ b/docs/studio/database/document-extensions/counters.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Create and manage Counters using [API methods](../../../document-extensions/counters/overview.mdx) or via Studio. * In this page: - * [Viewing Counters Data](../../../studio/database/document-extensions/counters.mdx#viewing-counters-data) - * [Managing Counters](../../../studio/database/document-extensions/counters.mdx#managing-counters) - * [Counters Export and Import](../../../studio/database/document-extensions/counters.mdx#counters-export-and-import) + * [Viewing Counters Data](#viewing-counters-data) + * [Managing Counters](#managing-counters) + * [Counters Export and Import](#counters-export-and-import) ## Viewing Counters Data diff --git a/docs/studio/database/document-extensions/revisions/all-revisions.mdx b/docs/studio/database/document-extensions/revisions/all-revisions.mdx index bba928016d..5a1a615f94 100644 --- a/docs/studio/database/document-extensions/revisions/all-revisions.mdx +++ b/docs/studio/database/document-extensions/revisions/all-revisions.mdx @@ -27,7 +27,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Deleting revisions**: * From this view, you can manually delete selected revisions ("Regular Revisions" only). - Other available deletion methods are summarized in [All ways to delete revisions](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#all-ways-to-delete-revisions). + Other available deletion methods are summarized in [All ways to delete revisions](#all-ways-to-delete-revisions). * Removing revisions from a secure server requires a client certificate with an [Admin](../../../../server/security/authorization/security-clearance-and-permissions.mdx#section) or higher security clearance. @@ -37,9 +37,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Once a revision is removed, it will no longer be available and will Not be listed in this view. * In this page: - * [Opening the All Revisions view](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#opening-the-all-revisions-view) - * [Using the All Revisions view](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#using-the-all-revisions-view) - * [All ways to delete revisions](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#all-ways-to-delete-revisions) + * [Opening the All Revisions view](#opening-the-all-revisions-view) + * [Using the All Revisions view](#using-the-all-revisions-view) + * [All ways to delete revisions](#all-ways-to-delete-revisions) ## Opening the All Revisions view @@ -111,7 +111,7 @@ To access the All Revisions view, go to **Documents > All Revisions** **Deleting "Regular Revisions"**: * "Regular Revisions" can be manually deleted from the All Revisions view. - See [using the All Revisions view](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#using-the-all-revisions-view). + See [using the All Revisions view](#using-the-all-revisions-view). * These revisions can also be deleted through the [Delete revisions operation](../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx) in the Client API. diff --git a/docs/studio/database/document-extensions/revisions/revisions-bin.mdx b/docs/studio/database/document-extensions/revisions/revisions-bin.mdx index d616854eab..5292c87f7b 100644 --- a/docs/studio/database/document-extensions/revisions/revisions-bin.mdx +++ b/docs/studio/database/document-extensions/revisions/revisions-bin.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; From this view, you can access these revisions or permanently delete them if needed. * In this page: - * [Overview](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#overview) - * [The Revisions Bin view](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#the-revisions-bin-view) - * [Restoring revisions](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#restoring-revisions) + * [Overview](#overview) + * [The Revisions Bin view](#the-revisions-bin-view) + * [Restoring revisions](#restoring-revisions) ## Overview @@ -59,7 +59,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Restoring revisions**: * Revisions of a deleted document can be restored from the Revisions Bin and associated with a new document. - Learn more [below](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#restoring-revisions). + Learn more [below](#restoring-revisions). diff --git a/docs/studio/database/document-extensions/revisions/revisions-overview.mdx b/docs/studio/database/document-extensions/revisions/revisions-overview.mdx index 4b6104d8f7..6b7753630e 100644 --- a/docs/studio/database/document-extensions/revisions/revisions-overview.mdx +++ b/docs/studio/database/document-extensions/revisions/revisions-overview.mdx @@ -26,9 +26,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To see all revisions in the database, go to the [All Revisions](../../../../studio/database/document-extensions/revisions/all-revisions.mdx) view. * To access revisions of deleted documents, go to the [Revisions Bin](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx) view. * In this page: - * [Revisions tab](../../../../studio/database/document-extensions/revisions/revisions-overview.mdx#revisions-tab) - * [Revision inspection](../../../../studio/database/document-extensions/revisions/revisions-overview.mdx#revision-inspection) - * [Revisions comparison](../../../../studio/database/document-extensions/revisions/revisions-overview.mdx#revisions-comparison) + * [Revisions tab](#revisions-tab) + * [Revision inspection](#revision-inspection) + * [Revisions comparison](#revisions-comparison) ## Revisions tab diff --git a/docs/studio/database/document-extensions/time-series.mdx b/docs/studio/database/document-extensions/time-series.mdx index 9a9b93bd66..e84591b0ca 100644 --- a/docs/studio/database/document-extensions/time-series.mdx +++ b/docs/studio/database/document-extensions/time-series.mdx @@ -22,19 +22,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * An **Incremental Time Series** is a special type of time series that allows you to handle time series values as counters. Read more about incremental time series [here](../../../document-extensions/timeseries/incremental-time-series/overview.mdx), - and learn how to define them through Studio [below](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series). + and learn how to define them through Studio [below](#incremental-time-series). * In this page: - * [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) - * [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) - * [Create new Time Series (by Creating the First Entry)](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-its-first-entry) - * [Editing an Entry](../../../studio/database/document-extensions/time-series.mdx#editing-an-entry) - * [Deleting a Range of Entries](../../../studio/database/document-extensions/time-series.mdx#deleting-a-range-of-entries) - * [Querying Time Series](../../../studio/database/document-extensions/time-series.mdx#querying-time-series) - * [Results in Graph View](../../../studio/database/document-extensions/time-series.mdx#results-in-graph-view) - * [Incremental Time Series](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series) - * [Creating a new Incremental Time Series (by Creating its First Entry)](../../../studio/database/document-extensions/time-series.mdx#creating-a-new-incremental-time-series-by-creating-its-first-entry) - * [Editing an Incremental Time Series Entry](../../../studio/database/document-extensions/time-series.mdx#editing-an-incremental-time-series-entry) + * [Document View](#document-view) + * [Time Series View](#time-series-view) + * [Create new Time Series (by Creating the First Entry)](#create-new-time-series-by-creating-its-first-entry) + * [Editing an Entry](#editing-an-entry) + * [Deleting a Range of Entries](#deleting-a-range-of-entries) + * [Querying Time Series](#querying-time-series) + * [Results in Graph View](#results-in-graph-view) + * [Incremental Time Series](#incremental-time-series) + * [Creating a new Incremental Time Series (by Creating its First Entry)](#creating-a-new-incremental-time-series-by-creating-its-first-entry) + * [Editing an Incremental Time Series Entry](#editing-an-incremental-time-series-entry) @@ -46,7 +46,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. To view a document's time series, open its [document view](../../../studio/database/documents/document-view.mdx) and click the time series tab on the right. -2. Click 'Add Time Series' to create a new time series [see more below](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-its-first-entry). +2. Click 'Add Time Series' to create a new time series [see more below](#create-new-time-series-by-creating-its-first-entry). 3. Click to view and modify time series data. @@ -56,7 +56,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A. Time series info: * B. **Name** - [Incremental Time Series](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series) + [Incremental Time Series](#incremental-time-series) names always begin with `INC:` E.g. **INC: Downloads** in the first time series listed above. @@ -74,7 +74,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Click to select another time series. -2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a [new time series](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-the-first-entry). +2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a [new time series](#create-new-time-series-by-creating-the-first-entry). 3. Delete all entries from a specified time range. 4. Edit entry. @@ -94,7 +94,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; once all entries have been deleted). * Click the **Add Time Series** button from the - [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) + [Document View](#document-view) to create the time series' first entry. ![Add Time Series](./assets/new-time-series.png) @@ -104,7 +104,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. **Time Series Type** * **Diasble** to create a **non-incremental time series**. - (Learn now to create an incremental time series [here](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series)) + (Learn now to create an incremental time series [here](#incremental-time-series)) 2. **Time Series Name** * Enter time series' name. * Name cannot start with 'INC:' as this prefix is reserved for incremental time series. @@ -122,7 +122,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ### Editing an Entry * Click the **Edit Item** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to edit a time series' entry. ![Edit Time Series](./assets/edit-time-series.png) @@ -139,7 +139,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ### Deleting a Range of Entries * Click the **Delete Range** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to delete a range of time series entries. ![Delete Range Button](./assets/delete-range-button.png) @@ -254,7 +254,7 @@ To specify a range of time series entries: once all entries have been deleted). * Click the **Add Time Series** button from the - [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) + [Document View](#document-view) to create the incremental time series' first entry. ![Add Time Series](./assets/new-time-series.png) @@ -280,7 +280,7 @@ To specify a range of time series entries: ### Editing an Incremental Time Series Entry * Click the **Edit Item** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to edit a time series' entry. ![Edit Time Series](./assets/edit-incremental-time-series.png) diff --git a/docs/studio/database/documents/create-new-document.mdx b/docs/studio/database/documents/create-new-document.mdx index 57f5433f6f..7af33352e7 100644 --- a/docs/studio/database/documents/create-new-document.mdx +++ b/docs/studio/database/documents/create-new-document.mdx @@ -29,10 +29,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * For a full description of the different ID types, see [Document Identifier Generation](../../../server/kb/document-identifier-generation.mdx). * In this article: - * [Create new document](../../../studio/database/documents/create-new-document.mdx#create-new-document) - * [Create new document in current collection](../../../studio/database/documents/create-new-document.mdx#create-new-document-in-current-collection) - * [Clone an existing document](../../../studio/database/documents/create-new-document.mdx#clone-an-existing-document) - * [Document ID types - examples](../../../studio/database/documents/create-new-document.mdx#document-id-types---examples) + * [Create new document](#create-new-document) + * [Create new document in current collection](#create-new-document-in-current-collection) + * [Clone an existing document](#clone-an-existing-document) + * [Document ID types - examples](#document-id-types---examples) ## Create new document @@ -44,7 +44,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Figure 2. Edit the new document](./assets/create-new-document-2.png) -* 1 - **Enter document ID** - see the [examples](../../../studio/database/documents/create-new-document.mdx#document-id-types---examples) below. +* 1 - **Enter document ID** - see the [examples](#document-id-types---examples) below. * Any collection name can be entered as a prefix. * The collection name will be created if it doesn't exist yet. * If no collection name is specified, i.e. the ID string doesn't end with ( / ) or ( | ), @@ -69,7 +69,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 1 - **Enter document ID** * The current collection name is initially suggested. * Any other collection name of your choice can still be entered, - document creation will be handled as described above in [Create New Document](../../../studio/database/documents/create-new-document.mdx#create-new-document). + document creation will be handled as described above in [Create New Document](#create-new-document). * 2 - **Edit document content** * Edit the document fields. @@ -77,7 +77,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; then the initial document content showing will be those fields. (In the above example the fields are: _ID Type_ & _Name_) * If not all documents share the exact same fields, - then the initial document content will be just the initial template as in [Create New Document](../../../studio/database/documents/create-new-document.mdx#create-new-document). + then the initial document content will be just the initial template as in [Create New Document](#create-new-document). * 3 - Click **Save** when done. diff --git a/docs/studio/database/documents/document-view.mdx b/docs/studio/database/documents/document-view.mdx index 83ed18bc10..819ee3dcaa 100644 --- a/docs/studio/database/documents/document-view.mdx +++ b/docs/studio/database/documents/document-view.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions such as cloning the document, deleting, adding attachments, and much more can be performed. * In this page: - * [Document View](../../../studio/database/documents/document-view.mdx#the-document-view) - * [Documents View - Actions](../../../studio/database/documents/document-view.mdx#document-view---actions) + * [Document View](#the-document-view) + * [Documents View - Actions](#document-view---actions) ## The Document View diff --git a/docs/studio/database/documents/documents-and-collections.mdx b/docs/studio/database/documents/documents-and-collections.mdx index 5bd512275e..0d20d01d42 100644 --- a/docs/studio/database/documents/documents-and-collections.mdx +++ b/docs/studio/database/documents/documents-and-collections.mdx @@ -36,7 +36,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [The Documents View](../../../studio/database/documents/documents-and-collections.mdx#the-documents-view) + * [The Documents View](#the-documents-view) * [The @hilo Collection](../../../studio/database/documents/documents-and-collections.mdx#the-@hilo-collection) * [The @empty Collection](../../../studio/database/documents/documents-and-collections.mdx#the-@empty-collection) diff --git a/docs/studio/database/documents/identities-view.mdx b/docs/studio/database/documents/identities-view.mdx index 2df6c5e416..9f0d28b16a 100644 --- a/docs/studio/database/documents/identities-view.mdx +++ b/docs/studio/database/documents/identities-view.mdx @@ -22,10 +22,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Identities values can also be managed from the Client API, see [seed identity operation](../../../client-api/operations/maintenance/identities/seed-identity.mdx). * In this article: - * [What is an identity](../../../studio/database/documents/identities-view.mdx#what-is-an-identity) - * [The latest values](../../../studio/database/documents/identities-view.mdx#the-latest-values) - * [Edit identity value](../../../studio/database/documents/identities-view.mdx#edit-identity-value) - * [Add new identity](../../../studio/database/documents/identities-view.mdx#add-new-identity) + * [What is an identity](#what-is-an-identity) + * [The latest values](#the-latest-values) + * [Edit identity value](#edit-identity-value) + * [Add new identity](#add-new-identity) @@ -56,7 +56,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. **Document ID Prefix** * This string is the collection name for which an identity value was set: - either [via this view](../../../studio/database/documents/identities-view.mdx#add-new-identity), + either [via this view](#add-new-identity), or by creating a document with an identity ID as described [here](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities). * The string that shows is the collection name + a pipe suffix. diff --git a/docs/studio/database/documents/patch-view.mdx b/docs/studio/database/documents/patch-view.mdx index acaf942ad3..49d8f3b509 100644 --- a/docs/studio/database/documents/patch-view.mdx +++ b/docs/studio/database/documents/patch-view.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Patching a single document](../../../client-api/operations/patching/single-document.mdx) * [Set-based patch operations](../../../client-api/operations/patching/set-based.mdx) * In this article: - * [The patch view](../../../studio/database/documents/patch-view.mdx#the-patch-view) - * [The patch script](../../../studio/database/documents/patch-view.mdx#the-patch-script) - * [Patch configuration](../../../studio/database/documents/patch-view.mdx#patch-configuration) - * [Test patch](../../../studio/database/documents/patch-view.mdx#test-patch) - * [Apply patch](../../../studio/database/documents/patch-view.mdx#apply-patch) + * [The patch view](#the-patch-view) + * [The patch script](#the-patch-script) + * [Patch configuration](#patch-configuration) + * [Test patch](#test-patch) + * [Apply patch](#apply-patch) ## The patch view @@ -41,13 +41,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to view sample patch script syntax. More examples are available [here](../../../client-api/operations/patching/set-based.mdx#examples). 3. **Enter the patch script** - Enter your [Patch script](../../../studio/database/documents/patch-view.mdx#the-patch-script) in this input box. + Enter your [Patch script](#the-patch-script) in this input box. 4. **Apply the patch** Click to apply the patch to the documents selected by the query section of the patch script. - See [Apply patch](../../../studio/database/documents/patch-view.mdx#apply-patch) below. + See [Apply patch](#apply-patch) below. 5. **Test the patch** Click to test your patch without actually applying it to your documents. - See [Test patch](../../../studio/database/documents/patch-view.mdx#test-patch) below. + See [Test patch](#test-patch) below. diff --git a/docs/studio/database/indexes/create-map-index.mdx b/docs/studio/database/indexes/create-map-index.mdx index 959fcff66b..b3793d2764 100644 --- a/docs/studio/database/indexes/create-map-index.mdx +++ b/docs/studio/database/indexes/create-map-index.mdx @@ -19,15 +19,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; that indicate how to index selected document fields, counters, and time series data. * In this page: - * [Edit Index View](../../../studio/database/indexes/create-map-index.mdx#edit-index-view) - * [Test Index](../../../studio/database/indexes/create-map-index.mdx#test-index) - * [Index Fields & Terms](../../../studio/database/indexes/create-map-index.mdx#index-fields--terms) - * [Index Field Options](../../../studio/database/indexes/create-map-index.mdx#index-field-options) - * [Add Compound Field](../../../studio/database/indexes/create-map-index.mdx#add-compound-field) - * [Configuration](../../../studio/database/indexes/create-map-index.mdx#configuration) - * [Additional Assemblies](../../../studio/database/indexes/create-map-index.mdx#additional-assemblies) - * [Additional Sources](../../../studio/database/indexes/create-map-index.mdx#additional-sources) - * [Spatial Field Options](../../../studio/database/indexes/create-map-index.mdx#spatial-field-options) + * [Edit Index View](#edit-index-view) + * [Test Index](#test-index) + * [Index Fields & Terms](#index-fields--terms) + * [Index Field Options](#index-field-options) + * [Add Compound Field](#add-compound-field) + * [Configuration](#configuration) + * [Additional Assemblies](#additional-assemblies) + * [Additional Sources](#additional-sources) + * [Spatial Field Options](#spatial-field-options) ## Edit Index View @@ -41,7 +41,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. Options available for an already saved index: **Copy C#** - Click to view and copy the C# class that defines the index as set in the Studio. **Query** - Click to go the the Query View and query this index. - **Terms** - Click to see the index terms, see [below](../../../studio/database/indexes/create-map-index.mdx#index-fields--terms). + **Terms** - Click to see the index terms, see [below](#index-fields--terms). **Advanced** - Click to dump the raw index or optimize it. **Delete** - Delete this index. @@ -176,7 +176,7 @@ modifications in the index maps and configuration. Hover over a term to Query the index by this term, Preview the term, or Copy the term to the clipboard. Terms are created from the value of the field that was requested to be indexed - by the specified [Field Options](../../../studio/database/indexes/create-map-index.mdx#index-field-options). + by the specified [Field Options](#index-field-options). @@ -191,7 +191,7 @@ modifications in the index maps and configuration. If the Corax search engine is used, compound fields can be added to optimize specific queries. This option is for **expert users only**. * Learn about Corax and compound fields [here](../../../indexes/search-engine/corax.mdx#compound-fields). - * Learn to add a compound field using Studio [below](../../../studio/database/indexes/create-map-index.mdx#add-compound-field). + * Learn to add a compound field using Studio [below](#add-compound-field). 3. **Add default field options** Use this option to set default field options for all indexed fields. @@ -229,7 +229,7 @@ modifications in the index maps and configuration. ask about (i.e. spelling errors). * [Spatial](../../../indexes/querying/spatial.mdx) - See [below](../../../studio/database/indexes/create-map-index.mdx#spatial-field-options) + See [below](#spatial-field-options) 6. **Advanced Options** Click to display or hide these advanced index field options: diff --git a/docs/studio/database/indexes/create-map-reduce-index.mdx b/docs/studio/database/indexes/create-map-reduce-index.mdx index 6ec048f5ac..fdc8f451e6 100644 --- a/docs/studio/database/indexes/create-map-reduce-index.mdx +++ b/docs/studio/database/indexes/create-map-reduce-index.mdx @@ -36,15 +36,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Map-Reduce results can be visualized in the [Map-Reduce Visualizer](../../../studio/database/indexes/map-reduce-visualizer.mdx). * In this page: - * [The Map Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-map-stage) - * [The Reduce Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-reduce-stage) - * [Important Guidelines](../../../studio/database/indexes/create-map-reduce-index.mdx#important-guidelines) - * [Map-Reduce Query Results](../../../studio/database/indexes/create-map-reduce-index.mdx#map-reduce-query-results) - * [Multi-Map-Reduce](../../../studio/database/indexes/create-map-reduce-index.mdx#multi-map-reduce) + * [The Map Stage](#the-map-stage) + * [The Reduce Stage](#the-reduce-stage) + * [Important Guidelines](#important-guidelines) + * [Map-Reduce Query Results](#map-reduce-query-results) + * [Multi-Map-Reduce](#multi-map-reduce) * [Saving Map-Reduce Results into a Collection (Artificial Documents)](../../../studio/database/indexes/create-map-reduce-index.mdx#saving-map-reduce-results-in-a-collection-(artificial-documents)) - * [Artificial -vs- Regular Documents](../../../studio/database/indexes/create-map-reduce-index.mdx#artificial-documents--vs--regular-documents) - * [Artificial Documents Usage](../../../studio/database/indexes/create-map-reduce-index.mdx#artificial-documents-usage) - * [Artificial Documents Limitations](../../../studio/database/indexes/create-map-reduce-index.mdx#limitations) + * [Artificial -vs- Regular Documents](#artificial-documents--vs--regular-documents) + * [Artificial Documents Usage](#artificial-documents-usage) + * [Artificial Documents Limitations](#limitations) ## The Map Stage @@ -82,7 +82,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The accumulative value of this field will represent the total amount spent by a company on _all_ orders. 3. Next, click 'Add Reduction' to continue and add the 'Reduce' function. - See [The Reduce Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-reduce-stage). + See [The Reduce Stage](#the-reduce-stage). ## The Reduce Stage diff --git a/docs/studio/database/indexes/create-multi-map-index.mdx b/docs/studio/database/indexes/create-multi-map-index.mdx index 2593b88503..d4f7a2cce0 100644 --- a/docs/studio/database/indexes/create-multi-map-index.mdx +++ b/docs/studio/database/indexes/create-multi-map-index.mdx @@ -23,8 +23,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Multi-Map indexes require that all the Map functions defined have the _same_ output structure. * In this page: - * [Define a Map Function](../../../studio/database/indexes/create-multi-map-index.mdx#define-a-map-function) - * [Add another Map Function](../../../studio/database/indexes/create-multi-map-index.mdx#add-another-map-function) + * [Define a Map Function](#define-a-map-function) + * [Add another Map Function](#add-another-map-function) ## Define a Map Function diff --git a/docs/studio/database/indexes/index-cleanup.mdx b/docs/studio/database/indexes/index-cleanup.mdx index 54861d3daf..11959b7810 100644 --- a/docs/studio/database/indexes/index-cleanup.mdx +++ b/docs/studio/database/indexes/index-cleanup.mdx @@ -29,11 +29,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Merge indexes](../../../studio/database/indexes/index-cleanup.mdx#merge-indexes) - * [Remove sub-indexes](../../../studio/database/indexes/index-cleanup.mdx#remove-sub-indexes) - * [Remove unused indexes](../../../studio/database/indexes/index-cleanup.mdx#remove-unused-indexes) - * [Indexes that will not be merged](../../../studio/database/indexes/index-cleanup.mdx#indexes-that-will-not-be-merged) - * [Merge suggestions errors](../../../studio/database/indexes/index-cleanup.mdx#merge-suggestions-errors) + * [Merge indexes](#merge-indexes) + * [Remove sub-indexes](#remove-sub-indexes) + * [Remove unused indexes](#remove-unused-indexes) + * [Indexes that will not be merged](#indexes-that-will-not-be-merged) + * [Merge suggestions errors](#merge-suggestions-errors) ## Merge indexes diff --git a/docs/studio/database/indexes/index-history.mdx b/docs/studio/database/indexes/index-history.mdx index d9211ec240..fa6e9914b0 100644 --- a/docs/studio/database/indexes/index-history.mdx +++ b/docs/studio/database/indexes/index-history.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * An index revision is created for any change made to the index definition. * By default 10 index revisions are kept. This number can be modified using - the [Database Settings view](../../../studio/database/indexes/index-history.mdx#view-and-update-number-of-index-revisions) + the [Database Settings view](#view-and-update-number-of-index-revisions) or through [configuration](../../../server/configuration/configuration-options.mdx). * The Index History dialog allows you to browse these revisions and revert @@ -27,10 +27,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can revert only the 'Map and Reduce' methods or the full index definition. * In this page: - * [Open Index History Dialog](../../../studio/database/indexes/index-history.mdx#open-index-history-dialog) - * [Index History Dialog](../../../studio/database/indexes/index-history.mdx#index-history-dialog) - * [Select and Load an Index Revision](../../../studio/database/indexes/index-history.mdx#select-and-load-an-index-revision) - * [View and Update Number of Index Revisions](../../../studio/database/indexes/index-history.mdx#view-and-update-number-of-index-revisions) + * [Open Index History Dialog](#open-index-history-dialog) + * [Index History Dialog](#index-history-dialog) + * [Select and Load an Index Revision](#select-and-load-an-index-revision) + * [View and Update Number of Index Revisions](#view-and-update-number-of-index-revisions) ## Open Index History Dialog diff --git a/docs/studio/database/indexes/indexes-list-view.mdx b/docs/studio/database/indexes/indexes-list-view.mdx index 673c7f0e15..a6386edcff 100644 --- a/docs/studio/database/indexes/indexes-list-view.mdx +++ b/docs/studio/database/indexes/indexes-list-view.mdx @@ -21,11 +21,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; and more. * In this article: - * [Indexes list view](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view) - * [Indexes list view - Actions](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) - * [Indexes list view - Index errors](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---errors) - * [Indexes list view - Side by side indexing](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing) - * [Indexes list view - Rolling deployment](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---rolling-deployment) + * [Indexes list view](#indexes-list-view) + * [Indexes list view - Actions](#indexes-list-view---actions) + * [Indexes list view - Index errors](#indexes-list-view---errors) + * [Indexes list view - Side by side indexing](#indexes-list-view---side-by-side-indexing) + * [Indexes list view - Rolling deployment](#indexes-list-view---rolling-deployment) ## Indexes list view @@ -111,7 +111,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; By default, RavenDB prioritizes request processing over indexing to ensure responsiveness. * **Mode** Set the modification behavior (for static-indexes only): - * Unlocked - Changes to the index definition will be applied. See [Side by side indexing](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing). + * Unlocked - Changes to the index definition will be applied. See [Side by side indexing](#indexes-list-view---side-by-side-indexing). * Locked - Changes to the index definition will not be applied. No error is raised. * Locked(Error) - Changes to the index definition will not be applied, and an error is raised when attempting to modify the index. diff --git a/docs/studio/database/indexes/indexes-overview.mdx b/docs/studio/database/indexes/indexes-overview.mdx index ee382ce77b..dfc92470e9 100644 --- a/docs/studio/database/indexes/indexes-overview.mdx +++ b/docs/studio/database/indexes/indexes-overview.mdx @@ -31,19 +31,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Auto-indexes are generated by the server - see [Auto indexes](../../../indexes/creating-and-deploying.mdx#auto-indexes) * In this page: - * [Indexes - The General Concept](../../../studio/database/indexes/indexes-overview.mdx#indexes---the-general-concept) - * [Indexes - The Moving Parts](../../../studio/database/indexes/indexes-overview.mdx#indexes---the-moving-parts) : - * [Index Definition](../../../studio/database/indexes/indexes-overview.mdx#1-index-definition) - * [Indexing Process](../../../studio/database/indexes/indexes-overview.mdx#2-indexing-process) - * [Indexed Data](../../../studio/database/indexes/indexes-overview.mdx#3-indexed-data) - * [Index Types](../../../studio/database/indexes/indexes-overview.mdx#index-types) : - * [Auto Indexes -vs- Static Indexes](../../../studio/database/indexes/indexes-overview.mdx#auto-indexes--vs--static-indexes) - * [Map Indexes -vs- Map-Reduce Indexes](../../../studio/database/indexes/indexes-overview.mdx#map-indexes--vs--map-reduce-indexes) - * [Single-Collection Indexes -vs- Multi-Collection Indexes](../../../studio/database/indexes/indexes-overview.mdx#single-collection-indexes--vs--multi-collection-indexes) - * [Field Configuration Options](../../../studio/database/indexes/indexes-overview.mdx#field-configuration-options) - * [Modifying Index Definition](../../../studio/database/indexes/indexes-overview.mdx#modifying-index-definition) - * [Indexes in the Cluster](../../../studio/database/indexes/indexes-overview.mdx#indexes-in-the-cluster) - * [Indexing Errors](../../../studio/database/indexes/indexes-overview.mdx#indexing-errors) + * [Indexes - The General Concept](#indexes---the-general-concept) + * [Indexes - The Moving Parts](#indexes---the-moving-parts) : + * [Index Definition](#1-index-definition) + * [Indexing Process](#2-indexing-process) + * [Indexed Data](#3-indexed-data) + * [Index Types](#index-types) : + * [Auto Indexes -vs- Static Indexes](#auto-indexes--vs--static-indexes) + * [Map Indexes -vs- Map-Reduce Indexes](#map-indexes--vs--map-reduce-indexes) + * [Single-Collection Indexes -vs- Multi-Collection Indexes](#single-collection-indexes--vs--multi-collection-indexes) + * [Field Configuration Options](#field-configuration-options) + * [Modifying Index Definition](#modifying-index-definition) + * [Indexes in the Cluster](#indexes-in-the-cluster) + * [Indexing Errors](#indexing-errors) @@ -59,7 +59,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * After the first **indexing** run, the index will keep this map current _without_ re-processing the entire dataset - the index will only update the relevant indexed data when a document update happens in the database. -* Indexes in RavenDB are split across multiple axes (see more [below](../../../studio/database/indexes/indexes-overview.mdx#index-types)) +* Indexes in RavenDB are split across multiple axes (see more [below](#index-types)) * Auto Indexes -vs- Static Indexes * Map Indexes -vs- Map-Reduce Indexes diff --git a/docs/studio/database/indexes/indexing-performance.mdx b/docs/studio/database/indexes/indexing-performance.mdx index 4620777916..a49c71e776 100644 --- a/docs/studio/database/indexes/indexing-performance.mdx +++ b/docs/studio/database/indexes/indexing-performance.mdx @@ -24,14 +24,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Indexing Performance View](../../../studio/database/indexes/indexing-performance.mdx#indexing-performance-view) -* [Types of Index Tracks](../../../studio/database/indexes/indexing-performance.mdx#types-of-index-tracks) -* [Index Statistics View](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view) -* [Common Indexing Issues](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) - - [Resource Exhaustion](../../../studio/database/indexes/indexing-performance.mdx#resource-exhaustion) - - [Low Memory](../../../studio/database/indexes/indexing-performance.mdx#low-memory) - - [Concurrent Processing of Too Many Indexes](../../../studio/database/indexes/indexing-performance.mdx#concurrent-processing-of-too-many-indexes) - - [LoadDocument Misuse](../../../studio/database/indexes/indexing-performance.mdx#loaddocument-misuse) +* [Indexing Performance View](#indexing-performance-view) +* [Types of Index Tracks](#types-of-index-tracks) +* [Index Statistics View](#index-statistics-view) +* [Common Indexing Issues](#common-indexing-issues) + - [Resource Exhaustion](#resource-exhaustion) + - [Low Memory](#low-memory) + - [Concurrent Processing of Too Many Indexes](#concurrent-processing-of-too-many-indexes) + - [LoadDocument Misuse](#loaddocument-misuse) ## Indexing Performance View ![Indexing Performance View](./assets/indexing-performance-overview.png) @@ -56,10 +56,10 @@ In this page: * The red area represents the area that is zoomed in below. Enlarge or shrink it to zoom in and out below. 9. **Auto/Orders/ByOrderedAt** (Expanded Track) * This is one of the various types of indexes that is tracked in time. - * Clicking the index title expands the track (as seen in the **Auto/Orders/ByOrderedAt** image above) to show index [batch process details](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view). + * Clicking the index title expands the track (as seen in the **Auto/Orders/ByOrderedAt** image above) to show index [batch process details](#index-statistics-view). * Varying index types have different processes and they may index different volumes of data, so the graphs are likely to differ from one another. * Each colored stripe shows the duration of a stage in the batch process. - * Hovering over each stripe shows [detailed statistics](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view) about each stage. + * Hovering over each stripe shows [detailed statistics](#index-statistics-view) about each stage. 10. **Vertical line** Each verticle purple line shows that there was a time-lapse in the timeline before a batch process started. @@ -153,7 +153,7 @@ Click the following links to learn more about defining indexes via the Studio: - **(Name of the method used to create a batch stop)** There are a number of configurations that break up large batch processes into smaller batches to prevent exhausting system resources. While these batch stops prevent system exhaustion, they also point to potential opportunities to optimize your indexes. - These situations are discussed in the section on [common indexing issues](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) + These situations are discussed in the section on [common indexing issues](#common-indexing-issues) 3. **Storage** stages The amount of time it took to read or write the data to disk. * If this stage takes a long time after the index is already built, it may reveal a hardware problem. @@ -177,16 +177,16 @@ While they prevent system exhaustion, batch stops also point to potential **oppo Batch stops break up processes into smaller batches when - - An index is processing a [dataset that is too large](../../../studio/database/indexes/indexing-performance.mdx#resource-exhaustion) for your system resources. + - An index is processing a [dataset that is too large](#resource-exhaustion) for your system resources. - The index definition requires a complex Linq process (in Java - Stream API process) that can exhaust your resources. - - [Low memory](../../../studio/database/indexes/indexing-performance.mdx#low-memory) resources for indexing process on local machines or burstable cloud instances. - - [Too many concurrent index processes](../../../studio/database/indexes/indexing-performance.mdx#concurrent-processing-of-too-many-indexes) are exhausting your system resources. - - The [LoadDocument](../../../studio/database/indexes/indexing-performance.mdx#loaddocument-misuse) method is misused. + - [Low memory](#low-memory) resources for indexing process on local machines or burstable cloud instances. + - [Too many concurrent index processes](#concurrent-processing-of-too-many-indexes) are exhausting your system resources. + - The [LoadDocument](#loaddocument-misuse) method is misused. #### Resource Exhaustion Some indexes are responsible for a huge dataset and/or have very complex, demanding definitions. To prevent resource exhaustion, RavenDB can break up large batches into smaller ones. -You can configure [batch stops](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) with the following methods: +You can configure [batch stops](#common-indexing-issues) with the following methods: - [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) Number of seconds after which mapping will end even if there is more to map. @@ -196,7 +196,7 @@ You can configure [batch stops](../../../studio/database/indexes/indexing-perfor Maximum number of documents to be processed by the index per indexing batch. #### Low Memory -* [Low Memory](../../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) resources can slow down your system and result in [batch stops](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues). +* [Low Memory](../../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) resources can slow down your system and result in [batch stops](#common-indexing-issues). * **On a local machine** * You can upgrade your hardware, divide the work onto more machines in a cluster, and/or optimize your indexes. * Until then, there are a number of [indexing configurations](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that you can configure diff --git a/docs/studio/database/indexes/map-reduce-visualizer.mdx b/docs/studio/database/indexes/map-reduce-visualizer.mdx index 93853e0fbd..72f8915d67 100644 --- a/docs/studio/database/indexes/map-reduce-visualizer.mdx +++ b/docs/studio/database/indexes/map-reduce-visualizer.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; by graphing the relations between the documents and the Map-Reduce results. * In this page: - * [Map-Reduce Visualizer Usage Flow](../../../studio/database/indexes/map-reduce-visualizer.mdx#map-reduce-visualizer-usage-flow) - * [Map-Reduce Visualizer for Big Data](../../../studio/database/indexes/map-reduce-visualizer.mdx#map-reduce-visualizer-for-big-data) + * [Map-Reduce Visualizer Usage Flow](#map-reduce-visualizer-usage-flow) + * [Map-Reduce Visualizer for Big Data](#map-reduce-visualizer-for-big-data) ## Map-Reduce Visualizer Usage Flow diff --git a/docs/studio/database/queries/query-view.mdx b/docs/studio/database/queries/query-view.mdx index 1b47d67bf6..62c03cc4fd 100644 --- a/docs/studio/database/queries/query-view.mdx +++ b/docs/studio/database/queries/query-view.mdx @@ -25,11 +25,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query results can be saved/exported to a CSV file. * In this page: - * [Query View](../../../studio/database/queries/query-view.mdx#query-view) - * [Query Results](../../../studio/database/queries/query-view.mdx#query-results) - * [Select Visible Columns](../../../studio/database/queries/query-view.mdx#select-visible-columns) - * [Result Columns](../../../studio/database/queries/query-view.mdx#result-columns) - * [Additional Query Options](../../../studio/database/queries/query-view.mdx#additional-query-options) + * [Query View](#query-view) + * [Query Results](#query-results) + * [Select Visible Columns](#select-visible-columns) + * [Result Columns](#result-columns) + * [Additional Query Options](#additional-query-options) ## Query View @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 8. **Run Query** Click to run the query. 9. **Query Results** - The results area displays selected columns of results retrieved by your query (see [below](../../../studio/database/queries/query-view.mdx#query-results)). + The results area displays selected columns of results retrieved by your query (see [below](#query-results)). ## Query Results @@ -113,7 +113,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to expand or collapse the results view. ### Select Visible Columns -To modify the displayed result columns, open the Display drop-down dialog from the [Query Results](../../../studio/database/queries/query-view.mdx#query-results) view. +To modify the displayed result columns, open the Display drop-down dialog from the [Query Results](#query-results) view. Custom result columns can be added, edited and removed. ![Display Dialog](./assets/query-view-display-dialog.png) diff --git a/docs/studio/database/queries/spatial-queries-map-view.mdx b/docs/studio/database/queries/spatial-queries-map-view.mdx index 3c11fd064d..02819d5062 100644 --- a/docs/studio/database/queries/spatial-queries-map-view.mdx +++ b/docs/studio/database/queries/spatial-queries-map-view.mdx @@ -30,13 +30,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Spatial data in documents](../../../studio/database/queries/spatial-queries-map-view.mdx#spatial-data-in-documents) - * [Running a dynamic spatial query](../../../studio/database/queries/spatial-queries-map-view.mdx#running-a-dynamic-spatial-query) - * [Spatial map view](../../../studio/database/queries/spatial-queries-map-view.mdx#spatial-map-view) - * [Examples](../../../studio/database/queries/spatial-queries-map-view.mdx#examples) - * [Circular region example](../../../studio/database/queries/spatial-queries-map-view.mdx#circular-region-example) - * [Polygonal region example](../../../studio/database/queries/spatial-queries-map-view.mdx#polygonal-region-example) - * [Mixed shapes intersection example](../../../studio/database/queries/spatial-queries-map-view.mdx#mixed-shapes-intersection-example) + * [Spatial data in documents](#spatial-data-in-documents) + * [Running a dynamic spatial query](#running-a-dynamic-spatial-query) + * [Spatial map view](#spatial-map-view) + * [Examples](#examples) + * [Circular region example](#circular-region-example) + * [Polygonal region example](#polygonal-region-example) + * [Mixed shapes intersection example](#mixed-shapes-intersection-example) ## Spatial data in documents diff --git a/docs/studio/database/settings/client-configuration-per-database.mdx b/docs/studio/database/settings/client-configuration-per-database.mdx index 08f591d417..ff6bed5022 100644 --- a/docs/studio/database/settings/client-configuration-per-database.mdx +++ b/docs/studio/database/settings/client-configuration-per-database.mdx @@ -30,7 +30,7 @@ import Panel from '@site/src/components/Panel'; For example, adjusting load balancing behavior on the fly in response to changing system demands. * In this article: - * [Set the client configuration (for database)](../../../studio/database/settings/client-configuration-per-database.mdx#set-the-client-configuration-for-database) + * [Set the client configuration (for database)](#set-the-client-configuration-for-database) diff --git a/docs/studio/database/settings/conflict-resolution.mdx b/docs/studio/database/settings/conflict-resolution.mdx index af18a7eebe..f436814492 100644 --- a/docs/studio/database/settings/conflict-resolution.mdx +++ b/docs/studio/database/settings/conflict-resolution.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Conflicts that are created can be manually resolved in [Documents Conflicts View](../../../studio/database/documents/conflicts-view.mdx). * In this page: - * [The Conflicts Resolution View](../../../studio/database/settings/conflict-resolution.mdx#the-conflicts-resolution-view) - * [Script Examples](../../../studio/database/settings/conflict-resolution.mdx#script-examples) + * [The Conflicts Resolution View](#the-conflicts-resolution-view) + * [Script Examples](#script-examples) ## The Conflicts Resolution View diff --git a/docs/studio/database/settings/custom-analyzers.mdx b/docs/studio/database/settings/custom-analyzers.mdx index c3e59c47cd..58124b2ec5 100644 --- a/docs/studio/database/settings/custom-analyzers.mdx +++ b/docs/studio/database/settings/custom-analyzers.mdx @@ -30,10 +30,10 @@ that come with RavenDB out of the box. It can then be selected when configuring [index field options](../../../studio/database/indexes/create-map-index.mdx#index-field-options). * These views allow you to write your own custom analyzers: - * [Database Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#database-custom-analyzer-view) - * [Server-Wide Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#server-wide-custom-analyzer-view) - * [Edit Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view) - * [Change the Default Analyzers](../../../studio/database/settings/custom-analyzers.mdx#change-the-default-analyzers) + * [Database Custom Analyzer View](#database-custom-analyzer-view) + * [Server-Wide Custom Analyzer View](#server-wide-custom-analyzer-view) + * [Edit Custom Analyzer View](#edit-custom-analyzer-view) + * [Change the Default Analyzers](#change-the-default-analyzers) ## Database Custom Analyzer View @@ -41,9 +41,9 @@ that come with RavenDB out of the box. It can then be selected when configuring ![Figure 1. Database Custom Analyzer View](./assets/custom-analyzer-1.png) -1. Create a new database custom analyzer. Takes you to the analyzer editing view, see [below](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view). +1. Create a new database custom analyzer. Takes you to the analyzer editing view, see [below](#edit-custom-analyzer-view). 2. Edit an existing analyzer. -3. Go to the Server-Wide Custom Analyzer View, see [below](../../../studio/database/settings/custom-analyzers.mdx#server-wide-custom-analyzer-view). +3. Go to the Server-Wide Custom Analyzer View, see [below](#server-wide-custom-analyzer-view). @@ -59,7 +59,7 @@ The database custom analyzer will be the one used by indexes of this database. 1. Create a new server-wide custom analyzer. Takes you to the analyzer editing view, see -[below](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view). +[below](#edit-custom-analyzer-view). 2. Edit an existing analyzer. diff --git a/docs/studio/database/settings/database-record.mdx b/docs/studio/database/settings/database-record.mdx index 467d925ba6..ee61e7ebca 100644 --- a/docs/studio/database/settings/database-record.mdx +++ b/docs/studio/database/settings/database-record.mdx @@ -25,8 +25,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Database Record is Not editable * In this page: - * [The Database Record](../../../studio/database/settings/database-record.mdx#the-database-record) - * [The Database Record Fields](../../../studio/database/settings/database-record.mdx#the-database-record-fields) + * [The Database Record](#the-database-record) + * [The Database Record Fields](#the-database-record-fields) diff --git a/docs/studio/database/settings/database-settings.mdx b/docs/studio/database/settings/database-settings.mdx index 121b1e9396..9bd06f3667 100644 --- a/docs/studio/database/settings/database-settings.mdx +++ b/docs/studio/database/settings/database-settings.mdx @@ -21,17 +21,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; To edit a server-scope key follow any of the available options listed in the [Configuration overview](../../../server/configuration/configuration-options.mdx) article. * After editing & saving a configuration key, the change does not take effect - until the database is [reloaded](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + until the database is [reloaded](#how-to-reload-the-database). Do not modify the database settings unless you are an expert and know what you're doing. * In this page: - * [View Database Settings](../../../studio/database/settings/database-settings.mdx#view-database-settings) - * [Edit Database Settings](../../../studio/database/settings/database-settings.mdx#edit-database-settings) - * [Database Settings View with Pending Values](../../../studio/database/settings/database-settings.mdx#database-settings-view-with-pending-values) - * [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database) + * [View Database Settings](#view-database-settings) + * [Edit Database Settings](#edit-database-settings) + * [Database Settings View with Pending Values](#database-settings-view-with-pending-values) + * [How to Reload the Database](#how-to-reload-the-database) ## View Database Settings @@ -40,7 +40,7 @@ Do not modify the database settings unless you are an expert and know what you'r 1. Navigate to **Settings > Database Settings**. 2. Type a keyword here to filter the configuration keys. -3. Click on **Edit** to access the database setting editing view. [See next section](../../../studio/database/settings/database-settings.mdx#edit-database-settings). +3. Click on **Edit** to access the database setting editing view. [See next section](#edit-database-settings). 4. This column lists the **Configuration Keys**. * A 'yellow' entry is a key whose value was customized by the user. * A 'green' entry is a key holding a default value that was not modified. @@ -63,7 +63,7 @@ Do not modify the database settings unless you are an expert and know what you'r * Once you save the changes made in this view, all modifications are saved into the [database record](../../../studio/database/settings/database-record.mdx). However, in order for those changes to be in effect, the database must be reloaded. - See [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + See [How to Reload the Database](#how-to-reload-the-database). ![Figure 2: Edit Database Settings](./assets/database-settings-2.png) @@ -83,7 +83,7 @@ Do not modify the database settings unless you are an expert and know what you'r All changes will immediately be written to the database record. However, in this view, the changes will appear as pending and will not be in effect until the database is reloaded. - See [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + See [How to Reload the Database](#how-to-reload-the-database). ### Database Settings View with Pending Values diff --git a/docs/studio/database/settings/document-revisions.mdx b/docs/studio/database/settings/document-revisions.mdx index 4e995d53e5..f3624dc00e 100644 --- a/docs/studio/database/settings/document-revisions.mdx +++ b/docs/studio/database/settings/document-revisions.mdx @@ -21,13 +21,13 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Learn more about revisions [here](../../../document-extensions/revisions/overview.mdx). * In this article: - * [Document revisions view](../../../studio/database/settings/document-revisions.mdx#document-revisions-view) - * [Revisions configuration](../../../studio/database/settings/document-revisions.mdx#revisions-configuration) - * [Define default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) - * [Define collection-specific configuration](../../../studio/database/settings/document-revisions.mdx#define-collection-specific-configuration) - * [Edit conflicting document defaults](../../../studio/database/settings/document-revisions.mdx#edit-conflicting-document-defaults) - * [Conflicting documents example](../../../studio/database/settings/document-revisions.mdx#conflicting-documents-example) - * [Enforce configuration](../../../studio/database/settings/document-revisions.mdx#enforce-configuration) + * [Document revisions view](#document-revisions-view) + * [Revisions configuration](#revisions-configuration) + * [Define default configuration](#define-default-configuration) + * [Define collection-specific configuration](#define-collection-specific-configuration) + * [Edit conflicting document defaults](#edit-conflicting-document-defaults) + * [Conflicting documents example](#conflicting-documents-example) + * [Enforce configuration](#enforce-configuration) @@ -52,7 +52,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; Only documents are reverted. Other entities (such as ongoing tasks) are not modified by this process. 5. **Enforce Configuration** - Click to [enforce the revisions configuration](../../../studio/database/settings/document-revisions.mdx#enforce-configuration). + Click to [enforce the revisions configuration](#enforce-configuration). This operation may delete many revisions irrevocably and require substantial server resources. @@ -60,16 +60,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; 6. **Create document defaults** - Click to define [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) + Click to define [default configuration](#define-default-configuration) that will apply to documents in all collections that don't have a collection-specific configuration defined. 7. **Add a collection-specific configuration** - Click to create a [configuration for a specific collection](../../../studio/database/settings/document-revisions.mdx#define-collection-specific-configuration). + Click to create a [configuration for a specific collection](#define-collection-specific-configuration). If default settings were defined, the collection-specific configuration will override them for this collection. 8. **The defined Revisions configuration** - Read more [below](../../../studio/database/settings/document-revisions.mdx#revisions-configuration). + Read more [below](#revisions-configuration). @@ -87,7 +87,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; ![Defined Configuration](./assets/defined-configuration.png) 1. **Document Defaults** - This is the [default revisions configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) that applies to all non-conflicting documents in all collections + This is the [default revisions configuration](#define-default-configuration) that applies to all non-conflicting documents in all collections that don't have a collection-specific configuration defined. These settings are optional and can be removed. @@ -96,7 +96,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; When enabled, a revision is created for each conflicting item. A revision is also created for the conflict resolution document. * The Conflicting Document Defaults configuration cannot be removed. - * You can [modify](../../../studio/database/settings/document-revisions.mdx#edit-conflicting-document-defaults) this configuration, + * You can [modify](#edit-conflicting-document-defaults) this configuration, or disable it if not interested in tracking document conflicts using revisions. * When "Document Defaults configuration" is defined, it **overrides** these conflict defaults. * When a "Collection-specific configuration" is defined, @@ -178,7 +178,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; ![Select Collection](./assets/select-collection.png) 3. **Configuration options** - These options are similar to those explained above for the [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration), + These options are similar to those explained above for the [default configuration](#define-default-configuration), the only difference is the configuration scope. 4. Click **OK** to keep the configuration, or **Cancel**. @@ -197,7 +197,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; ![Editing the Conflicting Document Defaults](./assets/edit-conflicting-docs-configuration.png) -* The settings options are similar to those explained above for the [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration). +* The settings options are similar to those explained above for the [default configuration](#define-default-configuration). * Note: the **Limit # of revisions to keep by age** value is set to `45 Days` by default. This means that revisions created for conflicting documents will start to be purged after 45 days, diff --git a/docs/studio/database/settings/documents-compression.mdx b/docs/studio/database/settings/documents-compression.mdx index 7c5f3d5ab5..992a557905 100644 --- a/docs/studio/database/settings/documents-compression.mdx +++ b/docs/studio/database/settings/documents-compression.mdx @@ -36,7 +36,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To see the contents and size details of your database storage go to the [Storage Report](../../../studio/database/stats/storage-report.mdx) view in the Studio. * In this page: - * [Set documents compression from Studio](../../../studio/database/settings/documents-compression.mdx#set-documents-compression-from-studio) + * [Set documents compression from Studio](#set-documents-compression-from-studio) ## Set documents compression from Studio diff --git a/docs/studio/database/settings/integrations.mdx b/docs/studio/database/settings/integrations.mdx index e8e7968e52..b19a8c6d02 100644 --- a/docs/studio/database/settings/integrations.mdx +++ b/docs/studio/database/settings/integrations.mdx @@ -23,7 +23,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Secure Server](../../../start/installation/setup-wizard/choose-security-option.mdx). * In this page: - * [Integrations View](../../../studio/database/settings/integrations.mdx#integrations-view) + * [Integrations View](#integrations-view) ## Integrations View diff --git a/docs/studio/database/settings/manage-database-group.mdx b/docs/studio/database/settings/manage-database-group.mdx index 67ea27fb84..721db75e10 100644 --- a/docs/studio/database/settings/manage-database-group.mdx +++ b/docs/studio/database/settings/manage-database-group.mdx @@ -39,10 +39,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Note 2: Although not all nodes in the cluster belong to the Database Group, each node in the cluster _has_ a full copy of _all_ Database Group Topologies. * In this page: - * [Database Group Topology - View](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---view) - * [Database Group Topology - Actions](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---actions) - * [Database Group Topology - Add New Node](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---add-new-node) - * [Database Group Topology - Members Duties](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---members-duties) + * [Database Group Topology - View](#database-group-topology---view) + * [Database Group Topology - Actions](#database-group-topology---actions) + * [Database Group Topology - Add New Node](#database-group-topology---add-new-node) + * [Database Group Topology - Members Duties](#database-group-topology---members-duties) ## Database Group Topology - View @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The order of the nodes is relevant for the client, as it selects which node to contact from this list. Click this button to reorder the nodes order. -2. **Add a Node to the database group** - See [below](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---add-new-node) +2. **Add a Node to the database group** - See [below](#database-group-topology---add-new-node) 3. **Settings** Open settings to set ***Dynamic Database Distribution*** @@ -106,7 +106,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Check the 'Choose preferred mentor node manually' checkbox in order to specify which node will be the preferred mentor for the newly added node. If not checked, then any one of the already existing Member nodes in the group will become the mentor node. The preferred mentor will be responsible for updating the new node with all the database data and its state. - See [Members Duties](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---members-duties) + See [Members Duties](#database-group-topology---members-duties) diff --git a/docs/studio/database/settings/studio-configuration.mdx b/docs/studio/database/settings/studio-configuration.mdx index 2cc366ad5b..66ad12f075 100644 --- a/docs/studio/database/settings/studio-configuration.mdx +++ b/docs/studio/database/settings/studio-configuration.mdx @@ -25,16 +25,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -[Studio Configuration - Single Database](../../../studio/database/settings/studio-configuration.mdx#studio-configuration---single-database) +[Studio Configuration - Single Database](#studio-configuration---single-database) -* [Database Studio Configuration View](../../../studio/database/settings/studio-configuration.mdx#database-studio-configuration-view) -* [Disabling Auto-Index Creation on Studio Queries or Patches](../../../studio/database/settings/studio-configuration.mdx#disabling-auto-index-creation-on-studio-queries-or-patches) - * [About Auto-Index Creation](../../../studio/database/settings/studio-configuration.mdx#about-auto-indexes-and-the-studio) +* [Database Studio Configuration View](#database-studio-configuration-view) +* [Disabling Auto-Index Creation on Studio Queries or Patches](#disabling-auto-index-creation-on-studio-queries-or-patches) + * [About Auto-Index Creation](#about-auto-indexes-and-the-studio) * [If Disabled, Temporarily Enable Auto-Index Creation](../../../studio/database/settings/studio-configuration.mdx#if-disabled,-temporarily-enable-auto-index-creation) -[Studio Configuration - Server-wide](../../../studio/database/settings/studio-configuration.mdx#studio-configuration---server-wide) +[Studio Configuration - Server-wide](#studio-configuration---server-wide) -* [Server Studio Configuration View](../../../studio/database/settings/studio-configuration.mdx#server-studio-configuration-view) +* [Server Studio Configuration View](#server-studio-configuration-view) diff --git a/docs/studio/database/settings/time-series-settings.mdx b/docs/studio/database/settings/time-series-settings.mdx index 9575277a08..bff8b2c2b2 100644 --- a/docs/studio/database/settings/time-series-settings.mdx +++ b/docs/studio/database/settings/time-series-settings.mdx @@ -37,11 +37,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; You can set a different retention period for each rollup so that you can delete the previous data after it has been summarized/aggregated. * In this page: - * [Rationale for Configuring Time Series Policies](../../../studio/database/settings/time-series-settings.mdx#rationale-for-configuring-time-series-policies) - * [Time Series Settings View](../../../studio/database/settings/time-series-settings.mdx#time-series-settings-view) - * [Defined Time Series Configurations](../../../studio/database/settings/time-series-settings.mdx#defined-time-series-configurations) - * [Add or Edit Time Series Configuration](../../../studio/database/settings/time-series-settings.mdx#add-or-edit-time-series-configuration) - * [Rollup Policies for Rollup Time Series](../../../studio/database/settings/time-series-settings.mdx#rollup-policies-for-rollup-time-series) + * [Rationale for Configuring Time Series Policies](#rationale-for-configuring-time-series-policies) + * [Time Series Settings View](#time-series-settings-view) + * [Defined Time Series Configurations](#defined-time-series-configurations) + * [Add or Edit Time Series Configuration](#add-or-edit-time-series-configuration) + * [Rollup Policies for Rollup Time Series](#rollup-policies-for-rollup-time-series) ## Rationale for Configuring Time Series Policies @@ -114,7 +114,7 @@ Here are the different levels of resolution that they want to see: 2 seconds will still be checked and executed every 8 seconds. 4. **Defined Time Series Configurations** - View and manage the time series configurations that were already defined (read more [below](../../../studio/database/settings/time-series-settings.mdx#defined-time-series-configurations)). + View and manage the time series configurations that were already defined (read more [below](#defined-time-series-configurations)). 5. **Add or Edit time series configurations** * Click the **Add a collection-specific configuration** button to create a new configuration. * Click a defined configuration **Edit** button to edit an existing configuration. @@ -131,11 +131,11 @@ Here are the different levels of resolution that they want to see: Check to select/deselect this configuration. Rollup and Retention policies for selected configurations can be enabled or disabled using the - [time series settings view](../../../studio/database/settings/time-series-settings.mdx#time-series-settings-view) **Set Status** button. + [time series settings view](#time-series-settings-view) **Set Status** button. 2. **Enable/Disable Configuration** Click to enable or disable Rollup and Retention policies for this configuration. 3. **Edit** - Click to [edit this configuration](../../../studio/database/settings/time-series-settings.mdx#add-or-edit-time-series-configuration). + Click to [edit this configuration](#add-or-edit-time-series-configuration). 4. **Remove** Click to remove this configuration. !["Defined Time Series Configurations - Info"](./assets/time-series-settings-04_per-collection-configuration-info.png) @@ -226,7 +226,7 @@ Here are the different levels of resolution that they want to see: Rollup policies can be defined both for **raw time series data** and for **rollup time series**. - Read more [here](../../../studio/database/settings/time-series-settings.mdx#rollup-policies-for-rollup-time-series). + Read more [here](#rollup-policies-for-rollup-time-series). In the above image, the rollup policy aggregates the **raw data** of the selected collection's time series, into **new** rollup time series. diff --git a/docs/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx b/docs/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx index 794963774d..e8b7323bb4 100644 --- a/docs/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx +++ b/docs/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The data shown in the graph will be either 'Outgoing' or 'Incoming', depending on whether the source or the target database is viewed. * In this page: - * [External Replication Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx#external-replication-stats-closed-view) - * [External Replication Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx#external-replication-stats-expanded-view) + * [External Replication Stats Closed View](#external-replication-stats-closed-view) + * [External Replication Stats Expanded View](#external-replication-stats-expanded-view) ## External Replication Stats diff --git a/docs/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx b/docs/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx index d4819bf7d7..82913e6ff5 100644 --- a/docs/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx +++ b/docs/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx @@ -21,8 +21,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the OLAP ETL task [here](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx). * In this page: - * [OLAP ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx#olap-etl-stats-closed-view) - * [OLAP ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx#olap-etl-stats-expanded-view) + * [OLAP ETL Stats Closed View](#olap-etl-stats-closed-view) + * [OLAP ETL Stats Expanded View](#olap-etl-stats-expanded-view) ## OLAP ETL Stats diff --git a/docs/studio/database/stats/ongoing-tasks-stats/overview.mdx b/docs/studio/database/stats/ongoing-tasks-stats/overview.mdx index 8abeec35ae..8e6f64aeb5 100644 --- a/docs/studio/database/stats/ongoing-tasks-stats/overview.mdx +++ b/docs/studio/database/stats/ongoing-tasks-stats/overview.mdx @@ -24,13 +24,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Tasks activities are graphically displayed for selected time frames. * In this page: - * [Ongoing Tasks Stats View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#ongoing-tasks-stats-view) - * [The Timeline Ruler](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#the-timeline-ruler) - * [Task Rulers](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-rulers) - * [Closed View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-ruler-closed-view) - * [Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-ruler-expanded-view) - * [Time Grid](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-rulers-time-grid) - * [Active and Inactive Display](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#active-and-inactive-display) + * [Ongoing Tasks Stats View](#ongoing-tasks-stats-view) + * [The Timeline Ruler](#the-timeline-ruler) + * [Task Rulers](#task-rulers) + * [Closed View](#task-ruler-closed-view) + * [Expanded View](#task-ruler-expanded-view) + * [Time Grid](#task-rulers-time-grid) + * [Active and Inactive Display](#active-and-inactive-display) ## Ongoing Tasks Stats View @@ -128,10 +128,10 @@ during the time specified by the timeline ruler above. A grid of vertical time lines allows you to easily relate task events to their time of occurence. -Note that the [stats graph](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#stats-graph) +Note that the [stats graph](#stats-graph) displays **two different time grids**. -* The [Timeline ruler time grid](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#the-timeline-ruler) +* The [Timeline ruler time grid](#the-timeline-ruler) shows time points across the entire timeline ruler line. * The Task rulers time grid, discussed here, shows points of time **within the selected time frame**. diff --git a/docs/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx b/docs/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx index 567e6b1f17..b66455b1a6 100644 --- a/docs/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx +++ b/docs/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the RavenDB ETL task [here](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx). * In this page: - * [RavenDB ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx#ravendb-etl-stats-closed-view) - * [RavenDB ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx#ravendb-etl-stats-expanded-view) + * [RavenDB ETL Stats Closed View](#ravendb-etl-stats-closed-view) + * [RavenDB ETL Stats Expanded View](#ravendb-etl-stats-expanded-view) ## RavenDB ETL Stats diff --git a/docs/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx b/docs/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx index 5c32407775..d68b20ea80 100644 --- a/docs/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx +++ b/docs/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the SQL ETL task [here](../../../../server/ongoing-tasks/etl/sql.mdx). * In this page: - * [SQL ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx#sql-etl-stats-closed-view) - * [SQL ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx#sql-etl-stats-expanded-view) + * [SQL ETL Stats Closed View](#sql-etl-stats-closed-view) + * [SQL ETL Stats Expanded View](#sql-etl-stats-expanded-view) ## SQL ETL Stats diff --git a/docs/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx b/docs/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx index bd22d9eef0..4bda7f0698 100644 --- a/docs/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx +++ b/docs/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx @@ -22,9 +22,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about data subscription tasks [here](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx). * In this page: - * [Subscription Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#subscription-stats-closed-view) - * [Subscription Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#subscription-stats-expanded-view) - * [Connection Event Indicators](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#connection-event-indicators) + * [Subscription Stats Closed View](#subscription-stats-closed-view) + * [Subscription Stats Expanded View](#subscription-stats-expanded-view) + * [Connection Event Indicators](#connection-event-indicators) ## Subscription Stats diff --git a/docs/studio/database/stats/storage-report.mdx b/docs/studio/database/stats/storage-report.mdx index 8d789c23e8..8f590ccc24 100644 --- a/docs/studio/database/stats/storage-report.mdx +++ b/docs/studio/database/stats/storage-report.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Refresh the page to see the effect of [Documents Compression](../../../server/storage/documents-compression.mdx) and [Database Compaction](../../../client-api/operations/server-wide/compact-database.mdx). * In this page: - * [Database storage report](../../../studio/database/stats/storage-report.mdx#database-storage-report) + * [Database storage report](#database-storage-report) ## Database storage report diff --git a/docs/studio/database/tasks/create-sample-data.mdx b/docs/studio/database/tasks/create-sample-data.mdx index 79bba9617f..cf5bc3608f 100644 --- a/docs/studio/database/tasks/create-sample-data.mdx +++ b/docs/studio/database/tasks/create-sample-data.mdx @@ -24,8 +24,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; Creating it will enable you to play with the data as you use the documentation to familiarize yourself with RavenDB features. * In this page: - * [Create Sample Data](../../../studio/database/tasks/create-sample-data.mdx#create-sample-data) - * [The Data Generated - Documents View](../../../studio/database/tasks/create-sample-data.mdx#the-data-generated---documents-view) + * [Create Sample Data](#create-sample-data) + * [The Data Generated - Documents View](#the-data-generated---documents-view) * [The C# Entities](../../../studio/database/tasks/create-sample-data.mdx#the-c#-entities) ## Create Sample Data diff --git a/docs/studio/database/tasks/export-database.mdx b/docs/studio/database/tasks/export-database.mdx index a7012658e6..dbe42e6560 100644 --- a/docs/studio/database/tasks/export-database.mdx +++ b/docs/studio/database/tasks/export-database.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; [section dedicated to this operation](../../../sharding/import-and-export.mdx#export). * In this page: - * [Export Database View](../../../studio/database/tasks/export-database.mdx#export-database-view) - * [Advanced Export Options](../../../studio/database/tasks/export-database.mdx#advanced-export-options) + * [Export Database View](#export-database-view) + * [Advanced Export Options](#advanced-export-options) ## Export Database View @@ -66,7 +66,7 @@ and export it to a `.ravendbdump` file. ![Provide Encryption Key](./assets/export-encryption-key.png) 7. **Advanced** - Click to display [advanced export settings](../../../studio/database/tasks/export-database.mdx#advanced-export-options). + Click to display [advanced export settings](#advanced-export-options). 8. **Export Database** Click to export the selected data to a `.ravendbdump` file. diff --git a/docs/studio/database/tasks/import-data/import-data-file.mdx b/docs/studio/database/tasks/import-data/import-data-file.mdx index ff8eea4057..e31e597b85 100644 --- a/docs/studio/database/tasks/import-data/import-data-file.mdx +++ b/docs/studio/database/tasks/import-data/import-data-file.mdx @@ -27,12 +27,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Import data to destination server from file](../../../../studio/database/tasks/import-data/import-data-file.mdx#import-data-to-destination-server-from-file) -* [Import options](../../../../studio/database/tasks/import-data/import-data-file.mdx#import-options) -* [Advanced import options](../../../../studio/database/tasks/import-data/import-data-file.mdx#advanced-import-options) - * [Transform Script](../../../../studio/database/tasks/import-data/import-data-file.mdx#transform-script) - * [Customize Configuration and Ongoing Tasks](../../../../studio/database/tasks/import-data/import-data-file.mdx#customize-configuration-and-ongoing-tasks) - * [Copy command as PowerShell](../../../../studio/database/tasks/import-data/import-data-file.mdx#copy-command-as-powershell) +* [Import data to destination server from file](#import-data-to-destination-server-from-file) +* [Import options](#import-options) +* [Advanced import options](#advanced-import-options) + * [Transform Script](#transform-script) + * [Customize Configuration and Ongoing Tasks](#customize-configuration-and-ongoing-tasks) + * [Copy command as PowerShell](#copy-command-as-powershell) @@ -55,7 +55,7 @@ If you have already [exported a database](../export-database.mdx), follow these 5. **Select file** Select the `.ravendbdump` file that you previously exported from the source server. 6. **Documents and Extensions** - Select desired [options](../../tasks/import-data/import-data-file.mdx#import-options). + Select desired [options](#import-options). *If you encrypted while exporting* make sure to select **imported file is encrypted**. You will need to paste the encryption key that you saved when creating the encrypted database. 7. **Advanced** diff --git a/docs/studio/database/tasks/import-data/import-from-csv.mdx b/docs/studio/database/tasks/import-data/import-from-csv.mdx index dd1f866feb..0ce691ef33 100644 --- a/docs/studio/database/tasks/import-data/import-from-csv.mdx +++ b/docs/studio/database/tasks/import-data/import-from-csv.mdx @@ -23,9 +23,9 @@ Because some CSV files are formatted differently, the RavenDB Studio enables you In this page: -* [What is CSV](../../../../studio/database/tasks/import-data/import-from-csv.mdx#what-is-csv) -* [How should I format my documents as CSV](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-should-i-format-my-documents-as-csv) -* [How to Import a CSV via RavenDB Studio](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-to-import-a-csv-via-ravendb-studio) +* [What is CSV](#what-is-csv) +* [How should I format my documents as CSV](#how-should-i-format-my-documents-as-csv) +* [How to Import a CSV via RavenDB Studio](#how-to-import-a-csv-via-ravendb-studio) @@ -190,6 +190,6 @@ Now that we've got a valid CSV file we can import it to RavenDB. 8. Select **Import Collection** After importing the CSV file, the resulting .json document should look like the document -[above](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-should-i-format-my-documents-as-csv). +[above](#how-should-i-format-my-documents-as-csv). diff --git a/docs/studio/database/tasks/import-data/import-from-other.mdx b/docs/studio/database/tasks/import-data/import-from-other.mdx index fccae32aa2..b23acfb002 100644 --- a/docs/studio/database/tasks/import-data/import-from-other.mdx +++ b/docs/studio/database/tasks/import-data/import-from-other.mdx @@ -25,9 +25,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Download Raven.Migrator Tool](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool) - * [Import from MongoDB](../../../../studio/database/tasks/import-data/import-from-other.mdx#import-from-mongodb) - * [Import from CosmosDB](../../../../studio/database/tasks/import-data/import-from-other.mdx#import-from-cosmosdb) + * [Download Raven.Migrator Tool](#download-ravenmigrator-tool) + * [Import from MongoDB](#import-from-mongodb) + * [Import from CosmosDB](#import-from-cosmosdb) @@ -48,7 +48,7 @@ In the RavenDB Studio client on the left side, select `Tasks` -> `Import Data ![Figure 1.](./assets/mongodb-1.png) 1. **Migrator Path** - * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** @@ -80,7 +80,7 @@ In the RavenDB Studio client on the left side, select `Tasks` -> `Import Data 1. **Migrator Path** - * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** diff --git a/docs/studio/database/tasks/import-data/import-from-ravendb.mdx b/docs/studio/database/tasks/import-data/import-from-ravendb.mdx index 63465e97f3..ec8d9cb6ea 100644 --- a/docs/studio/database/tasks/import-data/import-from-ravendb.mdx +++ b/docs/studio/database/tasks/import-data/import-from-ravendb.mdx @@ -148,7 +148,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; - [Include Identities](../../../../client-api/document-identifiers/working-with-document-identifiers.mdx) - [Include Compare Exchange](../../../../compare-exchange/overview.mdx) - [Include Subscriptions](../../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) - - [Include Configuration and OngoingTasks](../../../../studio/database/tasks/import-data/import-from-ravendb.mdx#customize-configuration-and-ongoing-tasks) + - [Include Configuration and OngoingTasks](#customize-configuration-and-ongoing-tasks) diff --git a/docs/studio/database/tasks/import-data/import-from-sql.mdx b/docs/studio/database/tasks/import-data/import-from-sql.mdx index 890cff3335..629bff10fb 100644 --- a/docs/studio/database/tasks/import-data/import-from-sql.mdx +++ b/docs/studio/database/tasks/import-data/import-from-sql.mdx @@ -34,16 +34,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; Changes made while preparing the data model maintain data integrity and cohesion. * In this page: - * [Import Data From SQL Source](../../../../studio/database/tasks/import-data/import-from-sql.mdx#import-data-from-sql-source) - * [Create a New Import Configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) - * [Advanced Import Options](../../../../studio/database/tasks/import-data/import-from-sql.mdx#advanced-import-options) - * [Run an Existing Import Configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration) - * [SQL Migration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#sql-migration) - * [Data Conversion: General Settings](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) - * [Data Conversion: Table/Collection Settings](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-tablecollection-settings) - * [Filtering and Transforming Documents](../../../../studio/database/tasks/import-data/import-from-sql.mdx#filtering-and-transforming-documents) - * [Handling Relationships](../../../../studio/database/tasks/import-data/import-from-sql.mdx#handling-relationships) - * [Data integrity Helpers](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-integrity-helpers) + * [Import Data From SQL Source](#import-data-from-sql-source) + * [Create a New Import Configuration](#create-a-new-import-configuration) + * [Advanced Import Options](#advanced-import-options) + * [Run an Existing Import Configuration](#run-an-existing-import-configuration) + * [SQL Migration](#sql-migration) + * [Data Conversion: General Settings](#data-conversion-general-settings) + * [Data Conversion: Table/Collection Settings](#data-conversion-tablecollection-settings) + * [Filtering and Transforming Documents](#filtering-and-transforming-documents) + * [Handling Relationships](#handling-relationships) + * [Data integrity Helpers](#data-integrity-helpers) ## Import Data From SQL Source @@ -55,15 +55,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to import data. 3. **From SQL** Click to import data from an SQL source. -4. [Create new import configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) +4. [Create new import configuration](#create-a-new-import-configuration) Create a new import configuration from scratch. The configuration can be exported and reused. -5. [Continue existing migration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration) +5. [Continue existing migration](#run-an-existing-import-configuration) Run an existing import configuration. ### Create a New Import Configuration Use this option to enter a new import configuration. -The configuration can then be exported and [reused](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration). +The configuration can then be exported and [reused](#run-an-existing-import-configuration). ![Create New Import Configuration](./assets/sql-migration-create-new-import.png) @@ -83,10 +83,10 @@ The configuration can then be exported and [reused](../../../../studio/database/ Click the **Syntax** caption to display valid connection strings for the different SQL sources. -3. [Advanced](../../../../studio/database/tasks/import-data/import-from-sql.mdx#advanced-import-options) +3. [Advanced](#advanced-import-options) Click for advanced import options. -4. [Create new import](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +4. [Create new import](#data-conversion-general-settings) Click to connect the SQL source and import the database schema and data. 5. **Test Connection** @@ -128,7 +128,7 @@ you can locate and run it here. ![Use Existing Import Configuration](./assets/sql-migration-use-existing-configuration.png) 1. Click to locate an existing import configuration on the file system. -2. Click to [run the selected configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +2. Click to [run the selected configuration](#data-conversion-general-settings) and migrate data from the SQL source. @@ -146,7 +146,7 @@ In _NoSQL_, this can be modeled as a list of foreign object IDs and requires no ### Data Conversion: General Settings -When an [import configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) +When an [import configuration](#create-a-new-import-configuration) is executed RavenDB connects the SQL source, obtains information about database tables and keys, and displays the following view to allow the user to alter the migration and target documents structure. @@ -189,7 +189,7 @@ target documents structure. Please note that limiting the migration may break links between documents. -7. [Table/Collection Conversion Tuning](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-tablecollection-settings) +7. [Table/Collection Conversion Tuning](#data-conversion-tablecollection-settings) Specific details related to the transfer of each table can be altered as well. See additional details below. ### Data Conversion: Table/Collection Settings @@ -211,7 +211,7 @@ target documents structure. Click for details regarding each relationship, and to select whether to skip each relationship or embed it in the document. -5. [Filter/Transform](../../../../studio/database/tasks/import-data/import-from-sql.mdx#filtering-and-transforming-documents) +5. [Filter/Transform](#filtering-and-transforming-documents) Click to alter the **filter query** executed over the source database, and/or the **transform script** used to shape the imported data. @@ -241,7 +241,7 @@ Filtering the read data is gained by altering the query RavenDB runs over the SQL server to fetch the data. transforming written documents is done using a transform script through which all incoming data passes. -Learn [here](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +Learn [here](#data-conversion-general-settings) how to connect the source database and open the filter/transform dialog. ![Filter and Transform](./assets/sql-migration-filter-and-export-I.png) diff --git a/docs/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx b/docs/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx index b209630f34..870778ceb2 100644 --- a/docs/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx @@ -28,11 +28,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; an Amazon SQS ETL task using the Client API. . * In this page: - * [Ongoing Tasks View](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#ongoing-tasks-view) - * [Define the Amazon SQS ETL task](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#define-amazon-sqs-etl-task) - * [Add or Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#add-or-edit-transformation-script) - * [Comments](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#comments) - * [ETL message size -vs- Queue message size](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#etl-message-size--vs--queue-message-size) + * [Ongoing Tasks View](#ongoing-tasks-view) + * [Define the Amazon SQS ETL task](#define-amazon-sqs-etl-task) + * [Add or Edit Transformation Script](#add-or-edit-transformation-script) + * [Comments](#comments) + * [ETL message size -vs- Queue message size](#etl-message-size--vs--queue-message-size) ## Ongoing Tasks View diff --git a/docs/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx b/docs/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx index fab151d084..7498d09ec6 100644 --- a/docs/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx @@ -31,11 +31,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx) how to define an Azure Queue Storage ETL task using the Client API. * In this page: - * [Open Azure Queue Storage ETL task view](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#open-azure-queue-storage-etl-task-view) - * [Define Azure Queue Storage ETL task](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#define-azure-queue-storage-etl-task) - * [Authentication method](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#authentication-method) - * [Options per queue](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#options-per-queue) - * [Add transformation script](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#add-transformation-script) + * [Open Azure Queue Storage ETL task view](#open-azure-queue-storage-etl-task-view) + * [Define Azure Queue Storage ETL task](#define-azure-queue-storage-etl-task) + * [Authentication method](#authentication-method) + * [Options per queue](#options-per-queue) + * [Add transformation script](#add-transformation-script) ## Open Azure Queue Storage ETL task view @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Toggle OFF to select an existing connection string from the list, or toggle ON to create a new one. * **Name** - Enter a name for the connection string. * **Authentication method** - Select the authentication method by which to connect to an Azure storage account. - Learn more about the available authentication methods [below](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#authentication-method). + Learn more about the available authentication methods [below](#authentication-method). 5. **Test Connection** After defining the connection string, click to test the connection to the Azure storage account. @@ -83,7 +83,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to add a transformation script. 7. **Advanced** - Click to open the [advanced section](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#options-per-queue) where you can configure the deletion of RavenDB documents per queue. + Click to open the [advanced section](#options-per-queue) where you can configure the deletion of RavenDB documents per queue. diff --git a/docs/studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx b/docs/studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx index 893bc569d0..dd5325b500 100644 --- a/docs/studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx @@ -25,9 +25,9 @@ import Admonition from '@theme/Admonition'; Learn how to define an Azure Service Bus sink task using the client API [here](../../../../server/ongoing-tasks/queue-sink/azure-service-bus-queue-sink.mdx). * In this article: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx#add-a-database-task) - * [Define an Azure Service Bus Sink Task](../../../../studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx#define-an-azure-service-bus-sink-task) - * [Authentication methods](../../../../studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx#authentication-methods) + * [Add a Database Task](#add-a-database-task) + * [Define an Azure Service Bus Sink Task](#define-an-azure-service-bus-sink-task) + * [Authentication methods](#authentication-methods) @@ -73,7 +73,7 @@ To open the ongoing tasks view: The connection string holds the details RavenDB needs to reach your Azure Service Bus namespace. Select an existing connection string from the list, or click **Create new connection string** to define a new one. A new connection string requires a **Name**, e.g., *AzureServiceBusConStr*, and an **Authentication** method. - Learn about the three authentication methods [below](../../../../studio/database/tasks/ongoing-tasks/azure-service-bus-queue-sink.mdx#authentication-methods). + Learn about the three authentication methods [below](#authentication-methods). 6. **Test Connection** After defining the connection string, click to test the connection to the Azure Service Bus namespace. diff --git a/docs/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx b/docs/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx index 2cf2368ebc..e5f1af0007 100644 --- a/docs/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx @@ -25,14 +25,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; the client API in [Ongoing Tasks: Elasticsearch ETL](../../../../server/ongoing-tasks/etl/elasticsearch.mdx) * In this page: - * [Navigate to the Elasticsearch ETL Task View](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#navigate-to-the-elasticsearch-etl-task-view) - * [Define the Elasticsearch ETL Task](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#define-the-elasticsearch-etl-task) - * [Elasticsearch Indexes](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) - * [Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#transformation-script) - * [Add Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#add-transformation-script) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#edit-transformation-script) - * [Test Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#test-transformation-script) - * [Test Results](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#test-results) + * [Navigate to the Elasticsearch ETL Task View](#navigate-to-the-elasticsearch-etl-task-view) + * [Define the Elasticsearch ETL Task](#define-the-elasticsearch-etl-task) + * [Elasticsearch Indexes](#elasticsearch-indexes) + * [Transformation Script](#transformation-script) + * [Add Transformation Script](#add-transformation-script) + * [Edit Transformation Script](#edit-transformation-script) + * [Test Transformation Script](#test-transformation-script) + * [Test Results](#test-results) ## Navigate to the Elasticsearch ETL Task View @@ -180,7 +180,7 @@ Elasticsearch destination per RavenDB document from the selected collections. * Make sure that one of the properties of the document object is given the value `id(this)`. - The ETL task will use this property [to identify](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#document-id-property-name) + The ETL task will use this property [to identify](#document-id-property-name) documents that reside on the Elasticsearch destination by their source RavenDB document ID. @@ -202,10 +202,10 @@ Elasticsearch destination per RavenDB document from the selected collections. specified collections** the first time the task runs. * When this option is **disabled**: The script will be executed **only over new and modified documents**. - * If [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + * If [Insert Only](#elasticsearch-indexes) is **enabled**: RavenDB documents will be appended to Elasticsearch **without deleting documents from Elasticsearch first**. - * If [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + * If [Insert Only](#elasticsearch-indexes) is **disabled**: Documents will be **deleted from Elasticsearch first**, and then appended to it from RavenDB. @@ -245,7 +245,7 @@ The test results view displays a **preview** of the tested document, and the **c 3. [_delete_by_query](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html) Segment The delete POST command with a list of IDs by which Elasticsearch would locate and remove existing documents. - Deleting existing document versions is **optional**, enable [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + Deleting existing document versions is **optional**, enable [Insert Only](#elasticsearch-indexes) to prevent the task from sending `_delete_by_query` commands. 4. [_bulk ](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html) Segment The bulk POST command with a list of document objects, each with data extracted from RavenDB and an ID that Elasticsearch stores it by. diff --git a/docs/studio/database/tasks/ongoing-tasks/external-replication-task.mdx b/docs/studio/database/tasks/ongoing-tasks/external-replication-task.mdx index a8427b7501..2d8bf6a934 100644 --- a/docs/studio/database/tasks/ongoing-tasks/external-replication-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/external-replication-task.mdx @@ -27,7 +27,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; such as filtration and two-way (master-master) replication, consider [Hub/Sink Replication](../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx). * To replicate between two separate, secure RavenDB servers, - you need to [pass a client certificate](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#step-by-step-guide) from the source server to the destination. + you need to [pass a client certificate](#step-by-step-guide) from the source server to the destination. * External replication can be a comfortable means of data migration into a [sharded](../../../../sharding/overview.mdx) database. You can read more about this option in the sharding documentation [external replication](../../../../sharding/external-replication.mdx) and [migration](../../../../sharding/migration.mdx) sections. @@ -36,11 +36,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; See more in [Backup -vs- Replication](../../../../backup/faq#is-an-external-replication-task-a-good-substitute-for-a-backup-task) * In this page: - * [General Information about External Replication Task](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#general-information-about-external-replication-task) - * [Step-by-Step Guide](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#step-by-step-guide) - * [Definition](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition) - * [Details in Tasks List View](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#details-in-tasks-list-view) - * [Offline Behavior](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#offline-behavior) + * [General Information about External Replication Task](#general-information-about-external-replication-task) + * [Step-by-Step Guide](#step-by-step-guide) + * [Definition](#definition) + * [Details in Tasks List View](#details-in-tasks-list-view) + * [Offline Behavior](#offline-behavior) @@ -100,7 +100,7 @@ To explore this concept further, refer to the [Data Ownership in a Distributed S be sure that the target database is as well. ![Encrypted Logo](./assets/encrypted-logo.png) 3. **Define External Replication Task in the Source Database** - Learn more about [defining the task](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition) in the dedicated section. + Learn more about [defining the task](#definition) in the dedicated section. * **Optional Parameters** - Task Name - Delay Time @@ -165,7 +165,7 @@ f. Click **External Replication** to access the following interface. You can set multiple connection strings to multiple different nodes on different machines so that if one is down, the other can keep the destination updated. - See [Offline Behavior - When the destination node is down](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#offline-behavior). + See [Offline Behavior - When the destination node is down](#offline-behavior). If you define only one node's connection string, RavenDB will wait until that node is online and will then update any missing information. diff --git a/docs/studio/database/tasks/ongoing-tasks/general-info.mdx b/docs/studio/database/tasks/ongoing-tasks/general-info.mdx index 943c00d190..1fbcba20ba 100644 --- a/docs/studio/database/tasks/ongoing-tasks/general-info.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/general-info.mdx @@ -30,11 +30,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; See [Ongoing tasks operations](../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx). * In this article: - * [The ongoing tasks](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks) - * [Creating a new task](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#creating-a-new-task) - * [Available task types](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#available-task-types) - * [The ongoing tasks list](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks-list) - * [Disabling tasks and tombstone cleanup](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#disabling-tasks-and-tombstone-cleanup) + * [The ongoing tasks](#the-ongoing-tasks) + * [Creating a new task](#creating-a-new-task) + * [Available task types](#available-task-types) + * [The ongoing tasks list](#the-ongoing-tasks-list) + * [Disabling tasks and tombstone cleanup](#disabling-tasks-and-tombstone-cleanup) diff --git a/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx b/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx index 4fcc0b0112..75b16d6ba6 100644 --- a/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx @@ -26,22 +26,22 @@ and Sink replication tasks. * The connection is always initiated by the Sink, but you can choose whether to replicate data from *Hub to Sink* and/or from *Sink to Hub*. -* Replication can be [filtered](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) +* Replication can be [filtered](#filtered-replication) by both the Hub and the Sink, and for both *incoming* and *outgoing* documents, using wildcards and document IDs, to select the documents that would be replicated. -* The connection between Hub and Sink tasks is [secure](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#accesses-and-certificates), +* The connection between Hub and Sink tasks is [secure](#accesses-and-certificates), requiring a secure RavenDB cluster setup. A secure cluster can be raised using RavenDB's [setup wizard](../../../../../start/installation/setup-wizard/choose-security-option.mdx). * In this page: * [What is Hub/Sink Replication for?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-is-hub/sink-replication-for?) * [What is and is not replicated?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-is-and-is-not-replicated?) - * [Accesses and Certificates](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#accesses-and-certificates) - * [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) + * [Accesses and Certificates](#accesses-and-certificates) + * [Filtered Replication](#filtered-replication) * [What does the replication include?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-does-the-replication-include?) - * [Failover](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#failover) - * [Backward Compatibility](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#backward-compatibility) + * [Failover](#failover) + * [Backward Compatibility](#backward-compatibility) ## What is Hub/Sink Replication for? diff --git a/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx b/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx index 1935b6a716..70b05f16f8 100644 --- a/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx @@ -27,12 +27,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) to choose which documents are to be replicated * In this page: - * [Create an Ongoing Replication Hub Task](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#create-an-ongoing-replication-hub-task) - * [Hub Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#hub-configuration) - * [Access Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#access-configuration) - * [Viewing and Editing Existing Accesses](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#viewing-and-editing-existing-accesses) - * [Defining Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#defining-filtered-replication) - * [Ongoing Tasks View](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#ongoing-tasks-view) + * [Create an Ongoing Replication Hub Task](#create-an-ongoing-replication-hub-task) + * [Hub Configuration](#hub-configuration) + * [Access Configuration](#access-configuration) + * [Viewing and Editing Existing Accesses](#viewing-and-editing-existing-accesses) + * [Defining Filtered Replication](#defining-filtered-replication) + * [Ongoing Tasks View](#ongoing-tasks-view) ## Create an Ongoing Replication Hub Task diff --git a/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx b/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx index 0b82ba23b7..30238bb965 100644 --- a/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx @@ -27,12 +27,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) to choose which documents are to be replicated * In this page: - * [Create an Ongoing Replication Sink Task](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#create-an-ongoing-replication-sink-task) - * [Import Configuration From Hub](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#import-configuration-from-hub) - * [Sink Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#sink-configuration) - * [Access Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#access-configuration) - * [Definining Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#defining-filtered-replication) - * [Ongoing Tasks View](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#ongoing-tasks-view) + * [Create an Ongoing Replication Sink Task](#create-an-ongoing-replication-sink-task) + * [Import Configuration From Hub](#import-configuration-from-hub) + * [Sink Configuration](#sink-configuration) + * [Access Configuration](#access-configuration) + * [Definining Filtered Replication](#defining-filtered-replication) + * [Ongoing Tasks View](#ongoing-tasks-view) ## Create an Ongoing Replication Sink Task @@ -113,7 +113,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. **Certificate Source** Choose a source for the Sink certificate. - ([Import Hub configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#import-configuration-from-hub) + ([Import Hub configuration](#import-configuration-from-hub) to save yourself the need to redefine these details.) * **Provide your own certificate** Use this option to import a certificate of your own, e.g. one diff --git a/docs/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx b/docs/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx index 8ff472f54e..e90c2c91c7 100644 --- a/docs/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx @@ -33,17 +33,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx) how to define a Kafka ETL task using code. * In this article: - * [Setup workflow](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#setup-workflow) - * [Creating a Kafka ETL task](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#creating-a-kafka-etl-task) - * [Open Kafka ETL Task View](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#open-kafka-etl-task-view) - * [Define Kafka ETL Task](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#define-kafka-etl-task) - * [Use RavenDB Certificate](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#use-ravendb-certificate) - * [Options Per Topic](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#options-per-topic) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#edit-transformation-script) - * [Prerequisites for a secure Kafka server](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#prerequisites-for-a-secure-kafka-server) - * [What needs to be granted](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#what-needs-to-be-granted) - * [Reading the transactional IDs from Studio](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#reading-the-transactional-ids-from-studio) - * [Entering the grants on the Kafka cluster](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#entering-the-grants-on-the-kafka-cluster) + * [Setup workflow](#setup-workflow) + * [Creating a Kafka ETL task](#creating-a-kafka-etl-task) + * [Open Kafka ETL Task View](#open-kafka-etl-task-view) + * [Define Kafka ETL Task](#define-kafka-etl-task) + * [Use RavenDB Certificate](#use-ravendb-certificate) + * [Options Per Topic](#options-per-topic) + * [Edit Transformation Script](#edit-transformation-script) + * [Prerequisites for a secure Kafka server](#prerequisites-for-a-secure-kafka-server) + * [What needs to be granted](#what-needs-to-be-granted) + * [Reading the transactional IDs from Studio](#reading-the-transactional-ids-from-studio) + * [Entering the grants on the Kafka cluster](#entering-the-grants-on-the-kafka-cluster) @@ -137,7 +137,7 @@ extension that permits acting as a TLS client) or a separate certificate that RavenDB issues from the server certificate's key pair. Enabling **Use RavenDB Certificate** replaces the security options you would -otherwise enter via [Add new connection option](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#define-kafka-etl-task). +otherwise enter via [Add new connection option](#define-kafka-etl-task). diff --git a/docs/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx b/docs/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx index 219475c3c3..113356c8f0 100644 --- a/docs/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx @@ -32,10 +32,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn how to define a Kafka queue sink using the API [here](../../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#add-a-database-task) - * [Define a Kafka Sink Task](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-a-kafka-sink-task) - * [Define and Test Task Scripts](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-and-test-task-scripts) - * [Task Statistics](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#task-statistics) + * [Add a Database Task](#add-a-database-task) + * [Define a Kafka Sink Task](#define-a-kafka-sink-task) + * [Define and Test Task Scripts](#define-and-test-task-scripts) + * [Task Statistics](#task-statistics) ## Add a Database Task diff --git a/docs/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx b/docs/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx index e89527be0f..dd91ab9c1c 100644 --- a/docs/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx @@ -30,14 +30,14 @@ learn more about OLAP ETL tasks, and how to create one using the client API, see [Ongoing Tasks: OLAP ETL](../../../../server/ongoing-tasks/etl/olap.mdx). * In this page: - * [Navigate to the OLAP ETL View](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#navigate-to-the-olap-etl-view) - * [Define an OLAP ETL Task](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#define-an-olap-etl-task) - * [Custom Partition Value](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#custom-partition-value) - * [Run Frequency](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#run-frequency) - * [OLAP Connection String](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#olap-connection-string) - * [OLAP ETL Destinations](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#olap-etl-destinations) - * [Transform Scripts](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#transform-scripts) - * [Override ID column](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#override-id-column) + * [Navigate to the OLAP ETL View](#navigate-to-the-olap-etl-view) + * [Define an OLAP ETL Task](#define-an-olap-etl-task) + * [Custom Partition Value](#custom-partition-value) + * [Run Frequency](#run-frequency) + * [OLAP Connection String](#olap-connection-string) + * [OLAP ETL Destinations](#olap-etl-destinations) + * [Transform Scripts](#transform-scripts) + * [Override ID column](#override-id-column) ## Create an OLAP ETL Task @@ -67,7 +67,7 @@ To begin creating your OLAP ETL task: * A custom partition can be defined to differentiate parquet file locations when using the same connection string in multiple OLAP ETL tasks. -* The custom partition **name** is defined inside the [transformation scripts](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#transform-scripts). +* The custom partition **name** is defined inside the [transformation scripts](#transform-scripts). * The custom partition **value** is defined in the input box above. * The custom partition value is referenced in the transform script as `$customPartitionValue`. @@ -155,7 +155,7 @@ aren't specified in the script: * `_id` Contains the source document ID. The default name used for this column is `_id`. You can override this name in the task definition - see more - [below](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#override-id-column). + [below](#override-id-column). * `_lastModifiedTime` The value of the `last-modified` field in a document's metadata. Represented in unix time. diff --git a/docs/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx b/docs/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx index 751fe8a3a0..4e4dcbd290 100644 --- a/docs/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx @@ -30,10 +30,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx) how to define a RabbitMQ ETL task using code. * In this page: - * [Open RabbitMQ ETL Task View](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#open-rabbitmq-etl-task-view) - * [Define RabbitMQ ETL Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#define-rabbitmq-etl-task) - * [Options Per Exchange](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#options-per-exchange) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#edit-transformation-script) + * [Open RabbitMQ ETL Task View](#open-rabbitmq-etl-task-view) + * [Define RabbitMQ ETL Task](#define-rabbitmq-etl-task) + * [Options Per Exchange](#options-per-exchange) + * [Edit Transformation Script](#edit-transformation-script) ## Open RabbitMQ ETL Task View diff --git a/docs/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx b/docs/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx index ead5030933..cf019938f1 100644 --- a/docs/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx @@ -34,10 +34,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn how to define a RabbitMQ queue sink using the API [here](../../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#add-a-database-task) - * [Define a RabbitMQ Sink Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-a-rabbitmq-sink-task) - * [Define and Test Task Scripts](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-and-test-task-scripts) - * [Task Statistics](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#task-statistics) + * [Add a Database Task](#add-a-database-task) + * [Define a RabbitMQ Sink Task](#define-a-rabbitmq-sink-task) + * [Define and Test Task Scripts](#define-and-test-task-scripts) + * [Task Statistics](#task-statistics) ## Add a Database Task diff --git a/docs/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx b/docs/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx index d025e6cc76..88e3156bc8 100644 --- a/docs/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx @@ -24,19 +24,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more about the RavenDB ETL task options in [Ongoing Tasks: RavenDB ETL](../../../../server/ongoing-tasks/etl/raven.mdx). * RavenDB ETL is different from External Replication, - see [RavenDB ETL task -vs- External Replication task](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task--vs--external-replication-task) + see [RavenDB ETL task -vs- External Replication task](#ravendb-etl-task--vs--external-replication-task) * On secure servers, the destination cluster must trust the source, - see [Passing certificate between secure clusters](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#passing-certificate-between-secure-clusters). + see [Passing certificate between secure clusters](#passing-certificate-between-secure-clusters). * In this article: - * [RavenDB ETL task - definition](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-definition) - * [RavenDB ETL task - transform scripts](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-transform-scripts) - * [RavenDB ETL task - test script](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-test-script) - * [RavenDB ETL task - details in tasks list view](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-details-in-tasks-list-view) - * [RavenDB ETL task - offline behavior](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-offline-behavior) - * [RavenDB ETL task -vs- External Replication task](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-vs-external-replication-task) - * [Passing certificate between secure clusters](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#passing-certificate-between-secure-clusters) + * [RavenDB ETL task - definition](#ravendb-etl-task-definition) + * [RavenDB ETL task - transform scripts](#ravendb-etl-task-transform-scripts) + * [RavenDB ETL task - test script](#ravendb-etl-task-test-script) + * [RavenDB ETL task - details in tasks list view](#ravendb-etl-task-details-in-tasks-list-view) + * [RavenDB ETL task - offline behavior](#ravendb-etl-task-offline-behavior) + * [RavenDB ETL task -vs- External Replication task](#ravendb-etl-task-vs-external-replication-task) + * [Passing certificate between secure clusters](#passing-certificate-between-secure-clusters) diff --git a/docs/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx b/docs/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx index 27ad83e9b0..e371d02288 100644 --- a/docs/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more [here](../../../../server/ongoing-tasks/etl/snowflake.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx#add-a-database-task) - * [Define a Snowflake ETL Task](../../../../studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx#define-a-snowflake-etl-task) - * [Add or Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx#add-or-edit-transformation-script) + * [Add a Database Task](#add-a-database-task) + * [Define a Snowflake ETL Task](#define-a-snowflake-etl-task) + * [Add or Edit Transformation Script](#add-or-edit-transformation-script) ## Add a Database Task diff --git a/docs/studio/database/tasks/ongoing-tasks/subscription-task.mdx b/docs/studio/database/tasks/ongoing-tasks/subscription-task.mdx index 5320ef6f99..43cbd628d3 100644 --- a/docs/studio/database/tasks/ongoing-tasks/subscription-task.mdx +++ b/docs/studio/database/tasks/ongoing-tasks/subscription-task.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page explains how to create a subscription task on the server side using the Studio. * In this page: - * [Subscription Task Definition](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#subscription-task-definition) - * [Testing Subscriptions](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#testing) - * [Details in Task List View](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#details-in-task-list-view) + * [Subscription Task Definition](#subscription-task-definition) + * [Testing Subscriptions](#testing) + * [Details in Task List View](#details-in-task-list-view) ## Subscription Task Definition diff --git a/docs/studio/overview.mdx b/docs/studio/overview.mdx index afd5ed4a6c..602a696b89 100644 --- a/docs/studio/overview.mdx +++ b/docs/studio/overview.mdx @@ -37,14 +37,14 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Studio includes an **AI assistant** that can help you navigate the interface and leverage its capabilities. [Learn more.](../studio/ai-assistant.mdx) * In this article: - * [Accessing Studio after setup](../studio/overview.mdx#accessing-studio-after-setup) - * [Connecting to an Unsecure server](../studio/overview.mdx#connecting-to-an-unsecure-server) - * [Connecting to a Secure server](../studio/overview.mdx#connecting-to-a-secure-server) - * [Where should the certificate be located](../studio/overview.mdx#where-should-the-certificate-be-located) - * [The cluster dashboard](../studio/overview.mdx#the-cluster-dashboard) - * [Manage your server](../studio/overview.mdx#manage-your-server) - * [Manage your databases](../studio/overview.mdx#manage-your-databases) - * [Header and footer areas](../studio/overview.mdx#header-and-footer-areas) + * [Accessing Studio after setup](#accessing-studio-after-setup) + * [Connecting to an Unsecure server](#connecting-to-an-unsecure-server) + * [Connecting to a Secure server](#connecting-to-a-secure-server) + * [Where should the certificate be located](#where-should-the-certificate-be-located) + * [The cluster dashboard](#the-cluster-dashboard) + * [Manage your server](#manage-your-server) + * [Manage your databases](#manage-your-databases) + * [Header and footer areas](#header-and-footer-areas) diff --git a/docs/studio/server/certificates/read-only-access-level.mdx b/docs/studio/server/certificates/read-only-access-level.mdx index 3ac8ff8d93..a080d0345e 100644 --- a/docs/studio/server/certificates/read-only-access-level.mdx +++ b/docs/studio/server/certificates/read-only-access-level.mdx @@ -33,7 +33,7 @@ that make it clear to the user what they can and can't do. * In this page: - * [Create a Client Certificate with Read Only Access](../../../studio/server/certificates/read-only-access-level.mdx#create-a-client-certificate-with-read-only-access) + * [Create a Client Certificate with Read Only Access](#create-a-client-certificate-with-read-only-access) * [The Studio in "Read Only" Mode](../../../studio/server/certificates/read-only-access-level.mdx#the-studio-in-"read-only"-mode) diff --git a/docs/studio/server/certificates/server-management-certificates-view.mdx b/docs/studio/server/certificates/server-management-certificates-view.mdx index ad788d943f..29ce4aa53b 100644 --- a/docs/studio/server/certificates/server-management-certificates-view.mdx +++ b/docs/studio/server/certificates/server-management-certificates-view.mdx @@ -18,13 +18,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use the **Certificates** view to create, customize, import and export certificates. * In this article: - * [The certificates view](../../../studio/server/certificates/server-management-certificates-view.mdx#the-certificates-view) - * [View and edit certificates](../../../studio/server/certificates/server-management-certificates-view.mdx#view-and-edit-certificates) - * [Generate a client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#generate-a-client-certificate) - * [Enable communication between secure servers](../../../studio/server/certificates/server-management-certificates-view.mdx#enable-communication-between-secure-servers) - * [Upload an existing client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate) - * [Export server certificates](../../../studio/server/certificates/server-management-certificates-view.mdx#export-server-certificates) - * [Certificate collections](../../../studio/server/certificates/server-management-certificates-view.mdx#certificate-collections) + * [The certificates view](#the-certificates-view) + * [View and edit certificates](#view-and-edit-certificates) + * [Generate a client certificate](#generate-a-client-certificate) + * [Enable communication between secure servers](#enable-communication-between-secure-servers) + * [Upload an existing client certificate](#upload-an-existing-client-certificate) + * [Export server certificates](#export-server-certificates) + * [Certificate collections](#certificate-collections) @@ -167,7 +167,7 @@ While uploading the client certificate you can modify its settings. ![Modify uploaded certificate settings](./assets/upload-settings.png) -See the [Generate a client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#generate-a-client-certificate) section to learn about the available settings. +See the [Generate a client certificate](#generate-a-client-certificate) section to learn about the available settings. ## Export server certificates diff --git a/docs/studio/server/client-configuration.mdx b/docs/studio/server/client-configuration.mdx index b64c6cce68..a096507c88 100644 --- a/docs/studio/server/client-configuration.mdx +++ b/docs/studio/server/client-configuration.mdx @@ -33,7 +33,7 @@ import Panel from '@site/src/components/Panel'; see: [Client configuration (for database)](../../studio/database/settings/client-configuration-per-database.mdx) * In this article: - * [Set the client configuration (server-wide)](../../studio/server/client-configuration.mdx#set-the-client-configuration-server-wide) + * [Set the client configuration (server-wide)](#set-the-client-configuration-server-wide) diff --git a/docs/studio/server/debug/admin-js-console.mdx b/docs/studio/server/debug/admin-js-console.mdx index 2f103c0368..d6697f5c6e 100644 --- a/docs/studio/server/debug/admin-js-console.mdx +++ b/docs/studio/server/debug/admin-js-console.mdx @@ -29,9 +29,9 @@ Incorrect usage may crash the server, corrupt data, or cause irreversible change --- * In this article: - * [Admin JS Console view](../../../studio/server/debug/admin-js-console.mdx#admin-js-console-view) - * [Context objects in scripts](../../../studio/server/debug/admin-js-console.mdx#context-objects-in-scripts) - * [Console methods](../../../studio/server/debug/admin-js-console.mdx#console-methods) + * [Admin JS Console view](#admin-js-console-view) + * [Context objects in scripts](#context-objects-in-scripts) + * [Console methods](#console-methods) diff --git a/docs/studio/server/debug/admin-logs.mdx b/docs/studio/server/debug/admin-logs.mdx index 651d2d184a..5e03e0f50b 100644 --- a/docs/studio/server/debug/admin-logs.mdx +++ b/docs/studio/server/debug/admin-logs.mdx @@ -30,11 +30,11 @@ import Panel from '@site/src/components/Panel'; originating resource, logger, or any other criteria. * In this article: - * [Admin Logs view](../../../studio/server/debug/admin-logs.mdx#admin-logs-view) - * [Logs on this view](../../../studio/server/debug/admin-logs.mdx#logs-on-this-view) - * [Logs on disk](../../../studio/server/debug/admin-logs.mdx#logs-on-disk) - * [Log stream](../../../studio/server/debug/admin-logs.mdx#log-stream) - * [Syntax for filter conditions](../../../studio/server/debug/admin-logs.mdx#syntax-for-filter-conditions) + * [Admin Logs view](#admin-logs-view) + * [Logs on this view](#logs-on-this-view) + * [Logs on disk](#logs-on-disk) + * [Log stream](#log-stream) + * [Syntax for filter conditions](#syntax-for-filter-conditions) @@ -46,13 +46,13 @@ From the debug menu, click **Admin Logs**. ![Click to open the Admin Logs view](./assets/admin-logs_admin-logs-menu.png) ![Admin Logs view](./assets/admin-logs_admin-logs-view.png) -1. [Logs on this view](../../../studio/server/debug/admin-logs.mdx#logs-on-this-view) +1. [Logs on this view](#logs-on-this-view) Use this section to adjust how the live log stream is displayed. You can filter the streamed data and export it in JSON format. -2. [Logs on disk](../../../studio/server/debug/admin-logs.mdx#logs-on-disk) +2. [Logs on disk](#logs-on-disk) Use this section to customize RavenDB's logging to your local storage. Filters can be applied here too, and you can download selected portions of your logs. -3. [Log stream](../../../studio/server/debug/admin-logs.mdx#log-stream) +3. [Log stream](#log-stream) This section shows the live stream of RavenDB's logs as they are generated. You can search within the stream and expand individual log entries for more detail. @@ -62,12 +62,12 @@ From the debug menu, click **Admin Logs**. **Use these controls to**: -* Adjust [monitor controls](../../../studio/server/debug/admin-logs.mdx#monitor-controls). -* Set the [minimum logging level](../../../studio/server/debug/admin-logs.mdx#set-displayed-logs-minimum-level) +* Adjust [monitor controls](#monitor-controls). +* Set the [minimum logging level](#set-displayed-logs-minimum-level) from which log entries are displayed. -* Create [additional filters](../../../studio/server/debug/admin-logs.mdx#set-displayed-logs-filters) +* Create [additional filters](#set-displayed-logs-filters) to select the precise data that you want to view. -* [Export the displayed log data](../../../studio/server/debug/admin-logs.mdx#export-displayed-logs-data) +* [Export the displayed log data](#export-displayed-logs-data) to files. ![Logs on this view](./assets/admin-logs_logs-on-this-view.png) @@ -133,11 +133,11 @@ From the debug menu, click **Admin Logs**. **Use these controls to**: -* Set the [minimum logging level](../../../studio/server/debug/admin-logs.mdx#define-logs-on-disk-minimum-level) +* Set the [minimum logging level](#define-logs-on-disk-minimum-level) from which log entries are stored in log files on the server disk. -* Create [additional filters](../../../studio/server/debug/admin-logs.mdx#define-logs-on-disk-filters) +* Create [additional filters](#define-logs-on-disk-filters) to select the precise data that you want to log. -* [Download existing log files](../../../studio/server/debug/admin-logs.mdx#download-log-files) +* [Download existing log files](#download-log-files) from the server disk by a date range of your choice. ![Logs on disk](./assets/admin-logs_logs-on-disk.png) @@ -218,7 +218,7 @@ From the debug menu, click **Admin Logs**. -* This area displays live log entries as they are generated by the server, filtered by the [Logs on this view](../../../studio/server/debug/admin-logs.mdx#logs-on-this-view) settings. +* This area displays live log entries as they are generated by the server, filtered by the [Logs on this view](#logs-on-this-view) settings. You can search and expand individual entries for more details. ![Log stream](./assets/admin-logs_log-stream.png) diff --git a/docs/studio/server/debug/advanced/cluster-observer.mdx b/docs/studio/server/debug/advanced/cluster-observer.mdx index 1bf0c92588..79b3575383 100644 --- a/docs/studio/server/debug/advanced/cluster-observer.mdx +++ b/docs/studio/server/debug/advanced/cluster-observer.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; If there is no Leader, no Database Group Topology decisions can be made. * In this page: - * [The Observer Log](../../../../studio/server/debug/advanced/cluster-observer.mdx#the-observer-log) - * [Observer Log Data](../../../../studio/server/debug/advanced/cluster-observer.mdx#observer-log-data) - * [States Flow](../../../../studio/server/debug/advanced/cluster-observer.mdx#states-flow) + * [The Observer Log](#the-observer-log) + * [Observer Log Data](#observer-log-data) + * [States Flow](#states-flow) diff --git a/docs/studio/server/manage-server.mdx b/docs/studio/server/manage-server.mdx index 6ec82fd0fb..c2f884bf25 100644 --- a/docs/studio/server/manage-server.mdx +++ b/docs/studio/server/manage-server.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use the **Manage Server** menu to access your server's configuration and debugging options. * In this page: - * [Manage Server menu](../../studio/server/manage-server.mdx#manage-server-menu) - * [Configuration options](../../studio/server/manage-server.mdx#manage-server-configuration-options) - * [Debug options](../../studio/server/manage-server.mdx#debug-debugging-and-statistics-options) + * [Manage Server menu](#manage-server-menu) + * [Configuration options](#manage-server-configuration-options) + * [Debug options](#debug-debugging-and-statistics-options) ## Manage Server menu diff --git a/docs/studio/server/server-settings.mdx b/docs/studio/server/server-settings.mdx index cf16d3904c..e3206f0943 100644 --- a/docs/studio/server/server-settings.mdx +++ b/docs/studio/server/server-settings.mdx @@ -25,7 +25,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings.mdx) view. * In this page: - * [Server Settings View](../../studio/server/server-settings.mdx#server-settings-view) + * [Server Settings View](#server-settings-view) ## Server Settings View diff --git a/docs/users-issues/recovering-from-voron-errors.mdx b/docs/users-issues/recovering-from-voron-errors.mdx index f9acd3aa5e..17e5d2dae4 100644 --- a/docs/users-issues/recovering-from-voron-errors.mdx +++ b/docs/users-issues/recovering-from-voron-errors.mdx @@ -29,7 +29,7 @@ If such errors happen, they need to be reported as soon as possible to [RavenDB * Such exceptions are caused by the corruption of a Voron _data file_, which could occur due to a few reasons: * Hardware failure of hard-drive or memory - * In compliance‏ with RavenDB [hardware and OS requirements](../users-issues/recovering-from-voron-errors.mdx#ravendb-hardware-and-os-requirements) + * In compliance‏ with RavenDB [hardware and OS requirements](#ravendb-hardware-and-os-requirements) * Critical bug in `Voron` diff --git a/versioned_docs/version-6.2/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx b/versioned_docs/version-6.2/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx index 5256ae139c..5e6a74e399 100644 --- a/versioned_docs/version-6.2/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx @@ -9,23 +9,23 @@ import ContentFrame from "@site/src/components/ContentFrame"; * `BulkInsert` is useful when inserting a large quantity of data from the client to the server. * It is an optimized time-saving approach with a few - [limitations](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#limitations) + [limitations](#limitations) like the possibility that interruptions will occur during the operation. * In this page: - * [Quick example](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#quick-example) - * [`BulkInsertOperation`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoperation) - * [Methods](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#methods) - * [Limitations](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#limitations) - * [Example](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#example) - * [`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) - * [CompressionLevel](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#compressionlevel) - * [SkipOverwriteIfUnchanged](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#skipoverwriteifunchanged) - * [Track progress with OnProgress](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#track-progress-with-onprogress) - * [Syntax](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#syntax) - * [Method signatures](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#method-signatures) - * [Event signature](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#event-signature) - * [Classes](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#classes) + * [Quick example](#quick-example) + * [`BulkInsertOperation`](#bulkinsertoperation) + * [Methods](#methods) + * [Limitations](#limitations) + * [Example](#example) + * [`BulkInsertOptions`](#bulkinsertoptions) + * [CompressionLevel](#compressionlevel) + * [SkipOverwriteIfUnchanged](#skipoverwriteifunchanged) + * [Track progress with OnProgress](#track-progress-with-onprogress) + * [Syntax](#syntax) + * [Method signatures](#method-signatures) + * [Event signature](#event-signature) + * [Classes](#classes) @@ -48,7 +48,7 @@ using (BulkInsertOperation bulkInsert = store.BulkInsert())
For the full set of `BulkInsert` overloads and their parameters, see the -[Syntax](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#syntax) +[Syntax](#syntax) section at the end of this page. @@ -89,7 +89,7 @@ The following methods can be used when creating a bulk insert. cause some of your data not to persist on the server yet. * If the operation was interrupted and you choose to re-insert the whole dataset in a new operation, you can set - [SkipOverwriteIfUnchanged](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#skipoverwriteifunchanged) + [SkipOverwriteIfUnchanged](#skipoverwriteifunchanged) as `true` so the operation will overwrite existing documents only if they changed since the last insertion. * **If you need full transactionality**, using a @@ -217,7 +217,7 @@ so far - subscribe to the `OnProgress` event. The bulk insert delivers a progress snapshot to your handler each time the server reports new progress, with counters such as `DocumentsProcessed`, `BatchCount`, and the ID of the document processed most recently (`LastProcessedId`). -See [Classes](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#classes) +See [Classes](#classes) for the full property list. * Updates arrive asynchronously over the @@ -301,7 +301,7 @@ using (var bulkInsert = store.BulkInsert()) Opens a bulk insert against the given database with a -[`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) +[`BulkInsertOptions`](#bulkinsertoptions) instance to configure compression and overwrite behavior. ```csharp @@ -330,7 +330,7 @@ using (var bulkInsert = store.BulkInsert("Northwind", new BulkInsertOptions | Parameter | Type | Description | |-----------|------|-------------| | **database** | `string` | The name of the database to perform the bulk operation on.
If `null`, the `DocumentStore.Database` is used. | -| **options** | `BulkInsertOptions` | [Options](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) to configure BulkInsert. | +| **options** | `BulkInsertOptions` | [Options](#bulkinsertoptions) to configure BulkInsert. | | **token** | `CancellationToken` | Cancellation token used to halt the worker operation. | | Return value | | @@ -341,7 +341,7 @@ using (var bulkInsert = store.BulkInsert("Northwind", new BulkInsertOptions Opens a bulk insert against the document store's default database with a -[`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) +[`BulkInsertOptions`](#bulkinsertoptions) instance to configure compression and overwrite behavior. ```csharp @@ -368,7 +368,7 @@ using (var bulkInsert = store.BulkInsert(new BulkInsertOptions | Parameter | Type | Description | |-----------|------|-------------| -| **options** | `BulkInsertOptions` | [Options](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) to configure BulkInsert. | +| **options** | `BulkInsertOptions` | [Options](#bulkinsertoptions) to configure BulkInsert. | | **token** | `CancellationToken` | Cancellation token used to halt the worker operation. | | Return value | | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx index e9fe158519..df88cee222 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to counter changes: -- [ForCounter](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounter) -- [ForCounterOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounterofdocument) -- [ForCountersOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcountersofdocument) -- [ForAllCounters](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forallcounters) +- [ForCounter](#forcounter) +- [ForCounterOfDocument](#forcounterofdocument) +- [ForCountersOfDocument](#forcountersofdocument) +- [ForAllCounters](#forallcounters) ## ForCounter @@ -29,7 +29,7 @@ Counter changes can be observed using `ForCounter` method. This will subscribe c | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -74,7 +74,7 @@ Specific counter changes of a given document can be observed using `ForCounterOf | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -118,7 +118,7 @@ Counter changes of a specified document can be observed using `ForCountersOfDocu | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -158,7 +158,7 @@ Changes for all counters can be observed using `ForAllCounters` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -187,7 +187,7 @@ Changes for all counters can be observed using `ForAllCounters` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [CounterChangeTypes](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchangetypes) | Counter change type enum | +| **Type** | [CounterChangeTypes](#counterchangetypes) | Counter change type enum | | **Name** | string | Counter name | | **Value** | long | Counter value after the change | | **DocumentId** | string | Counter document identifier | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx index 87d72bb4df..9bf2858eda 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to counter changes: -- [ForCounter](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounter) -- [ForCounterOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounterofdocument) -- [ForCountersOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcountersofdocument) -- [ForAllCounters](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forallcounters) +- [ForCounter](#forcounter) +- [ForCounterOfDocument](#forcounterofdocument) +- [ForCountersOfDocument](#forcountersofdocument) +- [ForAllCounters](#forallcounters) ## ForCounter @@ -29,7 +29,7 @@ Counter changes can be observed using `forCounter` method. This will subscribe c | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -71,7 +71,7 @@ Specific counter changes of a given document can be observed using `forCounterOf | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -112,7 +112,7 @@ Counter changes of a specified document can be observed using `forCountersOfDocu | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -149,7 +149,7 @@ Changes for all counters can be observed using `forAllCounters` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -175,7 +175,7 @@ Changes for all counters can be observed using `forAllCounters` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [CounterChangeTypes](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchangetypes) | Counter change type enum | +| **Type** | [CounterChangeTypes](#counterchangetypes) | Counter change type enum | | **Name** | String | Counter name | | **Value** | Long | Counter value after the change | | **DocumentId** | String | Counter document identifier | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx index 684d3c9531..52cb7822f0 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [ForDocument](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [ForDocumentsInCollection](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [ForDocumentsStartingWith](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [ForAllDocuments](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [ForDocument](#fordocument) +- [ForDocumentsInCollection](#fordocumentsincollection) +- [ForDocumentsStartingWith](#fordocumentsstartingwith) +- [ForAllDocuments](#foralldocuments) ## ForDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `ForDocument` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | ### Example @@ -78,7 +78,7 @@ IChangesObservable ForDocumentsInCollection(); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with `TEntity` type uses `Conventions.GetCollectionName` to get collection name. @@ -130,7 +130,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -161,7 +161,7 @@ To observe all document changes use `ForAllDocuments` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -181,7 +181,7 @@ To observe all document changes use `ForAllDocuments` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **Type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **Id** | string | Document identifier | | **CollectionName** | string | Document's collection name | | **TypeName** | string | Type name | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx index 2278707899..170562433b 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [forDocument](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [forDocumentsInCollection](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [forDocumentsStartingWith](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [forAllDocuments](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [forDocument](#fordocument) +- [forDocumentsInCollection](#fordocumentsincollection) +- [forDocumentsStartingWith](#fordocumentsstartingwith) +- [forAllDocuments](#foralldocuments) ## forDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `forDocument` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | ### Example @@ -74,7 +74,7 @@ IChangesObservable forDocumentsInCollection(Class clazz); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with `TEntity` type uses `conventions.GetCollectionName` to get collection name. @@ -130,7 +130,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -163,7 +163,7 @@ To observe all document changes use `forAllDocuments` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -185,7 +185,7 @@ To observe all document changes use `forAllDocuments` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **Type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **Id** | String | Document identifier | | **CollectionName** | String | Document's collection name | | **TypeName** | String | Type name | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx index adf60a21e6..c34b2e7e88 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [forDocument()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [forDocumentsInCollection()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [forDocumentsStartingWith()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [forAllDocuments()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [forDocument()](#fordocument) +- [forDocumentsInCollection()](#fordocumentsincollection) +- [forDocumentsStartingWith()](#fordocumentsstartingwith) +- [forAllDocuments()](#foralldocuments) ## forDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `forDocument()` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add listeners for events for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add listeners for events for given document. | ### Example @@ -75,7 +75,7 @@ store.changes().forDocumentsInCollection(clazz); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with entity type uses `conventions.getCollectionNameForType()` to get collection name. @@ -128,7 +128,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -160,7 +160,7 @@ To observe all document changes use `forAllDocuments()` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -180,7 +180,7 @@ To observe all document changes use `forAllDocuments()` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **id** | string | Document identifier | | **collectionName** | string | Document's collection name | | **typeName** | string | Type name | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx index 59857984a7..8943990d0a 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [ForIndex](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [ForAllIndexes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [ForIndex](#forindex) +- [ForAllIndexes](#forallindexes) ## ForIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `ForIndex` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -93,7 +93,7 @@ Index changes for all indexex can be observed using `ForAllIndexes` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -124,7 +124,7 @@ Index changes for all indexex can be observed using `ForAllIndexes` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **Type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **Name** | string | Index name | | **Etag** | long? | Index Etag | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx index 8d02c69f94..f87a9cc20c 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [forIndex](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [forAllIndexes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [forIndex](#forindex) +- [forAllIndexes](#forallindexes) ## forIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `forIndex` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -93,7 +93,7 @@ Index changes for all indexex can be observed using `forAllIndexes` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -126,7 +126,7 @@ Index changes for all indexex can be observed using `forAllIndexes` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **Type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **Name** | String | Index name | | **Etag** | Long | Index Etag | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx index a7076e0764..d8e371da0e 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [forIndex()](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [forAllIndexes()](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [forIndex()](#forindex) +- [forAllIndexes()](#forallindexes) ## forIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `forIndex()` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -91,7 +91,7 @@ Index changes for all indexex can be observed using `forAllIndexes()` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -122,7 +122,7 @@ Index changes for all indexex can be observed using `forAllIndexes()` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **name** | string | Index name | | **etag** | number | Index Etag | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx index 377fd6f871..f12b5e53ba 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [ForOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperationid) -- [ForAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [ForOperationId](#foroperationid) +- [ForAllOperations](#foralloperations) ## ForOperationId @@ -37,7 +37,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -89,7 +89,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax @@ -120,7 +120,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Name | Type | Description | | ------------- | ------------- | ----- | -| **State** | [OperationState](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationstate) | Operation state | +| **State** | [OperationState](#operationstate) | Operation state | | **OperationId** | long | Operation ID | @@ -131,9 +131,9 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Name | Type | Description | | ------------- | ------------- | ----- | -| **Result** | [IOperationResult](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationresult) | Operation result | +| **Result** | [IOperationResult](#operationresult) | Operation result | | **Progress** | IOperationProgress| Instance of IOperationProgress (json representation of the progress) | -| **Status** | [OperationStatus](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationstatus) | Operation status | +| **Status** | [OperationStatus](#operationstatus) | Operation status | ## OperationResult diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx index 5c10cb9f60..36533ee873 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [forOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperation) -- [forAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [forOperationId](#foroperation) +- [forAllOperations](#foralloperations) ## forOperation @@ -27,7 +27,7 @@ Operation changes for one operation can be observed using the `forOperationId` m | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -53,7 +53,7 @@ Operations changes for all Operations can be observed using the `forAllOperation | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx index ba5c3b0fa8..251ec63b6b 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [forOperationId()](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperation) -- [forAllOperations()](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [forOperationId()](#foroperation) +- [forAllOperations()](#foralloperations) ## forOperation @@ -27,7 +27,7 @@ Operation changes for one operation can be observed using the `forOperationId()` | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -51,7 +51,7 @@ Operations changes for all Operations can be observed using the `forAllOperation | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax diff --git a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx index f4349a81fd..f168df060e 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Track **all** time series * In this page: - * [ForTimeSeries](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#fortimeseries) - * [ForTimeSeriesOfDocument](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#fortimeseriesofdocument) - * [ForAllTimeSeries](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#foralltimeseries) + * [ForTimeSeries](#fortimeseries) + * [ForTimeSeriesOfDocument](#fortimeseriesofdocument) + * [ForAllTimeSeries](#foralltimeseries) ## ForTimeSeries @@ -40,7 +40,7 @@ using the `ForTimeSeries` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -91,7 +91,7 @@ Use this `ForTimeSeriesOfDocument` overload to track changes in a **specific tim | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -131,7 +131,7 @@ Use this `ForTimeSeriesOfDocument` overload to track changes in **any time serie | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -171,7 +171,7 @@ Subscribe to changes in **all time-series** using the `ForAllTimeSeries` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -200,7 +200,7 @@ Subscribe to changes in **all time-series** using the `ForAllTimeSeries` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [TimeSeriesChangeTypes](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschangetypes) | Time series change type enum | +| **Type** | [TimeSeriesChangeTypes](#timeserieschangetypes) | Time series change type enum | | **Name** | string | Time Series Name | | **DocumentId** | string | Time series Document Identifier | | **CollectionName** | string | Time series document Collection Name | diff --git a/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-csharp.mdx b/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-csharp.mdx index 240dac83d6..24a4523913 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-csharp.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [FAQ](../../../client-api/changes/what-is-changes-api.mdx#faq) - * [Changes API and Database Timeout](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-database-timeout) - * [Changes API and Method Overloads](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-method-overloads) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [FAQ](#faq) + * [Changes API and Database Timeout](#changes-api-and-database-timeout) + * [Changes API and Method Overloads](#changes-api-and-method-overloads) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API @@ -107,7 +107,7 @@ To receive notifications regarding server-side events, subscribe using one of th Track changes for a given index (by Index Name) * **For Operation Changes:** - Operation changes can be tracked only [on a specific node](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api). + Operation changes can be tracked only [on a specific node](#accessing-changes-api). - [ForAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) Track changes for all operation - [ForOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperationid) diff --git a/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-java.mdx b/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-java.mdx index df488dd95d..da3d724912 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-java.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-java.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [Note](../../../client-api/changes/what-is-changes-api.mdx#note) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [Note](#note) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API diff --git a/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-nodejs.mdx b/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-nodejs.mdx index 2dc3ced34c..9ed8b354e2 100644 --- a/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/changes/content/_what-is-changes-api-nodejs.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [FAQ](../../../client-api/changes/what-is-changes-api.mdx#faq) - * [Changes API and Database Timeout](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-database-timeout) - * [Changes API and Method Overloads](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-method-overloads) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [FAQ](#faq) + * [Changes API and Database Timeout](#changes-api-and-database-timeout) + * [Changes API and Method Overloads](#changes-api-and-method-overloads) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API diff --git a/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx b/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx index f3e863f000..d3a6f3d781 100644 --- a/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx b/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx index c3695729d3..1e50df5d81 100644 --- a/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx +++ b/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx b/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx index b8f38a0eb4..88a3625247 100644 --- a/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx b/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx index 99ed7fa9ca..da8a98e42d 100644 --- a/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction). * In this page: - * [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples) - * [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands) - * [Syntax](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#syntax) + * [Examples](#examples) + * [Available batch commands](#available-batch-commands) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx b/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx index 03c73468d1..b89367e859 100644 --- a/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction). * In this page: - * [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples) - * [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands) - * [Syntax](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#syntax) + * [Examples](#examples) + * [Available batch commands](#available-batch-commands) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/content/_overview-csharp.mdx b/versioned_docs/version-6.2/client-api/commands/content/_overview-csharp.mdx index 6c14ce14a6..08c9be0d42 100644 --- a/versioned_docs/version-6.2/client-api/commands/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/commands/content/_overview-csharp.mdx @@ -29,17 +29,17 @@ import CodeBlock from '@theme/CodeBlock'; * Commands are responsible for sending the appropriate request to the server using a `Request Executor`, and parsing the server's response. - * All commands can be executed using either the [Store's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-store) - or the [Session's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-session), + * All commands can be executed using either the [Store's _Request Executor_](#execute-command---using-the-store) + or the [Session's _Request Executor_](#execute-command---using-the-session), regardless of whether the command is session-related or not. * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Execute command - using the Store Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-store-request-executor) - * [Execute command - using the Session Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-session-request-executor) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Execute command - using the Store Request Executor](#execute-command---using-the-store-request-executor) + * [Execute command - using the Session Request Executor](#execute-command---using-the-session-request-executor) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Execute command - using the Store Request Executor diff --git a/versioned_docs/version-6.2/client-api/commands/content/_overview-java.mdx b/versioned_docs/version-6.2/client-api/commands/content/_overview-java.mdx index 6bd51f3993..729d2eae1f 100644 --- a/versioned_docs/version-6.2/client-api/commands/content/_overview-java.mdx +++ b/versioned_docs/version-6.2/client-api/commands/content/_overview-java.mdx @@ -35,9 +35,9 @@ import CodeBlock from '@theme/CodeBlock'; * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Examples](../../../client-api/commands/overview.mdx#examples) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Examples](#examples) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/client-api/commands/content/_overview-nodejs.mdx index 8e2fe72792..fa373316f5 100644 --- a/versioned_docs/version-6.2/client-api/commands/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/commands/content/_overview-nodejs.mdx @@ -29,17 +29,17 @@ import CodeBlock from '@theme/CodeBlock'; * Commands are responsible for sending the appropriate request to the server using a `Request Executor`, and parsing the server's response. - * All commands can be executed using either the [Store's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-store) - or the [Session's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-session), + * All commands can be executed using either the [Store's _Request Executor_](#execute-command---using-the-store) + or the [Session's _Request Executor_](#execute-command---using-the-session), regardless of whether the command is session-related or not. * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Execute command - using the Store Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-store-request-executor) - * [Execute command - using the Session Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-session-request-executor) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Execute command - using the Store Request Executor](#execute-command---using-the-store-request-executor) + * [Execute command - using the Session Request Executor](#execute-command---using-the-session-request-executor) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Execute command - using the Store Request Executor diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-csharp.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-csharp.mdx index 67720eb954..d8c463593b 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/delete.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-nodejs.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-nodejs.mdx index 6505dd457d..dd631d5d02 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/delete.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-php.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-php.mdx index 7ccc950619..dbc8c6cf39 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-php.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/delete.mdx#example) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-python.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-python.mdx index f440c8cf06..795d53ea6f 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-python.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_delete-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/delete.mdx#example) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-csharp.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-csharp.mdx index 0ef4a8e33d..e95aee9dcd 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-csharp.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents - by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents---by-id-prefix) - - [Get documents - with includes](../../../../client-api/commands/documents/get.mdx#get-documents---with-includes) - - [Syntax](../../../../client-api/commands/documents/get.mdx#syntax) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get metadata only](#get-metadata-only) + - [Get paged documents](#get-paged-documents) + - [Get documents - by ID prefix](#get-documents---by-id-prefix) + - [Get documents - with includes](#get-documents---with-includes) + - [Syntax](#syntax) ## Get single document diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-java.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-java.mdx index 9740299364..92110c1be6 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-java.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-java.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; There are a few methods that allow you to retrieve documents from a database: -- [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) -- [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) -- [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) -- [Get documents by starts with](../../../../client-api/commands/documents/get.mdx#get-by-starts-with) -- [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) +- [Get single document](#get-single-document) +- [Get multiple documents](#get-multiple-documents) +- [Get paged documents](#get-paged-documents) +- [Get documents by starts with](#get-by-starts-with) +- [Get metadata only](#get-metadata-only) ## Get single document diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-nodejs.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-nodejs.mdx index b4664b65fd..88be48bc31 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-nodejs.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents - by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents---by-id-prefix) - - [Get documents - with includes](../../../../client-api/commands/documents/get.mdx#get-documents---with-includes) - - [Syntax](../../../../client-api/commands/documents/get.mdx#syntax) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get metadata only](#get-metadata-only) + - [Get paged documents](#get-paged-documents) + - [Get documents - by ID prefix](#get-documents---by-id-prefix) + - [Get documents - with includes](#get-documents---with-includes) + - [Syntax](#syntax) ## Get single document diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-php.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-php.mdx index 35c5509bd3..4e98a2fa47 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-php.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-php.mdx @@ -8,10 +8,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetDocumentsCommand` to retrieve documents from the database. * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents-by-id-prefix) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get paged documents](#get-paged-documents) + - [Get documents by ID prefix](#get-documents-by-id-prefix) ## Get single document diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-python.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-python.mdx index 4b7f55b814..f8828fb244 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_get-python.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_get-python.mdx @@ -8,10 +8,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetDocumentsCommand` to retrieve documents from the database. * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents-by-id-prefix) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get paged documents](#get-paged-documents) + - [Get documents by ID prefix](#get-documents-by-id-prefix) ## Get single document diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-csharp.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-csharp.mdx index 48c6caf464..ee58b22224 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/put.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-nodejs.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-nodejs.mdx index 74edf1c2de..15695f8902 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/put.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-php.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-php.mdx index f7974c4eca..0d75d87db7 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-php.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/put.mdx#example) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-python.mdx b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-python.mdx index 64cf90a984..3935dd8f61 100644 --- a/versioned_docs/version-6.2/client-api/commands/documents/content/_put-python.mdx +++ b/versioned_docs/version-6.2/client-api/commands/documents/content/_put-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/put.mdx#example) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-6.2/client-api/configuration/content/_conventions-csharp.mdx b/versioned_docs/version-6.2/client-api/configuration/content/_conventions-csharp.mdx index 40a8dab6fe..b663af06c3 100644 --- a/versioned_docs/version-6.2/client-api/configuration/content/_conventions-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/content/_conventions-csharp.mdx @@ -8,58 +8,58 @@ import CodeBlock from '@theme/CodeBlock'; * **Conventions** in RavenDB are customizable settings that users can configure to tailor client behaviors according to their preferences. * In this article: - * [How to set conventions](../../../client-api/configuration/conventions.mdx#how-to-set-conventions) + * [How to set conventions](#how-to-set-conventions) * [Conventions:](../../../client-api/configuration/conventions.mdx#conventions:) - [AddIdFieldToDynamicObjects](../../../client-api/configuration/conventions.mdx#addidfieldtodynamicobjects) - [AggressiveCache.Duration](../../../client-api/configuration/conventions.mdx#aggressivecacheduration) - [AggressiveCache.Mode](../../../client-api/configuration/conventions.mdx#aggressivecachemode) - [AsyncDocumentIdGenerator](../../../client-api/configuration/conventions.mdx#asyncdocumentidgenerator) - [CreateHttpClient](../../../client-api/configuration/conventions.mdx#createhttpclient) - [DisableAtomicDocumentWritesInClusterWideTransaction](../../../client-api/configuration/conventions.mdx#disableatomicdocumentwritesinclusterwidetransaction) - [DisableTcpCompression](../../../client-api/configuration/conventions.mdx#disabletcpcompression) - [DisableTopologyCache](../../../client-api/configuration/conventions.mdx#disabletopologycache) - [DisableTopologyUpdates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) - [DisposeCertificate](../../../client-api/configuration/conventions.mdx#disposecertificate) - [FindClrType](../../../client-api/configuration/conventions.mdx#findclrtype) - [FindClrTypeName](../../../client-api/configuration/conventions.mdx#findclrtypename) - [FindClrTypeNameForDynamic](../../../client-api/configuration/conventions.mdx#findclrtypenamefordynamic) - [FindCollectionName](../../../client-api/configuration/conventions.mdx#findcollectionname) - [FindCollectionNameForDynamic](../../../client-api/configuration/conventions.mdx#findcollectionnamefordynamic) - [FindIdentityProperty](../../../client-api/configuration/conventions.mdx#findidentityproperty) - [FindIdentityPropertyNameFromCollectionName](../../../client-api/configuration/conventions.mdx#findidentitypropertynamefromcollectionname) - [FindProjectedPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findprojectedpropertynameforindex) - [FindPropertyNameForDynamicIndex](../../../client-api/configuration/conventions.mdx#findpropertynamefordynamicindex) - [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) - [FirstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) - [GlobalHttpClientTimeout](../../../client-api/configuration/conventions.mdx#globalhttpclienttimeout) - [HttpClientType](../../../client-api/configuration/conventions.mdx#httpclienttype) - [HttpPooledConnectionIdleTimeout](../../../client-api/configuration/conventions.mdx#httppooledconnectionidletimeout) - [HttpPooledConnectionLifetime](../../../client-api/configuration/conventions.mdx#httppooledconnectionlifetime) - [HttpVersion](../../../client-api/configuration/conventions.mdx#httpversion) - [IdentityPartsSeparator](../../../client-api/configuration/conventions.mdx#identitypartsseparator) - [LoadBalanceBehavior](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [LoadBalancerContextSeed](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [LoadBalancerPerSessionContextSelector](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [MaxHttpCacheSize](../../../client-api/configuration/conventions.mdx#maxhttpcachesize) - [MaxNumberOfRequestsPerSession](../../../client-api/configuration/conventions.mdx#maxnumberofrequestspersession) - [Modify serialization of property name](../../../client-api/configuration/conventions.mdx#modify-serialization-of-property-name) - [OperationStatusFetchMode](../../../client-api/configuration/conventions.mdx#operationstatusfetchmode) - [PreserveDocumentPropertiesNotFoundOnModel](../../../client-api/configuration/conventions.mdx#preservedocumentpropertiesnotfoundonmodel) - [ReadBalanceBehavior](../../../client-api/configuration/conventions.mdx#readbalancebehavior) - [RequestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout) - [ResolveTypeFromClrTypeName](../../../client-api/configuration/conventions.mdx#resolvetypefromclrtypename) - [SaveEnumsAsIntegers](../../../client-api/configuration/conventions.mdx#saveenumsasintegers) - [SecondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) - [SendApplicationIdentifier](../../../client-api/configuration/conventions.mdx#sendapplicationidentifier) - [ShouldIgnoreEntityChanges](../../../client-api/configuration/conventions.mdx#shouldignoreentitychanges) - [TopologyCacheLocation](../../../client-api/configuration/conventions.mdx#topologycachelocation) - [TransformTypeCollectionNameToDocumentIdPrefix](../../../client-api/configuration/conventions.mdx#transformtypecollectionnametodocumentidprefix) - [UseHttpCompression](../../../client-api/configuration/conventions.mdx#usehttpcompression) - [UseHttpDecompression](../../../client-api/configuration/conventions.mdx#usehttpdecompression) - [UseOptimisticConcurrency](../../../client-api/configuration/conventions.mdx#useoptimisticconcurrency) - [WaitForIndexesAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforindexesaftersavechangestimeout) - [WaitForNonStaleResultsTimeout](../../../client-api/configuration/conventions.mdx#waitfornonstaleresultstimeout) - [WaitForReplicationAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforreplicationaftersavechangestimeout) + [AddIdFieldToDynamicObjects](#addidfieldtodynamicobjects) + [AggressiveCache.Duration](#aggressivecacheduration) + [AggressiveCache.Mode](#aggressivecachemode) + [AsyncDocumentIdGenerator](#asyncdocumentidgenerator) + [CreateHttpClient](#createhttpclient) + [DisableAtomicDocumentWritesInClusterWideTransaction](#disableatomicdocumentwritesinclusterwidetransaction) + [DisableTcpCompression](#disabletcpcompression) + [DisableTopologyCache](#disabletopologycache) + [DisableTopologyUpdates](#disabletopologyupdates) + [DisposeCertificate](#disposecertificate) + [FindClrType](#findclrtype) + [FindClrTypeName](#findclrtypename) + [FindClrTypeNameForDynamic](#findclrtypenamefordynamic) + [FindCollectionName](#findcollectionname) + [FindCollectionNameForDynamic](#findcollectionnamefordynamic) + [FindIdentityProperty](#findidentityproperty) + [FindIdentityPropertyNameFromCollectionName](#findidentitypropertynamefromcollectionname) + [FindProjectedPropertyNameForIndex](#findprojectedpropertynameforindex) + [FindPropertyNameForDynamicIndex](#findpropertynamefordynamicindex) + [FindPropertyNameForIndex](#findpropertynameforindex) + [FirstBroadcastAttemptTimeout](#firstbroadcastattempttimeout) + [GlobalHttpClientTimeout](#globalhttpclienttimeout) + [HttpClientType](#httpclienttype) + [HttpPooledConnectionIdleTimeout](#httppooledconnectionidletimeout) + [HttpPooledConnectionLifetime](#httppooledconnectionlifetime) + [HttpVersion](#httpversion) + [IdentityPartsSeparator](#identitypartsseparator) + [LoadBalanceBehavior](#loadbalancebehavior) + [LoadBalancerContextSeed](#loadbalancebehavior) + [LoadBalancerPerSessionContextSelector](#loadbalancebehavior) + [MaxHttpCacheSize](#maxhttpcachesize) + [MaxNumberOfRequestsPerSession](#maxnumberofrequestspersession) + [Modify serialization of property name](#modify-serialization-of-property-name) + [OperationStatusFetchMode](#operationstatusfetchmode) + [PreserveDocumentPropertiesNotFoundOnModel](#preservedocumentpropertiesnotfoundonmodel) + [ReadBalanceBehavior](#readbalancebehavior) + [RequestTimeout](#requesttimeout) + [ResolveTypeFromClrTypeName](#resolvetypefromclrtypename) + [SaveEnumsAsIntegers](#saveenumsasintegers) + [SecondBroadcastAttemptTimeout](#secondbroadcastattempttimeout) + [SendApplicationIdentifier](#sendapplicationidentifier) + [ShouldIgnoreEntityChanges](#shouldignoreentitychanges) + [TopologyCacheLocation](#topologycachelocation) + [TransformTypeCollectionNameToDocumentIdPrefix](#transformtypecollectionnametodocumentidprefix) + [UseHttpCompression](#usehttpcompression) + [UseHttpDecompression](#usehttpdecompression) + [UseOptimisticConcurrency](#useoptimisticconcurrency) + [WaitForIndexesAfterSaveChangesTimeout](#waitforindexesaftersavechangestimeout) + [WaitForNonStaleResultsTimeout](#waitfornonstaleresultstimeout) + [WaitForReplicationAfterSaveChangesTimeout](#waitforreplicationaftersavechangestimeout) ## How to set conventions @@ -191,7 +191,7 @@ public Func> AsyncDocumentIdGenerator \{ get; set; * For example, implementing your own HTTP client can be useful when you'd like your clients to provide the server with tracing info. * If you override the default `CreateHttpClient` convention we advise that you also set the HTTP client type - correctly using the [HttpClientType](../../../client-api/configuration/conventions.mdx#httpclienttype) convention. + correctly using the [HttpClientType](#httpclienttype) convention. @@ -260,7 +260,7 @@ public bool DisableTcpCompression \{ get; set; \} In such a case: * The client will not load the topology from the cache upon failing to connect to a server. - * Even if the client is configured to [receive topology updates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) from the server, + * Even if the client is configured to [receive topology updates](#disabletopologyupdates) from the server, no topology files will be saved on disk, thus preventing the accumulation of these files. * DEFAULT: `false` @@ -488,7 +488,7 @@ public Func FindIdentityPropertyNameFromCollectionName \{ get; s * DEFAULT: `null` When `FindProjectedPropertyNameForIndex` is set to `null` (or returns `null`), - the [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) convention is used instead. + the [FindPropertyNameForIndex](#findpropertynameforindex) convention is used instead. **Example**: Consider the following index, which indexes the nested `School.Id` property from _Student_ documents: @@ -537,7 +537,7 @@ public class School When querying the index and projecting fields from the matching _Student_ documents, if the `FindProjectedPropertyNameForIndex` convention is Not set, -the client will use the [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) convention instead when constructing the RQL sent to the server. +the client will use the [FindPropertyNameForIndex](#findpropertynameforindex) convention instead when constructing the RQL sent to the server. This results in the following RQL query: (Note that while the high-level query uses `.Select(student => student.School.Id)`, @@ -684,7 +684,7 @@ public Func FindPropertyNameForIndex \{ ge * In the first attempt, the request executor will send a single request to the selected node. Learn about the "selected node" in: [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node). -* A [second attempt](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) will be held upon failure. +* A [second attempt](#secondbroadcastattempttimeout) will be held upon failure. * DEFAULT: `5 seconds` @@ -712,9 +712,9 @@ public TimeSpan FirstBroadcastAttemptTimeout \{ get; set; \} This setting does not control how long an idle TCP connection remains open; it limits how long the client waits for an HTTP request to complete. * This value also serves as the maximum allowed timeout for request-executor timeouts, - such as [RequestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout), - [FirstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout), - [SecondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout), and per-request command timeouts. + such as [RequestTimeout](#requesttimeout), + [FirstBroadcastAttemptTimeout](#firstbroadcastattempttimeout), + [SecondBroadcastAttemptTimeout](#secondbroadcastattempttimeout), and per-request command timeouts. Setting any of these to a value greater than `GlobalHttpClientTimeout` will throw an exception. * In client code, set `GlobalHttpClientTimeout` to be greater than or equal to the longest request timeout you plan to use. @@ -746,7 +746,7 @@ public TimeSpan GlobalHttpClientTimeout \{ get; set; \} * RavenDB uses the HTTP type internally to manage its cache. -* If you override the [CreateHttpClient](../../../client-api/configuration/conventions.mdx#createhttpclient) convention to use a non-default HTTP client, +* If you override the [CreateHttpClient](#createhttpclient) convention to use a non-default HTTP client, we advise that you also set `HttpClientType` so it returns the client type you are actually using. @@ -1092,7 +1092,7 @@ public bool SaveEnumsAsIntegers \{ get; set; \} #### SecondBroadcastAttemptTimeout * Use the `SecondBroadcastAttemptTimeout` convention to set the timeout for the second broadcast attempt. -* Upon failure of the [first attempt](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. +* Upon failure of the [first attempt](#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. * DEFAULT: `30 seconds` diff --git a/versioned_docs/version-6.2/client-api/configuration/content/_conventions-nodejs.mdx b/versioned_docs/version-6.2/client-api/configuration/content/_conventions-nodejs.mdx index 9568ff2e09..93eb3ac9ad 100644 --- a/versioned_docs/version-6.2/client-api/configuration/content/_conventions-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/content/_conventions-nodejs.mdx @@ -8,37 +8,37 @@ import CodeBlock from '@theme/CodeBlock'; * **Conventions** in RavenDB are customizable settings that users can configure to tailor client behaviors according to their preferences. * In this article: - * [How to set conventions](../../../client-api/configuration/conventions.mdx#how-to-set-conventions) + * [How to set conventions](#how-to-set-conventions) * [Conventions:](../../../client-api/configuration/conventions.mdx#conventions:) - [customFetch](../../../client-api/configuration/conventions.mdx#customfetch) - [disableAtomicDocumentWritesInClusterWideTransaction](../../../client-api/configuration/conventions.mdx#disableatomicdocumentwritesinclusterwidetransaction) - [disableTopologyUpdates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) - [findCollectionName](../../../client-api/configuration/conventions.mdx#findcollectionname) - [findJsType](../../../client-api/configuration/conventions.mdx#_findjstype) - [findJsTypeName](../../../client-api/configuration/conventions.mdx#_findjstypename) - [firstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) - [identityPartsSeparator](../../../client-api/configuration/conventions.mdx#identitypartsseparator) - [loadBalanceBehavior](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [loadBalancerContextSeed](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [loadBalancerPerSessionContextSelector](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [maxHttpCacheSize](../../../client-api/configuration/conventions.mdx#maxhttpcachesize) - [maxNumberOfRequestsPerSession](../../../client-api/configuration/conventions.mdx#maxnumberofrequestspersession) - [readBalanceBehavior](../../../client-api/configuration/conventions.mdx#readbalancebehavior) - [requestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout) - [secondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) - [sendApplicationIdentifier](../../../client-api/configuration/conventions.mdx#sendapplicationidentifier) - [shouldIgnoreEntityChanges](../../../client-api/configuration/conventions.mdx#shouldignoreentitychanges) - [storeDatesInUtc](../../../client-api/configuration/conventions.mdx#storedatesinutc) - [storeDatesWithTimezoneInfo](../../../client-api/configuration/conventions.mdx#storedateswithtimezoneinfo) - [syncJsonParseLimit](../../../client-api/configuration/conventions.mdx#syncjsonparselimit) - [throwIfQueryPageSizeIsNotSet](../../../client-api/configuration/conventions.mdx#throwifquerypagesizeisnotset) - [transformClassCollectionNameToDocumentIdPrefix](../../../client-api/configuration/conventions.mdx#transformclasscollectionnametodocumentidprefix) - [useCompression](../../../client-api/configuration/conventions.mdx#usecompression) - [useJsonlStreaming](../../../client-api/configuration/conventions.mdx#usejsonlstreaming) - [useOptimisticConcurrency](../../../client-api/configuration/conventions.mdx#useoptimisticconcurrency) - [waitForIndexesAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforindexesaftersavechangestimeout) - [waitForNonStaleResultsTimeout](../../../client-api/configuration/conventions.mdx#waitfornonstaleresultstimeout) - [waitForReplicationAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforreplicationaftersavechangestimeout) + [customFetch](#customfetch) + [disableAtomicDocumentWritesInClusterWideTransaction](#disableatomicdocumentwritesinclusterwidetransaction) + [disableTopologyUpdates](#disabletopologyupdates) + [findCollectionName](#findcollectionname) + [findJsType](#_findjstype) + [findJsTypeName](#_findjstypename) + [firstBroadcastAttemptTimeout](#firstbroadcastattempttimeout) + [identityPartsSeparator](#identitypartsseparator) + [loadBalanceBehavior](#loadbalancebehavior) + [loadBalancerContextSeed](#loadbalancebehavior) + [loadBalancerPerSessionContextSelector](#loadbalancebehavior) + [maxHttpCacheSize](#maxhttpcachesize) + [maxNumberOfRequestsPerSession](#maxnumberofrequestspersession) + [readBalanceBehavior](#readbalancebehavior) + [requestTimeout](#requesttimeout) + [secondBroadcastAttemptTimeout](#secondbroadcastattempttimeout) + [sendApplicationIdentifier](#sendapplicationidentifier) + [shouldIgnoreEntityChanges](#shouldignoreentitychanges) + [storeDatesInUtc](#storedatesinutc) + [storeDatesWithTimezoneInfo](#storedateswithtimezoneinfo) + [syncJsonParseLimit](#syncjsonparselimit) + [throwIfQueryPageSizeIsNotSet](#throwifquerypagesizeisnotset) + [transformClassCollectionNameToDocumentIdPrefix](#transformclasscollectionnametodocumentidprefix) + [useCompression](#usecompression) + [useJsonlStreaming](#usejsonlstreaming) + [useOptimisticConcurrency](#useoptimisticconcurrency) + [waitForIndexesAfterSaveChangesTimeout](#waitforindexesaftersavechangestimeout) + [waitForNonStaleResultsTimeout](#waitfornonstaleresultstimeout) + [waitForReplicationAfterSaveChangesTimeout](#waitforreplicationaftersavechangestimeout) ## How to set conventions @@ -201,7 +201,7 @@ set findJsTypeName(value); * In the first attempt, the request executor will send a single request to the selected node. Learn about the "selected node" in: [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node). -* A [second attempt](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) will be held upon failure. +* A [second attempt](#secondbroadcastattempttimeout) will be held upon failure. * DEFAULT: `5 seconds` @@ -328,7 +328,7 @@ set requestTimeout(value); #### secondBroadcastAttemptTimeout * Use the `secondBroadcastAttemptTimeout` convention to set the timeout for the second broadcast attempt. -* Upon failure of the [first attempt](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. +* Upon failure of the [first attempt](#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. * DEFAULT: `30 seconds` diff --git a/versioned_docs/version-6.2/client-api/configuration/content/_deserialization-csharp.mdx b/versioned_docs/version-6.2/client-api/configuration/content/_deserialization-csharp.mdx index b4191f5ca9b01ff1c7c97efee6131b5c12427449..f4fde82470a3ddd80fe4725deebeb24507f7bbcc 100644 GIT binary patch delta 28 kcmew*{ZVqmN5;u&OwN<%F$GUnV-A_Tp4oA;D$7+)0IFLGmH+?% delta 168 zcmew;`Ad4kN5;uaTq2Vr82N-#Qj1fIG81z$s}f5x^Yip_Qz|BZWOT+WZ^9IeSH7Jo S1h4#UCP#eon`M} diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx index 437b1373ff..47a72c7b0e 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx index 77af4c4b60..4da59fc3f5 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `loadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'loadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'loadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx index e6635b4498..fc82d71424 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx index c1220e9dae..d3057df904 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx index d740865fb1..046f18627b 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx index b7d516cc38..8f4e2f81eb 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [readBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize readBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set readBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [readBalanceBehavior options](#readbalancebehavior-options) + * [Initialize readBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set readBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `readBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'readBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'readBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx index 67dfe4cc31..886e88a4a6 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx index 51148c9204..c35be01585 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-6.2/client-api/configuration/load-balance/overview.mdx b/versioned_docs/version-6.2/client-api/configuration/load-balance/overview.mdx index fee668b5de..dcbfb4842c 100644 --- a/versioned_docs/version-6.2/client-api/configuration/load-balance/overview.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/load-balance/overview.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Each instance is a complete replica of the database. * The [database-group-topology](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---view) is the list of nodes that contain those database replicas. - The first node in this list is called the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node). + The first node in this list is called the [preferred node](#the-preferred-node). * The client is kept up-to-date with this topology list. __The client decides which node from this list to access__ when making requests to the RavenDB cluster. @@ -28,10 +28,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [ReadBalanceBehavior](../../../client-api/configuration/load-balance/read-balance-behavior.mdx) - load balancing `Read` requests only * [LoadBalanceBehavior](../../../client-api/configuration/load-balance/load-balance-behavior.mdx) - load balancing `Read & Write` requests * In this page: - * [Keeping the client topology up-to-date](../../../client-api/configuration/load-balance/overview.mdx#keeping-the-client-topology-up-to-date) - * [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node) - * [The preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) - * [Single-node session usage](../../../client-api/configuration/load-balance/overview.mdx#single-node-session-usage) + * [Keeping the client topology up-to-date](#keeping-the-client-topology-up-to-date) + * [Client logic for choosing a node](#client-logic-for-choosing-a-node) + * [The preferred node](#the-preferred-node) + * [Single-node session usage](#single-node-session-usage) ## Keeping the client topology up-to-date @@ -67,7 +67,7 @@ The client uses the following logic (from top to bottom) to determine which node `Read` requests: The client will select a node based on the [read balance options](../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options). `Write` requests: All _Write_ requests will be directed to the preferred node. * Else, use the __preferred node__: - Use the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) for both `Read & Write` requests. + Use the [preferred node](#the-preferred-node) for both `Read & Write` requests. diff --git a/versioned_docs/version-6.2/client-api/content/_creating-document-store-csharp.mdx b/versioned_docs/version-6.2/client-api/content/_creating-document-store-csharp.mdx index 6c3bfd1fee..691b7d18b2 100644 --- a/versioned_docs/version-6.2/client-api/content/_creating-document-store-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/content/_creating-document-store-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * **Creating a Document Store** is the _first step_ that a RavenDB client application needs to make when working with RavenDB. * We recommend that your Document Store implement the [Singleton Pattern](https://csharpindepth.com/articles/Singleton) as demonstrated in -the example code [below](../../client-api/creating-document-store.mdx#creating-a-document-store---example). +the example code [below](#creating-a-document-store---example). Creating more than one Document Store may be resource intensive, and one instance is sufficient for most use cases. * In this page: - * [Creating a Document Store - Configuration](../../client-api/creating-document-store.mdx#creating-a-document-store---configuration) - * [Certificate Disposal](../../client-api/creating-document-store.mdx#certificate-disposal) - * [Creating a Document Store - Example](../../client-api/creating-document-store.mdx#creating-a-document-store---example) + * [Creating a Document Store - Configuration](#creating-a-document-store---configuration) + * [Certificate Disposal](#certificate-disposal) + * [Creating a Document Store - Example](#creating-a-document-store---example) ## Creating a Document Store - Configuration diff --git a/versioned_docs/version-6.2/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx b/versioned_docs/version-6.2/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx index 098d83c96b..95b4621044 100644 --- a/versioned_docs/version-6.2/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx @@ -17,7 +17,7 @@ The Client Certificate is generated by the admin from the [Studio](../../server/ certificate. * Pass your Client Certificate to the Document Store before initialization, as shown in the example code -[below](../../client-api/setting-up-authentication-and-authorization.mdx#example---initializing-document-store-with-a-client-certificate). +[below](#example---initializing-document-store-with-a-client-certificate). The server will use this certificate to authenticate the client when connection is established. diff --git a/versioned_docs/version-6.2/client-api/content/_setting-up-default-database-csharp.mdx b/versioned_docs/version-6.2/client-api/content/_setting-up-default-database-csharp.mdx index 38f3417c74..aba613c255 100644 --- a/versioned_docs/version-6.2/client-api/content/_setting-up-default-database-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/content/_setting-up-default-database-csharp.mdx @@ -17,8 +17,8 @@ The default database value itself will Not change. explicitly passed. * In this page: - * [Example - Without a Default Database](../../client-api/setting-up-default-database.mdx#example---without-a-default-database) - * [Example - With a Default Database](../../client-api/setting-up-default-database.mdx#example---with-a-default-database) + * [Example - Without a Default Database](#example---without-a-default-database) + * [Example - With a Default Database](#example---with-a-default-database) ## Example - Without a Default Database diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx index c0683651da..1dc373dca1 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers data subscriptions maintenance operations. * In this page: - * [DocumentSubscriptions class](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#documentsubscriptions-class) - * [Delete subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#delete-subscription) - * [Disabling subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disable-subscription) - * [Enable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#enable-subscription) - * [Update subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#update-subscription) - * [Drop Connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#drop-connection) - * [Get subscription state](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscription-state) + * [DocumentSubscriptions class](#documentsubscriptions-class) + * [Delete subscription](#delete-subscription) + * [Disabling subscription](#disable-subscription) + * [Enable subscription](#enable-subscription) + * [Update subscription](#update-subscription) + * [Drop Connection](#drop-connection) + * [Get subscription state](#get-subscription-state) ## DocumentSubscriptions class diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx index 994b10206c..e7cf868a4f 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * This page covers data subscriptions maintenance operations: - * [Deleting subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#deleting-subscription) - * [Dropping connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#dropping-connection) - * [Disabling subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disabling-subscription) - * [Updating subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#updating-subscription) - * [Getting subscription status](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#getting-subscription-status) + * [Deleting subscription](#deleting-subscription) + * [Dropping connection](#dropping-connection) + * [Disabling subscription](#disabling-subscription) + * [Updating subscription](#updating-subscription) + * [Getting subscription status](#getting-subscription-status) ## Deleting subscription diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx index 83379c7a73..2238aee053 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers data subscriptions maintenance operations. * In this page: - * [Delete subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#delete-subscription) - * [Disable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disable-subscription) - * [Enable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#enable-subscription) - * [Update subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#update-subscription) - * [Drop connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#drop-connection) - * [Get subscriptions](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscriptions) - * [Get subscription state](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscription-state) - * [DocumentSubscriptions class](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#documentsubscriptions-class) + * [Delete subscription](#delete-subscription) + * [Disable subscription](#disable-subscription) + * [Enable subscription](#enable-subscription) + * [Update subscription](#update-subscription) + * [Drop connection](#drop-connection) + * [Get subscriptions](#get-subscriptions) + * [Get subscription state](#get-subscription-state) + * [DocumentSubscriptions class](#documentsubscriptions-class) ## Delete subscription diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx index 25f8ad1e10..69b500b71e 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx @@ -15,11 +15,11 @@ import CodeBlock from '@theme/CodeBlock'; See how to create and consume it in the examples below. * In this page: - * [Regular subscription vs Revisions subscription](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#regular-subscription-vs-revisions-subscription) - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple creation and consumption](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption) - * [Filtering revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#filtering-revisions) - * [Projecting fields from revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions) + * [Regular subscription vs Revisions subscription](#regular-subscription-vs-revisions-subscription) + * [Revisions processing order](#revisions-processing-order) + * [Simple creation and consumption](#simple-creation-and-consumption) + * [Filtering revisions](#filtering-revisions) + * [Projecting fields from revisions](#projecting-fields-from-revisions) ## Regular subscription vs Revisions subscription @@ -46,7 +46,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Query access scope**: For each revision, the subscription query running on the server has access to both the currently processed revision and its previous revision. * **Data sent to client**: - By default, unless the subscription query is [projecting specific fields](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions), + By default, unless the subscription query is [projecting specific fields](#projecting-fields-from-revisions), each item in the batch sent to the client contains both the processed revision (`Result.Current`) and its preceding revision (`Result.Previous`). If the document has just been created, the previous revision will be `null`. @@ -285,7 +285,7 @@ Here we define a revisions subscription that will filter the revisions and send Since the revision fields are projected into the `OrderRevenues` class in the subscription definition, each item received in the batch has the format of this projected class instead of the default `Result.Previous` and `Result.Current` fields, -as was demonstrated in the [simple example](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption). +as was demonstrated in the [simple example](#simple-creation-and-consumption). diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx index f0278bbcda..25d891e229 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; Both revisions are accessible for filtering and projection. * In this page: - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple declaration and usage](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-declaration-and-usage) - * [Revisions processing and projection](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-and-projection) + * [Revisions processing order](#revisions-processing-order) + * [Simple declaration and usage](#simple-declaration-and-usage) + * [Revisions processing and projection](#revisions-processing-and-projection) ## Revisions processing order diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx index ccb9d4e4bb..f703754297 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx @@ -15,11 +15,11 @@ import CodeBlock from '@theme/CodeBlock'; See how to create and consume it in the examples below. * In this page: - * [Regular subscription vs Revisions subscription](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#regular-subscription-vs-revisions-subscription) - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple creation and consumption](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption) - * [Filtering revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#filtering-revisions) - * [Projecting fields from revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions) + * [Regular subscription vs Revisions subscription](#regular-subscription-vs-revisions-subscription) + * [Revisions processing order](#revisions-processing-order) + * [Simple creation and consumption](#simple-creation-and-consumption) + * [Filtering revisions](#filtering-revisions) + * [Projecting fields from revisions](#projecting-fields-from-revisions) ## Regular subscription vs Revisions subscription @@ -248,7 +248,7 @@ Here we define a revisions subscription that will filter the revisions and send Since the revision fields are projected into the `OrderRevenues` class in the subscription definition, each item received in the batch has the format of this projected class instead of the default `result.previous` and `result.current` fields, -as was demonstrated in the [simple example](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption). +as was demonstrated in the [simple example](#simple-creation-and-consumption). diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx index d172cdbad9..de8d8a01d3 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [SubscriptionBatch<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht) - * [SubscriptionBatch<T>.Item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) - * [SubscriptionWorker<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert) + * [Create the subscription worker](#create-the-subscription-worker) + * [SubscriptionWorkerOptions](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [SubscriptionBatch<T>](#subscriptionbatcht) + * [SubscriptionBatch<T>.Item](#subscriptionbatchtitem) + * [SubscriptionWorker<T>](#subscriptionworkert) ## Create the subscription worker @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; A subscription worker can be created using the following `GetSubscriptionWorker` methods available through the `Subscriptions` property of the `DocumentStore`. Note: Simply creating the worker is insufficient; -after creating the worker, you need to [run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) to initiate document processing. +after creating the worker, you need to [run the subscription worker](#run-the-subscription-worker) to initiate document processing. @@ -112,8 +112,8 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../. ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. -To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert). +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +To start processing, you need to call the `Run` method of the [SubscriptionWorker](#subscriptionworkert). The `Run` function takes a delegate, which is your client-side code responsible for processing the received document batches. @@ -144,7 +144,7 @@ Task Run(Func, Task> processDocuments, | Member | Type | Description | |--------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) below. | +| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](#subscriptionbatchtitem) below. | | **NumberOfItemsInBatch** | `int` | Number of items in the batch. | | Method Signature | Return value | Description | @@ -215,7 +215,7 @@ Using it outside this scope may cause unexpected behavior. | **DisposeAsync()** | `Task` | Async version of `Dispose()`. | | **Dispose(bool waitForSubscriptionTask)** | `void` | Aborts the subscription worker, but allows deciding whether to wait for the `Run` function task or not. | | **DisposeAsync(bool waitForSubscriptionTask)** | `Task` | Async version of `DisposeAsync(bool waitForSubscriptionTask)`. | -| **Run (multiple overloads)** | `Task` | Call `Run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| **Run (multiple overloads)** | `Task` | Call `Run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx index 57f4671bf4..a92c10a679 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [SubscriptionBatch<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht) - * [SubscriptionWorker<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert) + * [Create the subscription worker](#create-the-subscription-worker) + * [SubscriptionWorkerOptions](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [SubscriptionBatch<T>](#subscriptionbatcht) + * [SubscriptionWorker<T>](#subscriptionworkert) ## Create the subscription worker @@ -73,8 +73,8 @@ All other parameters are optional and will default to their respective default v ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. -To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert). +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +To start processing, you need to call the `run` method of the [SubscriptionWorker](#subscriptionworkert). The `run` function takes a delegate, which is your client-side code responsible for processing the received document batches. @@ -147,7 +147,7 @@ if T is `ObjectNode`, no deserialization will take place | Method Signature | Return Type | Description | |------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **close()** | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | -| **run (multiple overloads)** | `CompletableFuture` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| **run (multiple overloads)** | `CompletableFuture` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx index 31a3deb17d..0e4ca997ef 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [Subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker-options) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [Subscription batch](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch) - * [Subscription batch item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch-item) - * [Subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker) + * [Create the subscription worker](#create-the-subscription-worker) + * [Subscription worker options](#subscription-worker-options) + * [Run the subscription worker](#run-the-subscription-worker) + * [Subscription batch](#subscription-batch) + * [Subscription batch item](#subscription-batch-item) + * [Subscription worker](#subscription-worker) ## Create the subscription worker @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; A subscription worker can be created using the following `getSubscriptionWorker` methods available through the `subscriptions` property of the `documentStore`. Note: Simply creating the worker is insufficient; -after creating the worker, you need to [run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) to initiate document processing. +after creating the worker, you need to [run the subscription worker](#run-the-subscription-worker) to initiate document processing. @@ -36,11 +36,11 @@ await documentStore.subscriptions.getSubscriptionWorker(options, database); |----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **subscriptionName** | `string` | The name of the subscription to which the worker will connect. | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in DocumentStore will be used. | -| **options** | `object` | [Subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker-options) object that affect how the worker interacts with the subscription. These options do not alter the definition of the subscription itself. | +| **options** | `object` | [Subscription worker options](#subscription-worker-options) object that affect how the worker interacts with the subscription. These options do not alter the definition of the subscription itself. | | Return value | | |----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `SubscriptionWorker` | The [subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker) that has been created.
The worker will start processing documents once you define the worker's `on` method,
which listens to the `batch` event. | +| `SubscriptionWorker` | The [subscription worker](#subscription-worker) that has been created.
The worker will start processing documents once you define the worker's `on` method,
which listens to the `batch` event. | @@ -82,7 +82,7 @@ All other parameters are optional and will default to their respective default v ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. To initiate processing, you need to define an event handler and attach it to the worker's `batch` event listener. This handler contains your client-side code responsible for processing the document batches received from the server. @@ -113,7 +113,7 @@ The subscription batch class contains the following public properties & methods: | Property | Type | Description | |-------------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **items** | `Item[]` | List of items in the batch.
See [subscription batch item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch-item). | +| **items** | `Item[]` | List of items in the batch.
See [subscription batch item](#subscription-batch-item). | | Method | Return type | Description | |-------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------| diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx index 2b8c22edc1..c820ea77bb 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [`SubscriptionWorkerOptions`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [`SubscriptionBatch[_T]`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch_t) - * [`SubscriptionWorker[_T]`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker_t) + * [Create the subscription worker](#create-the-subscription-worker) + * [`SubscriptionWorkerOptions`](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [`SubscriptionBatch[_T]`](#subscriptionbatch_t) + * [`SubscriptionWorker[_T]`](#subscriptionworker_t) ## Create the subscription worker @@ -82,7 +82,7 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../. ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. To start processing, you need to call the `run` function of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker[_t]). The `run` function receives the client-side code as a function that will process the received document batches. @@ -180,7 +180,7 @@ is not supported. | Method | Return Type | Description | |-------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `close(bool wait_for_subscription_task = True)` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | -| `run` | `Future[None]` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| `run` | `Future[None]` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | ### Events: | Event | Type\Return type | Description | diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx index 65e0901c3f..da087b81b8 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx @@ -6,15 +6,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Worker that processes a blittable object](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-a-blittable-object) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Subscription workers with failover on other nodes](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-workers-with-failover-on-other-nodes) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Worker that processes a blittable object](#worker-that-processes-a-blittable-object) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Subscription workers with failover on other nodes](#subscription-workers-with-failover-on-other-nodes) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-java.mdx index 8466cf34ac..102d7ccae3 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-java.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * this page: - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Subscription that ends when no documents left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-left) - * [Worker that processes raw objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#sworker-that-processes-raw-objects) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Subscription that ends when no documents left](#subscription-that-ends-when-no-documents-left) + * [Worker that processes raw objects](#sworker-that-processes-raw-objects) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Worker with a specified batch size diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx index e2c5222311..32482747b6 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-python.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-python.mdx index f2a6937706..c2ce17e968 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-python.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_examples-python.mdx @@ -6,14 +6,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Subscription workers with failover on other nodes](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-workers-with-failover-on-other-nodes) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Subscription workers with failover on other nodes](#subscription-workers-with-failover-on-other-nodes) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx index 7379c89553..d164ce8d55 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions). * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## SubscriptionWorker lifecycle @@ -55,7 +55,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -179,15 +179,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [concurrent](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [concurrent](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx index ccc4a0db5e..c00a2e325c 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx @@ -10,9 +10,9 @@ A `SubscriptionWorker` object manages the documents processing and the communica We've introduced several ways to create and configure a SubscriptionWorker, starting from just giving a subscription name, and ending with a detailed configuration object - `SubscriptionWorkerOptions`. * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) ## SubscriptionWorker lifecycle @@ -52,7 +52,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx index 83eafbe3aa..621e624247 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see [subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions). * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## SubscriptionWorker lifecycle @@ -73,7 +73,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -185,15 +185,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [concurrent](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [concurrent](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx index c9f14b40d8..70a0049646 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see `SubscriptionWorkerOptions`. * In this page: - * [`subscription_worker` lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscription_worker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [`subscription_worker` lifecycle](#subscription_worker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## `subscription_worker` lifecycle @@ -54,7 +54,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -163,15 +163,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [CONCURRENT](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [CONCURRENT](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [CONCURRENT](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [CONCURRENT](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx index 7a1ed39051..27fe8fcfea 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * Documents that were assigned to workers whose connection has ended unexpectedly, can be reassigned by the server to available workers. - See [connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) below. + See [connection failure](#connection-failure) below. * In this page: - * [Defining concurrent workers](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#defining-concurrent-workers) - * [Dropping a connection](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#dropping-a-connection) - * [Connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) + * [Defining concurrent workers](#defining-concurrent-workers) + * [Dropping a connection](#dropping-a-connection) + * [Connection failure](#connection-failure) ## Defining concurrent workers diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx index 1e0836f58b..34d0e7362c 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * Documents that were assigned to workers whose connection has ended unexpectedly, can be reassigned by the server to available workers. - See [connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) below. + See [connection failure](#connection-failure) below. * In this page: - * [Defining concurrent workers](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#defining-concurrent-workers) - * [Dropping a connection](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#dropping-a-connection) - * [Connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) + * [Defining concurrent workers](#defining-concurrent-workers) + * [Dropping a connection](#dropping-a-connection) + * [Connection failure](#connection-failure) ## Defining concurrent workers diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx index 5948b0ed9a..8a59dbf231 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) ## Data subscription consumption diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx index 5199e144b2..b0ba14a913 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx index d0c082823b..982ac5045a 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx index ea876c788b..cd8d4bbce7 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [SubscriptionCreationOptions<T>](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst) - * [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) - * [Subscription query](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query) + * [Create subscription](#create-subscription) + * [SubscriptionCreationOptions<T>](#subscriptioncreationoptionst) + * [SubscriptionCreationOptions](#subscriptioncreationoptions) + * [Update subscription](#update-subscription) + * [SubscriptionUpdateOptions](#subscriptionupdateoptions) + * [Subscription query](#subscription-query) ## Create subscription @@ -56,8 +56,8 @@ Task CreateAsync(Expression> predicate = null, | Parameter | Type | Description | |----------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **predicate** | `Expression>` | An optional lambda expression that returns a boolean.
This predicate defines the filter criteria for the subscription documents. | -| **options** | `SubscriptionCreationOptions` | Contains subscription creation options.
See [SubscriptionCreationOptions<T>](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst) | -| **options** | `SubscriptionCreationOptions` | Contains subscription creation options - non-generic version.
See [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) | +| **options** | `SubscriptionCreationOptions` | Contains subscription creation options.
See [SubscriptionCreationOptions<T>](#subscriptioncreationoptionst) | +| **options** | `SubscriptionCreationOptions` | Contains subscription creation options - non-generic version.
See [SubscriptionCreationOptions](#subscriptioncreationoptions) | | **database** | `string` | The name of the database where the subscription task will be created. If `null`, the default database configured in the DocumentStore will be used. | | **token** | `CancellationToken` | Cancellation token used in to halt the subscription creation process. | @@ -130,7 +130,7 @@ Task UpdateAsync(SubscriptionUpdateOptions options, string database = nu | Parameter | Type | Description | |--------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `SubscriptionUpdateOptions` | The subscription update options object.
See [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) | +| **options** | `SubscriptionUpdateOptions` | The subscription update options object.
See [SubscriptionUpdateOptions](#subscriptionupdateoptions) | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in the DocumentStore will be used. | | **token** | `CancellationToken` | Cancellation token used to halt the update process. | @@ -142,7 +142,7 @@ Task UpdateAsync(SubscriptionUpdateOptions options, string database = nu ## SubscriptionUpdateOptions -`SubscriptionUpdateOptions` inherits from [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) +`SubscriptionUpdateOptions` inherits from [SubscriptionCreationOptions](#subscriptioncreationoptions) and adds two additional fields: diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx index 154528cb19..c73019a8bd 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) - * [Include methods](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [Subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options) - * [Subscribe to revisions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscribe-to-revisions) - * [Subscription RQL](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-rql) + * [Create subscription](#create-subscription) + * [Subscription creation options](#subscription-creation-options) + * [Include methods](#include-methods) + * [Update subscription](#update-subscription) + * [Subscription update options](#subscription-update-options) + * [Subscribe to revisions](#subscribe-to-revisions) + * [Subscription RQL](#subscription-rql) ## Create subscription @@ -35,13 +35,13 @@ create(documentType); | Parameter | Type | Description | |------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options). | +| **options** | `object` | The [subscription creation options](#subscription-creation-options). | | **database** | `string` | The name of the database where the subscription task will be created.
If `null`, the default database configured in the DocumentStore will be used. | | **documentType** | `object` | The class type from which the collection of documents managed by the subscription will be derived. | | Return value | Description | |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Promise` | A Promise that resolves to the **name** of the created data subscription (a `string`).
If the name was provided in the [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options), it will be returned.
Otherwise, a unique name will be generated by server. | +| `Promise` | A Promise that resolves to the **name** of the created data subscription (a `string`).
If the name was provided in the [subscription creation options](#subscription-creation-options), it will be returned.
Otherwise, a unique name will be generated by server. | Examples for creating subscriptions are available [here](../../../../client-api/data-subscriptions/creation/examples.mdx). @@ -70,8 +70,8 @@ Examples for creating subscriptions are available [here](../../../../client-api/ | Member | Type | Description | |---------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **name** | `string` | User defined name for the subscription.
The name must be unique in the database. | -| **query** | `string` | RQL query that defines the subscription. This RQL comes with additional support to JavaScript functions inside the `where` clause and special semantics for subscriptions on documents revisions.
Learn more in [subscription RQL](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-rql). | -| **includes** | `(builder) => void` | A function that accepts a builder object, which allows you to include related documents, counters, and time series in the batch that is sent to the client.
See [Include methods](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods). | +| **query** | `string` | RQL query that defines the subscription. This RQL comes with additional support to JavaScript functions inside the `where` clause and special semantics for subscriptions on documents revisions.
Learn more in [subscription RQL](#subscription-rql). | +| **includes** | `(builder) => void` | A function that accepts a builder object, which allows you to include related documents, counters, and time series in the batch that is sent to the client.
See [Include methods](#include-methods). | | **changeVector** | `string` | Allows to define a change vector from which the subscription will start processing. Useful for ad-hoc processes that need to process only recent changes. In such cases, you can set the field to _"LastDocument"_ to start processing from the latest document in the collection. | | **mentorNode** | `string` | Allows to define a specific node in the cluster to handle the subscription. Useful when you prefer a specific server due to its stronger hardware, closer geographic proximity to clients, or other reasons. | | **pinToMentorNode** | `boolean` | `true` - task will only be handled by the specified mentor node.
`false` - When the specified mentor node is down, the cluster selects another node from the Database Group to handle the task.
Learn more in [pinning a task](../../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task). | @@ -163,7 +163,7 @@ update(options, database); | Parameter | Type | Description | |--------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options). | +| **options** | `object` | The [subscription update options](#subscription-update-options). | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in the DocumentStore will be used. | | Return value | Description | @@ -176,7 +176,7 @@ Examples for updating an existing subscription are available [here](../../../../ ## Subscription update options -The subscription update options object extends the [creation options object](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) +The subscription update options object extends the [creation options object](#subscription-creation-options) and adds two additional fields: @@ -221,7 +221,7 @@ createForRevisions(options, database); | Parameter | Type | Description | |--------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options). | +| **options** | `object` | The [subscription creation options](#subscription-creation-options). | | **database** | `string` | The name of the database where the subscription task will be created.
If `null`, the default database configured in the DocumentStore will be used. | When providing raw RQL to the `query` param in the options object, diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-python.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-python.mdx index 42a4912648..aba6c34a85 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-python.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_api-overview-python.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) - * [Subscription query](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query) + * [Create subscription](#create-subscription) + * [SubscriptionCreationOptions](#subscriptioncreationoptions) + * [Update subscription](#update-subscription) + * [SubscriptionUpdateOptions](#subscriptionupdateoptions) + * [Subscription query](#subscription-query) ## Create subscription @@ -99,7 +99,7 @@ Modifies an existing data subscription. These methods are accessible at `Documen ## SubscriptionUpdateOptions -Inherits from `SubscriptionCreationOptions` and has all the same fields (see [above](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions)) plus the two additional fields described below: +Inherits from `SubscriptionCreationOptions` and has all the same fields (see [above](#subscriptioncreationoptions)) plus the two additional fields described below: diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-csharp.mdx index 8d8a9d2253..b2ac089d4f 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-csharp.mdx @@ -11,15 +11,15 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Create subscription - subscribe to revisions](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---subscribe-to-revisions) - * [Create subscription - via update](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---via-update) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Create subscription - subscribe to revisions](#create-subscription---subscribe-to-revisions) + * [Create subscription - via update](#create-subscription---via-update) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -263,7 +263,7 @@ See how to consume this type of subscription [here](../../../../client-api/data- Include statements can be added to the subscription with `ISubscriptionIncludeBuilder`. This builder is assigned to the `Includes` property in [SubscriptionCreationOptions<T>](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst). -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. To include related documents, use method `IncludeDocuments`. @@ -287,7 +287,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx index 665881ccf8..9af2bc5cae 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx @@ -11,15 +11,15 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Create subscription - subscribe to revisions](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---subscribe-to-revisions) - * [Create subscription - via update](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---via-update) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Create subscription - subscribe to revisions](#create-subscription---subscribe-to-revisions) + * [Create subscription - via update](#create-subscription---via-update) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -222,7 +222,7 @@ const subscriptionName = await documentStore.subscriptions.create({ query }); Include statements can be added to the subscription with a _builder_ object. This builder is assigned to the `includes` property in the _options_ object. -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. See this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods) for all available include methods. @@ -248,7 +248,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-python.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-python.mdx index 69f8adc10c..e083c09cf1 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-python.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_examples-python.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -208,7 +208,7 @@ See how to consume this type of subscription [here](../../../../client-api/data- Include statements can be added to the subscription with `SubscriptionIncludeBuilder`. This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst). -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. To include related documents, use method `include_documents`. @@ -232,7 +232,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx index 1ea774503c..454abc5712 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx index e7e5952443..748af66246 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx index 5aed7ed6c4..edcc70d9df 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx index 7136152ec7..e4b9a9cf28 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-6.2/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx b/versioned_docs/version-6.2/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx index 67231ff054..fffa82a303 100644 --- a/versioned_docs/version-6.2/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx @@ -15,15 +15,15 @@ import CodeBlock from '@theme/CodeBlock'; * [Document identifier generation](../../../server/kb/document-identifier-generation.mdx) * [Working with document identifiers](../../../client-api/document-identifiers/working-with-document-identifiers.mdx). * In this page: - * [How the HiLo algorithm works in RavenDB](../../../client-api/document-identifiers/hilo-algorithm.mdx#how-the-hilo-algorithm-works-in-ravendb) - * [Generating unique IDs efficiently](../../../client-api/document-identifiers/hilo-algorithm.mdx#generating-unique-ids-efficiently) - * [Using HiLo documents](../../../client-api/document-identifiers/hilo-algorithm.mdx#using-hilo-documents) - * [Returning HiLo ranges](../../../client-api/document-identifiers/hilo-algorithm.mdx#returning-hilo-ranges) - * [Identity parts separator](../../../client-api/document-identifiers/hilo-algorithm.mdx#identity-parts-separator) - * [Manual HiLo ID generation](../../../client-api/document-identifiers/hilo-algorithm.mdx#manual-hilo-id-generation) - * [Get next ID - number only](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) - * [Get next ID - full document ID](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) - * [Overriding the HiLo algorithm](../../../client-api/document-identifiers/hilo-algorithm.mdx#overriding-the-hilo-algorithm) + * [How the HiLo algorithm works in RavenDB](#how-the-hilo-algorithm-works-in-ravendb) + * [Generating unique IDs efficiently](#generating-unique-ids-efficiently) + * [Using HiLo documents](#using-hilo-documents) + * [Returning HiLo ranges](#returning-hilo-ranges) + * [Identity parts separator](#identity-parts-separator) + * [Manual HiLo ID generation](#manual-hilo-id-generation) + * [Get next ID - number only](#get-next-id---number-only) + * [Get next ID - full document ID](#get-next-id---full-document-id) + * [Overriding the HiLo algorithm](#overriding-the-hilo-algorithm) @@ -160,8 +160,8 @@ using (var session = newStore.OpenSession()) * **Manual generation**: We provide you with the option of manually retrieving the next ID from the HiLo range currently reserved for the client without having to store the document first. You can retrieve either the next number portion or the full document ID and then use it when storing the document, as explained below: - * [Get next ID - number only](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) - * [Get next ID - full document ID](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) + * [Get next ID - number only](#get-next-id---number-only) + * [Get next ID - full document ID](#get-next-id---full-document-id) ### Get next ID - number only You can take advantage of the HiLo algorithm and create documents with your own customized ID that is based on the next HiLo ID number provided by the client. @@ -308,8 +308,8 @@ the consecutive number `4` is retrieved and incorporated into the full document * Your customized ID generation will be applied whenever you store a document without explicitly specifying an `Id`. - * Attempting to call [GenerateNextIdForAsync](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) or - [GenerateDocumentIdAsync](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) via the store's `HiLoIdGenerator` + * Attempting to call [GenerateNextIdForAsync](#get-next-id---number-only) or + [GenerateDocumentIdAsync](#get-next-id---full-document-id) via the store's `HiLoIdGenerator` will throw an exception. diff --git a/versioned_docs/version-6.2/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx b/versioned_docs/version-6.2/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx index 081285fbc1..b6f6583fe9 100644 --- a/versioned_docs/version-6.2/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx @@ -17,14 +17,14 @@ import CodeBlock from '@theme/CodeBlock'; by the HiLo algorithm. As described below, this is how the identifier is generated by the session. * In this page: - * [Session Usage](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#session-usage) - * [Autogenerated IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#autogenerated-ids) + * [Session Usage](#session-usage) + * [Autogenerated IDs](#autogenerated-ids) * [Custom / Semantic IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#custom-/-semantic-ids) - * [Server-side generated IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids) - * [Identities](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) - * [Setting Identity IDs Using Commands and Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#setting-identity-ids-using-commands-and-operations) - * [Using Commands](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-commands) - * [Using Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-operations) + * [Server-side generated IDs](#server-side-generated-ids) + * [Identities](#identities) + * [Setting Identity IDs Using Commands and Operations](#setting-identity-ids-using-commands-and-operations) + * [Using Commands](#using-commands) + * [Using Operations](#using-operations) ## Session Usage @@ -254,7 +254,7 @@ and might affect performance. By default, document IDs created by the server use `/` to separate their components. This separator can be changed to any other character except `|`, in the [Global Identifier Generation Conventions](../../../client-api/configuration/identifier-generation/global.mdx#identitypartsseparator). -See [Setting Identity IDs Using Commands and Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#setting-identity-ids-using-commands-and-operations) +See [Setting Identity IDs Using Commands and Operations](#setting-identity-ids-using-commands-and-operations) for details. * **Concurrent writes** @@ -344,7 +344,7 @@ session.Advanced.RequestExecutor.Execute(putCommand, session.Advanced.Context); RavenDB ver. 4.2 and higher provides high-level [operations](../../../client-api/operations/what-are-operations.mdx#operations-what-are-the-operations) that you may set IDs with, in addition to the -low-level [commands](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-commands) +low-level [commands](#using-commands) we have described above. There is no operational difference between using operations and commands, since the high-level operations actually execute low-level commands. However, using operations may produce a clearer, more concise code. diff --git a/versioned_docs/version-6.2/client-api/faq/backward-compatibility.mdx b/versioned_docs/version-6.2/client-api/faq/backward-compatibility.mdx index c09ddb69d3..a24cf35bac 100644 --- a/versioned_docs/version-6.2/client-api/faq/backward-compatibility.mdx +++ b/versioned_docs/version-6.2/client-api/faq/backward-compatibility.mdx @@ -22,12 +22,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * [Client/Server Compatibility](../../client-api/faq/backward-compatibility.mdx#client/server-compatibility) - * [Compatibility - Up to RavenDB 4.1](../../client-api/faq/backward-compatibility.mdx#compatibility---up-to-ravendb-41) - * [Compatibility - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-42-and-higher) - * [Upgrading](../../client-api/faq/backward-compatibility.mdx#upgrading) - * [Upgrading - Up to RavenDB 4.1](../../client-api/faq/backward-compatibility.mdx#upgrading---up-to-ravendb-41) - * [Upgrading - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#upgrading---ravendb-42-and-higher) - * [Upgrading Order](../../client-api/faq/backward-compatibility.mdx#upgrading-order) + * [Compatibility - Up to RavenDB 4.1](#compatibility---up-to-ravendb-41) + * [Compatibility - RavenDB 4.2 and Higher](#compatibility---ravendb-42-and-higher) + * [Upgrading](#upgrading) + * [Upgrading - Up to RavenDB 4.1](#upgrading---up-to-ravendb-41) + * [Upgrading - RavenDB 4.2 and Higher](#upgrading---ravendb-42-and-higher) + * [Upgrading Order](#upgrading-order) @@ -78,7 +78,7 @@ requires the upgrading of the server and all clients in lockstep. ### Upgrading - RavenDB 4.2 and Higher When RavenDB is upgraded from version 4.2 and higher, e.g. from 4.2 to 5.3, it is recommended - but not mandatory - to upgrade the clients, since they are -[compatible with servers of versions higher than theirs](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-42-and-higher). +[compatible with servers of versions higher than theirs](#compatibility---ravendb-42-and-higher). ### Upgrading Order To properly upgrade your applications and server, we advise you to upgrade the server first, then the clients. diff --git a/versioned_docs/version-6.2/client-api/faq/transaction-support.mdx b/versioned_docs/version-6.2/client-api/faq/transaction-support.mdx index 70bdad1252..1548143c34 100644 --- a/versioned_docs/version-6.2/client-api/faq/transaction-support.mdx +++ b/versioned_docs/version-6.2/client-api/faq/transaction-support.mdx @@ -15,14 +15,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [ACID storage](../../client-api/faq/transaction-support.mdx#acid-storage) - * [What is and what isn't a transaction](../../client-api/faq/transaction-support.mdx#what-is-and-what-isn) - * [Working with transactions in RavenDB ](../../client-api/faq/transaction-support.mdx#working-with-transactions-in-ravendb) - * [Single-node model](../../client-api/faq/transaction-support.mdx#single-node-model) - * [Multi-master model](../../client-api/faq/transaction-support.mdx#multi-master-model) - * [Cluster-wide transactions](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions) - * [ACID for document operations](../../client-api/faq/transaction-support.mdx#acid-for-document-operations) - * [BASE for query operations](../../client-api/faq/transaction-support.mdx#base-for-query-operations) + * [ACID storage](#acid-storage) + * [What is and what isn't a transaction](#what-is-and-what-isn) + * [Working with transactions in RavenDB ](#working-with-transactions-in-ravendb) + * [Single-node model](#single-node-model) + * [Multi-master model](#multi-master-model) + * [Cluster-wide transactions](#cluster-wide-transactions) + * [ACID for document operations](#acid-for-document-operations) + * [BASE for query operations](#base-for-query-operations) ## ACID storage @@ -47,7 +47,7 @@ which guarantees all ACID properties, whether executed on document, index or loc It employs _Serializable_ isolation for write operations and _Snapshot_ isolation for read operations. * RavenDB doesn't support a transaction spanning __multiple__ HTTP requests. Interactive transactions are not implemented by RavenDB - (see [below](../../client-api/faq/transaction-support.mdx#no-support-for-interactive-transactions) for the reasoning behind this decision). + (see [below](#no-support-for-interactive-transactions) for the reasoning behind this decision). RavenDB offers [optimistic concurrency](../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx) feature to achieve similar behavior. * The [Client API Session](../../client-api/session/what-is-a-session-and-how-does-it-work.mdx) is a pure Client API object and does not represent a transaction, @@ -140,7 +140,7 @@ so you can utilize RavenDB for each of your scenarios: When running in a multi-node setup, RavenDB still uses transactions. However, they are single-node transactions. That means that the set of changes that you write in a transaction is committed only to the node you are writing to. It will then asynchronously replicate to the other nodes. -To achieve consistency across the entire cluster please refer to the [Cluster-wide transactions](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions) section below. +To achieve consistency across the entire cluster please refer to the [Cluster-wide transactions](#cluster-wide-transactions) section below. #### Replication conflicts @@ -158,14 +158,14 @@ This behavior was influenced by the [Dynamo paper](https://dl.acm.org/doi/10.114 The assumption is that if you are writing data to the database, you expect it to be persisted. RavenDB will do its utmost to provide that to you, allowing you to write to the database even in the case of partitions or partial failure states. -However, handling replication conflicts is a consideration you have to take into account when using single-node transactions in RavenDB (see below for running a [cluster-wide transaction](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions)). +However, handling replication conflicts is a consideration you have to take into account when using single-node transactions in RavenDB (see below for running a [cluster-wide transaction](#cluster-wide-transactions)). If no conflict resolution script is defined for a collection, then by default RavenDB resolves the conflict using the latest version based on the `@last-modified` property of conflicted versions of the document. That might result in the lost update anomaly. -If you care about avoiding lost updates, you need to ensure you have the conflict resolution script defined accordingly or use a [cluster-wide transaction](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions). +If you care about avoiding lost updates, you need to ensure you have the conflict resolution script defined accordingly or use a [cluster-wide transaction](#cluster-wide-transactions). diff --git a/versioned_docs/version-6.2/client-api/faq/what-is-a-collection.mdx b/versioned_docs/version-6.2/client-api/faq/what-is-a-collection.mdx index ad8f4c3bba..9bb3249e74 100644 --- a/versioned_docs/version-6.2/client-api/faq/what-is-a-collection.mdx +++ b/versioned_docs/version-6.2/client-api/faq/what-is-a-collection.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Collections are used throughout many RavenDB features, such as defining indexes, setting revisions, and much more. * In this page: - * [Collection Name Generation](../../client-api/faq/what-is-a-collection.mdx#collection-name-generation) - * [Collection Usages](../../client-api/faq/what-is-a-collection.mdx#collection-usages) + * [Collection Name Generation](#collection-name-generation) + * [Collection Usages](#collection-usages) * For more information see [Documents and Collections](../../studio/database/documents/documents-and-collections.mdx) diff --git a/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-csharp.mdx b/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-csharp.mdx index 3ffd427a6a..cc93a5a029 100644 --- a/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-csharp.mdx @@ -18,14 +18,14 @@ When applied correctly, they can drastically improve performance, reduce network * In this page: - * [Denormalization](../../../client-api/how-to/handle-document-relationships.mdx#denormalization) - * [Includes](../../../client-api/how-to/handle-document-relationships.mdx#includes) - * [One to many includes](../../../client-api/how-to/handle-document-relationships.mdx#one-to-many-includes) - * [Secondary level includes](../../../client-api/how-to/handle-document-relationships.mdx#secondary-level-includes) - * [Dictionary includes](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes) - * [Dictionary includes: complex types](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes-complex-types) - * [Combining approaches](../../../client-api/how-to/handle-document-relationships.mdx#combining-approaches) - * [Summary](../../../client-api/how-to/handle-document-relationships.mdx#summary) + * [Denormalization](#denormalization) + * [Includes](#includes) + * [One to many includes](#one-to-many-includes) + * [Secondary level includes](#secondary-level-includes) + * [Dictionary includes](#dictionary-includes) + * [Dictionary includes: complex types](#dictionary-includes-complex-types) + * [Combining approaches](#combining-approaches) + * [Summary](#summary) ## Denormalization diff --git a/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-nodejs.mdx b/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-nodejs.mdx index 4a205d6255..945819f044 100644 --- a/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/content/_handle-document-relationships-nodejs.mdx @@ -18,14 +18,14 @@ When applied correctly, they can drastically improve performance, reduce network * In this page: - * [Denormalization](../../../client-api/how-to/handle-document-relationships.mdx#denormalization) - * [Includes](../../../client-api/how-to/handle-document-relationships.mdx#includes) - * [One to many includes](../../../client-api/how-to/handle-document-relationships.mdx#one-to-many-includes) - * [Secondary level includes](../../../client-api/how-to/handle-document-relationships.mdx#secondary-level-includes) - * [Dictionary includes](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes) - * [Dictionary includes: complex types](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes-complex-types) - * [Combining approaches](../../../client-api/how-to/handle-document-relationships.mdx#combining-approaches) - * [Summary](../../../client-api/how-to/handle-document-relationships.mdx#summary) + * [Denormalization](#denormalization) + * [Includes](#includes) + * [One to many includes](#one-to-many-includes) + * [Secondary level includes](#secondary-level-includes) + * [Dictionary includes](#dictionary-includes) + * [Dictionary includes: complex types](#dictionary-includes-complex-types) + * [Combining approaches](#combining-approaches) + * [Summary](#summary) ## Denormalization diff --git a/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx b/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx index 2e3d414e16..e5d629c773 100644 --- a/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx @@ -22,24 +22,24 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Use convention defaults](../../../client-api/how-to/setup-aggressive-caching.mdx#use-convention-defaults) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Use convention defaults](#use-convention-defaults) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -102,7 +102,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-java.mdx b/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-java.mdx index fa861e4eff..c61de29c45 100644 --- a/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-java.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/content/_setup-aggressive-caching-java.mdx @@ -22,24 +22,24 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Use convention defaults](../../../client-api/how-to/setup-aggressive-caching.mdx#use-convention-defaults) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Use convention defaults](#use-convention-defaults) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -102,7 +102,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/versioned_docs/version-6.2/client-api/how-to/integrate-with-excel.mdx b/versioned_docs/version-6.2/client-api/how-to/integrate-with-excel.mdx index b1ad71734d..b9eb8e68cd 100644 --- a/versioned_docs/version-6.2/client-api/how-to/integrate-with-excel.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/integrate-with-excel.mdx @@ -39,7 +39,7 @@ In order to include only specific properties in the CSV output you can use the ` -In some cases it might be cumbersome to use the URL to send the query or the query might be too long. Please see our [dedicated section](../../client-api/how-to/integrate-with-excel.mdx#dealing-with-long-query-urls-in-excel) that deals with that problem. +In some cases it might be cumbersome to use the URL to send the query or the query might be too long. Please see our [dedicated section](#dealing-with-long-query-urls-in-excel) that deals with that problem. diff --git a/versioned_docs/version-6.2/client-api/how-to/subscribe-to-store-events.mdx b/versioned_docs/version-6.2/client-api/how-to/subscribe-to-store-events.mdx index 5dc7776f4a..68d118e3c8 100644 --- a/versioned_docs/version-6.2/client-api/how-to/subscribe-to-store-events.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/subscribe-to-store-events.mdx @@ -28,18 +28,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about session events [here](../../client-api/session/how-to/subscribe-to-events.mdx). * In this article: - * [Store events](../../client-api/how-to/subscribe-to-store-events.mdx#store-events) - * [OnBeforeRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onbeforerequest) - * [OnSucceedRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onsucceedrequest) - * [AfterDispose](../../client-api/how-to/subscribe-to-store-events.mdx#afterdispose) - * [BeforeDispose](../../client-api/how-to/subscribe-to-store-events.mdx#beforedispose) - * [RequestExecutorCreated](../../client-api/how-to/subscribe-to-store-events.mdx#requestexecutorcreated) - * [OnSessionCreated](../../client-api/how-to/subscribe-to-store-events.mdx#onsessioncreated) - * [OnFailedRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onfailedrequest) - * [OnTopologyUpdated](../../client-api/how-to/subscribe-to-store-events.mdx#ontopologyupdated) - * [Store/Session events](../../client-api/how-to/subscribe-to-store-events.mdx#storesession-events) - * [Unsubscribing from an event](../../client-api/how-to/subscribe-to-store-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../client-api/how-to/subscribe-to-store-events.mdx#syntax) + * [Store events](#store-events) + * [OnBeforeRequest](#onbeforerequest) + * [OnSucceedRequest](#onsucceedrequest) + * [AfterDispose](#afterdispose) + * [BeforeDispose](#beforedispose) + * [RequestExecutorCreated](#requestexecutorcreated) + * [OnSessionCreated](#onsessioncreated) + * [OnFailedRequest](#onfailedrequest) + * [OnTopologyUpdated](#ontopologyupdated) + * [Store/Session events](#storesession-events) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/how-to/using-timeonly-and-dateonly.mdx b/versioned_docs/version-6.2/client-api/how-to/using-timeonly-and-dateonly.mdx index 67c27f3495..601c01d458 100644 --- a/versioned_docs/version-6.2/client-api/how-to/using-timeonly-and-dateonly.mdx +++ b/versioned_docs/version-6.2/client-api/how-to/using-timeonly-and-dateonly.mdx @@ -21,16 +21,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can now convert `DateTime` or strings written in date/time formats to .NET's `DateOnly` or `TimeOnly` types without slowing down queries and while leaving your existing data as is. - * Use `AsDateOnly` or `AsTimeOnly` in a static index ([see examples below](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime)) + * Use `AsDateOnly` or `AsTimeOnly` in a static index ([see examples below](#use--or--in-a-static-index-to-convert-strings-or-datetime)) * `AsDateOnly` and `AsTimeOnly` automatically convert strings to ticks for faster querying. * We convert the types in [static indexes](../../indexes/map-indexes.mdx) so that the conversions and calculations are done behind the scenes and the data is ready for fast queries. ([See sample index below.](../../client-api/how-to/using-timeonly-and-dateonly.mdx#convert-and-use-date/timeonly-without-affecting-your-existing-data)) * In this page: - * [About DateOnly and TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#about-dateonly-and-timeonly) + * [About DateOnly and TimeOnly](#about-dateonly-and-timeonly) * [Convert and Use Date/TimeOnly Without Affecting Your Existing Data](../../client-api/how-to/using-timeonly-and-dateonly.mdx#convert-and-use-date/timeonly-without-affecting-your-existing-data) - * [Using already existing DateOnly or TimeOnly fields](../../client-api/how-to/using-timeonly-and-dateonly.mdx#using-already-existing-dateonly-or-timeonly-fields) + * [Using already existing DateOnly or TimeOnly fields](#using-already-existing-dateonly-or-timeonly-fields) @@ -54,7 +54,7 @@ These two new C# types are available from .NET 6.0+ (RavenDB 5.3+). ## Convert and Use Date/TimeOnly Without Affecting Your Existing Data -RavenDB offers conversion of types in static indexes with the methods [AsDateOnly or AsTimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime). +RavenDB offers conversion of types in static indexes with the methods [AsDateOnly or AsTimeOnly](#use--or--in-a-static-index-to-convert-strings-or-datetime). * [Static indexes](../../indexes/indexing-basics.mdx) process new data in the background, including calculations and conversions to DateOnly/TimeOnly values, which can be used as ticks, @@ -78,8 +78,8 @@ though comparing ticks is faster. ### Use `AsDateOnly` or `AsTimeOnly` in a static index to convert strings or DateTime -* [Converting Strings to DateOnly or TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#converting-strings-with-minimal-cost) -* [Converting DateTime to DateOnly or TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#converting--with-minimal-cost) +* [Converting Strings to DateOnly or TimeOnly](#converting-strings-with-minimal-cost) +* [Converting DateTime to DateOnly or TimeOnly](#converting--with-minimal-cost) #### Converting Strings with minimal cost @@ -272,7 +272,7 @@ var result = session **Querying on Ticks** -Strings are automatically converted to ticks with [`AsDateOnly` and `AsTimeOnly`](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime). +Strings are automatically converted to ticks with [`AsDateOnly` and `AsTimeOnly`](#use--or--in-a-static-index-to-convert-strings-or-datetime). diff --git a/versioned_docs/version-6.2/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx index 6602b5c804..ab355e8c7a 100644 --- a/versioned_docs/version-6.2/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Delete attachment example](../../../../client-api/operations/attachments/delete-attachment.mdx#delete-attachment-example) - * [Syntax](../../../../client-api/operations/attachments/delete-attachment.mdx#syntax) + * [Delete attachment example](#delete-attachment-example) + * [Syntax](#syntax) ## Delete attachment example diff --git a/versioned_docs/version-6.2/client-api/operations/attachments/content/_get-attachment-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/attachments/content/_get-attachment-nodejs.mdx index a839aad662..d8debbd91d 100644 --- a/versioned_docs/version-6.2/client-api/operations/attachments/content/_get-attachment-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/attachments/content/_get-attachment-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get attachment example](../../../../client-api/operations/attachments/get-attachment.mdx#get-attachment-example) - * [Syntax](../../../../client-api/operations/attachments/get-attachment.mdx#syntax) + * [Get attachment example](#get-attachment-example) + * [Syntax](#syntax) ## Get attachment example diff --git a/versioned_docs/version-6.2/client-api/operations/attachments/content/_put-attachment-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/attachments/content/_put-attachment-nodejs.mdx index 68bafb96c0..6b136549d6 100644 --- a/versioned_docs/version-6.2/client-api/operations/attachments/content/_put-attachment-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/attachments/content/_put-attachment-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put attachment example](../../../../client-api/operations/attachments/put-attachment.mdx#put-attachment-example) - * [Syntax](../../../../client-api/operations/attachments/put-attachment.mdx#syntax) + * [Put attachment example](#put-attachment-example) + * [Syntax](#syntax) ## Put attachment example diff --git a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-csharp.mdx index bd1d76c763..62341d04b1 100644 --- a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-csharp.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-nodejs.mdx index 446cd4153b..307263e246 100644 --- a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-nodejs.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-php.mdx b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-php.mdx index e750c7f5a2..d829fe1ee5 100644 --- a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-php.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-python.mdx b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-python.mdx index 00995b1124..e507d60583 100644 --- a/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/common/content/_delete-by-query-python.mdx @@ -25,8 +25,8 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-expiration-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-expiration-csharp.mdx index a55a46666e..5d1f105216 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-expiration-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-expiration-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `@expires` field in a [compare exchange value's metadata](../../../../client-api/operations/compare-exchange/compare-exchange-metadata.mdx) to schedule its expiration. * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/compare-exchange-expiration.mdx#syntax) - * [Examples](../../../../client-api/operations/compare-exchange/compare-exchange-expiration.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-metadata-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-metadata-csharp.mdx index 73dce9eeda..8fb55cc745 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-metadata-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_compare-exchange-metadata-csharp.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB 5.0 added metadata to compare exchange values. * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/compare-exchange-metadata.mdx#syntax) + * [Syntax](#syntax) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-csharp.mdx index 0c3fd8e322..f1648510bd 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-csharp.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#syntax) - * [Example](../../../../client-api/operations/compare-exchange/delete-compare-exchange-value.mdx#example) + * [Example](#example) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-java.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-java.mdx index 9641df6d25..760e48904e 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-java.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#syntax) - * [Example](../../../../client-api/operations/compare-exchange/delete-compare-exchange-value.mdx#example) + * [Example](#example) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-nodejs.mdx index 0640dd105b..d39fde2c1f 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_delete-compare-exchange-value-nodejs.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; or from the [Studio](../../../../studio/database/documents/compare-exchange-view.mdx). * In this page: - * [Delete compare exchange item](../../../../client-api/operations/compare-exchange/delete-compare-exchange-value.mdx#delete-compare-exchange-item) - * [Syntax](../../../../client-api/operations/compare-exchange/delete-compare-exchange-value.mdx#syntax) + * [Delete compare exchange item](#delete-compare-exchange-item) + * [Syntax](#syntax) ## Delete compare exchange item diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-csharp.mdx index f2e2de48a3..13cda9e7d4 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the 'Compare Exchange' feature click: [Compare Exchange Overview](../../../../client-api/operations/compare-exchange/overview.mdx) * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#syntax) - * [Example I - Value is 'long'](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#example-i---value-is-) - * [Example II - Value is a custom object](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#example-ii---value-is-a-custom-object) + * [Syntax](#syntax) + * [Example I - Value is 'long'](#example-i---value-is-) + * [Example II - Value is a custom object](#example-ii---value-is-a-custom-object) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-java.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-java.mdx index e9c6da07f2..be8c769481 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-java.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the 'Compare Exchange' feature click: [Compare Exchange Overview](../../../../client-api/operations/compare-exchange/overview.mdx) * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#syntax) - * [Example I - Value is 'long'](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#example-i---value-is-) - * [Example II - Value is a custom object](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#example-ii---value-is-a-custom-object) + * [Syntax](#syntax) + * [Example I - Value is 'long'](#example-i---value-is-) + * [Example II - Value is a custom object](#example-ii---value-is-a-custom-object) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-nodejs.mdx index 0d797c3ec7..791b104ab0 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-value-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; or from the [Studio](../../../../studio/database/documents/compare-exchange-view.mdx). * In this page: - * [Examples](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#examples) - * [Get cmpXchg item that has a number and metadata](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#get-cmpxchg-item-that-has-a-number-and-metadata) - * [Get cmpXchg item that has an object](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#get-cmpxchg-item-that-has-an-object) - * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-value.mdx#syntax) + * [Examples](#examples) + * [Get cmpXchg item that has a number and metadata](#get-cmpxchg-item-that-has-a-number-and-metadata) + * [Get cmpXchg item that has an object](#get-cmpxchg-item-that-has-an-object) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-csharp.mdx index 10fd3d72eb..8273c47086 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the 'Compare Exchange' feature click: [Compare Exchange Overview](../../../../client-api/operations/compare-exchange/overview.mdx) * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#syntax) - * [Example I - Get Values for Specified Keys](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#example-i---get-values-for-specified-keys) - * [Example II - Get Values for Keys with Common Prefix](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#example-ii---get-values-for-keys-with-common-prefix) + * [Syntax](#syntax) + * [Example I - Get Values for Specified Keys](#example-i---get-values-for-specified-keys) + * [Example II - Get Values for Keys with Common Prefix](#example-ii---get-values-for-keys-with-common-prefix) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-java.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-java.mdx index b75ddbeccd..c6bb00733d 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-java.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the 'Compare Exchange' feature click: [Compare Exchange Overview](../../../../client-api/operations/compare-exchange/overview.mdx) * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#syntax) - * [Example I - Get Value for Specified Keys](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#example-i---get-values-for-specified-keys) - * [Example II - Get Values for Keys with Common Prefix](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#example-ii---get-values-for-keys-with-common-prefix) + * [Syntax](#syntax) + * [Example I - Get Value for Specified Keys](#example-i---get-values-for-specified-keys) + * [Example II - Get Values for Keys with Common Prefix](#example-ii---get-values-for-keys-with-common-prefix) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-nodejs.mdx index d2e02fb1d7..862040ea50 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_get-compare-exchange-values-nodejs.mdx @@ -14,10 +14,10 @@ import CodeBlock from '@theme/CodeBlock'; or from the [Studio](../../../../studio/database/documents/compare-exchange-view.mdx). * In this page: - * [Examples](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#examples) - * [Get cmpXchg items for specified keys](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#get-cmpxchg-items-for-specified-keys) - * [Get cmpXchg items for keys with common prefix](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#get-cmpxchg-items-for-keys-with-common-prefix) - * [Syntax](../../../../client-api/operations/compare-exchange/get-compare-exchange-values.mdx#syntax) + * [Examples](#examples) + * [Get cmpXchg items for specified keys](#get-cmpxchg-items-for-specified-keys) + * [Get cmpXchg items for keys with common prefix](#get-cmpxchg-items-for-keys-with-common-prefix) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-csharp.mdx index a3573c51f3..4a906e2083 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * The Compare Exchange include syntax is based on the [include method](../../../../client-api/how-to/handle-document-relationships.mdx#includes). * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#syntax) - * [Examples](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax @@ -58,7 +58,7 @@ followed by `cmpxchg()` to include a compare exchange value: In [javascript functions](../../../../client-api/session/querying/what-is-rql.mdx#declare) within queries, use `includes.cmpxchg()` (see the RawQuery example -[below](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#examples)): +[below](#examples)): diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-nodejs.mdx index 55fd031554..38a3fcce6d 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_include-compare-exchange-nodejs.mdx @@ -13,10 +13,10 @@ import CodeBlock from '@theme/CodeBlock'; in that Session without making an additional call to the server. * In this page: - * [Sample data](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#sample-data) - * [Include CmpXchg items when loading](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#include-cmpxchg-items-when-loading) - * [Include CmpXchg items when querying](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#include-cmpxchg-items-when-querying) - * [Syntax](../../../../client-api/operations/compare-exchange/include-compare-exchange.mdx#syntax) + * [Sample data](#sample-data) + * [Include CmpXchg items when loading](#include-cmpxchg-items-when-loading) + * [Include CmpXchg items when querying](#include-cmpxchg-items-when-querying) + * [Syntax](#syntax) ## Sample data diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-csharp.mdx index 7d711cae44..f844cf63a7 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-csharp.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * Compare-exchange items can be used to coordinate work between sessions that are trying to modify a shared resource (such as a document) at the same time. -* Compare-exchange items are [not replicated externally](../../../../client-api/operations/compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this page: -* [What Compare Exchange Items Are](../../../../client-api/operations/compare-exchange/overview.mdx#what-compare-exchange-items-are) -* [Creating and Managing Compare-Exchange Items](../../../../client-api/operations/compare-exchange/overview.mdx#creating-and-managing-compare-exchange-items) -* [Why Compare-Exchange Items are Not Replicated to External Databases](../../../../client-api/operations/compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) -* [Example I - Email Address Reservation](../../../../client-api/operations/compare-exchange/overview.mdx#example-i---email-address-reservation) -* [Example II - Reserve a Shared Resource](../../../../client-api/operations/compare-exchange/overview.mdx#example-ii---reserve-a-shared-resource) -* [Example III - Ensuring Unique Values without Using Compare Exchange](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange) +* [What Compare Exchange Items Are](#what-compare-exchange-items-are) +* [Creating and Managing Compare-Exchange Items](#creating-and-managing-compare-exchange-items) +* [Why Compare-Exchange Items are Not Replicated to External Databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) +* [Example I - Email Address Reservation](#example-i---email-address-reservation) +* [Example II - Reserve a Shared Resource](#example-ii---reserve-a-shared-resource) +* [Example III - Ensuring Unique Values without Using Compare Exchange](#example-iii---ensuring-unique-values-without-using-compare-exchange) ## What Compare Exchange Items Are @@ -84,7 +84,7 @@ Compare exchange items are created and managed with any of the following approac Change-Vector. Compare-exchange conflicts cannot be handled properly as they do not have a similar mechanism to resolve conflicts. -* To ensure unique values between two databases without using compare-exchange items see [Example III](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange). +* To ensure unique values between two databases without using compare-exchange items see [Example III](#example-iii---ensuring-unique-values-without-using-compare-exchange). @@ -94,7 +94,7 @@ The following example shows how to use compare-exchange to create documents with The scope is within the database group on a single cluster. Compare-exchange items are not externally replicated to other databases. -To establish uniqueness without using compare-exchange see [Example III](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange). +To establish uniqueness without using compare-exchange see [Example III](#example-iii---ensuring-unique-values-without-using-compare-exchange). diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-java.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-java.mdx index 951d3fdba0..910caf0623 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-java.mdx @@ -24,11 +24,11 @@ Compare exchange entries that are automatically administered by RavenDB are call * In this page: - * [Compare Exchange Transaction Scope](../../../../client-api/operations/compare-exchange/overview.mdx#compare-exchange-transaction-scope) - * [Creating a Key](../../../../client-api/operations/compare-exchange/overview.mdx#creating-a-key) - * [Updating a Key](../../../../client-api/operations/compare-exchange/overview.mdx#updating-a-key) - * [Example I - Email Address Reservation](../../../../client-api/operations/compare-exchange/overview.mdx#example-i---email-address-reservation) - * [Example II- Reserve a Shared Resource](../../../../client-api/operations/compare-exchange/overview.mdx#example-ii---reserve-a-shared-resource) + * [Compare Exchange Transaction Scope](#compare-exchange-transaction-scope) + * [Creating a Key](#creating-a-key) + * [Updating a Key](#updating-a-key) + * [Example I - Email Address Reservation](#example-i---email-address-reservation) + * [Example II- Reserve a Shared Resource](#example-ii---reserve-a-shared-resource) ## Compare Exchange Transaction Scope diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-php.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-php.mdx index 0ed15417e1..bce4b80ee0 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-php.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * Compare-exchange items can be used to coordinate work between sessions that are trying to modify a shared resource (such as a document) at the same time. -* Compare-exchange items are [not replicated externally](../../../../client-api/operations/compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this page: -* [What Compare Exchange Items Are](../../../../client-api/operations/compare-exchange/overview.mdx#what-compare-exchange-items-are) -* [Creating and Managing Compare-Exchange Items](../../../../client-api/operations/compare-exchange/overview.mdx#creating-and-managing-compare-exchange-items) -* [Why Compare-Exchange Items are Not Replicated to External Databases](../../../../client-api/operations/compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) -* [Example I - Email Address Reservation](../../../../client-api/operations/compare-exchange/overview.mdx#example-i---email-address-reservation) -* [Example II - Reserve a Shared Resource](../../../../client-api/operations/compare-exchange/overview.mdx#example-ii---reserve-a-shared-resource) -* [Example III - Ensuring Unique Values without Using Compare Exchange](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange) +* [What Compare Exchange Items Are](#what-compare-exchange-items-are) +* [Creating and Managing Compare-Exchange Items](#creating-and-managing-compare-exchange-items) +* [Why Compare-Exchange Items are Not Replicated to External Databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) +* [Example I - Email Address Reservation](#example-i---email-address-reservation) +* [Example II - Reserve a Shared Resource](#example-ii---reserve-a-shared-resource) +* [Example III - Ensuring Unique Values without Using Compare Exchange](#example-iii---ensuring-unique-values-without-using-compare-exchange) ## What Compare Exchange Items Are @@ -84,7 +84,7 @@ Compare exchange items are created and managed with any of the following approac Change-Vector. Compare-exchange conflicts cannot be handled properly as they do not have a similar mechanism to resolve conflicts. -* To ensure unique values between two databases without using compare-exchange items see [Example III](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange). +* To ensure unique values between two databases without using compare-exchange items see [Example III](#example-iii---ensuring-unique-values-without-using-compare-exchange). @@ -94,7 +94,7 @@ The following example shows how to use compare-exchange to create documents with The scope is within the database group on a single cluster. Compare-exchange items are not externally replicated to other databases. -To establish uniqueness without using compare-exchange see [Example III](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange). +To establish uniqueness without using compare-exchange see [Example III](#example-iii---ensuring-unique-values-without-using-compare-exchange). diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-python.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-python.mdx index 2f10acc812..9cefecd838 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_overview-python.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * Compare-exchange items can be used to coordinate work between sessions that are trying to modify a shared resource (such as a document) at the same time. -* Compare-exchange items are [not replicated externally](../../../../client-api/operations/compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this page: -* [What Compare Exchange Items Are](../../../../client-api/operations/compare-exchange/overview.mdx#what-compare-exchange-items-are) -* [Creating and Managing Compare-Exchange Items](../../../../client-api/operations/compare-exchange/overview.mdx#creating-and-managing-compare-exchange-items) -* [Why Compare-Exchange Items are Not Replicated to External Databases](../../../../client-api/operations/compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) -* [Example I - Email Address Reservation](../../../../client-api/operations/compare-exchange/overview.mdx#example-i---email-address-reservation) -* [Example II - Reserve a Shared Resource](../../../../client-api/operations/compare-exchange/overview.mdx#example-ii---reserve-a-shared-resource) -* [Example III - Ensuring Unique Values without Using Compare Exchange](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange) +* [What Compare Exchange Items Are](#what-compare-exchange-items-are) +* [Creating and Managing Compare-Exchange Items](#creating-and-managing-compare-exchange-items) +* [Why Compare-Exchange Items are Not Replicated to External Databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) +* [Example I - Email Address Reservation](#example-i---email-address-reservation) +* [Example II - Reserve a Shared Resource](#example-ii---reserve-a-shared-resource) +* [Example III - Ensuring Unique Values without Using Compare Exchange](#example-iii---ensuring-unique-values-without-using-compare-exchange) ## What Compare Exchange Items Are @@ -84,7 +84,7 @@ Compare exchange items are created and managed with any of the following approac Change-Vector. Compare-exchange conflicts cannot be handled properly as they do not have a similar mechanism to resolve conflicts. -* To ensure unique values between two databases without using compare-exchange items see [Example III](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange). +* To ensure unique values between two databases without using compare-exchange items see [Example III](#example-iii---ensuring-unique-values-without-using-compare-exchange). @@ -94,7 +94,7 @@ The following example shows how to use compare-exchange to create documents with The scope is within the database group on a single cluster. Compare-exchange items are not externally replicated to other databases. -To establish uniqueness without using compare-exchange see [Example III](../../../../client-api/operations/compare-exchange/overview.mdx#example-iii---ensuring-unique-values-without-using-compare-exchange). +To establish uniqueness without using compare-exchange see [Example III](#example-iii---ensuring-unique-values-without-using-compare-exchange). diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-csharp.mdx index cc93fd0806..7fc2331c98 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-csharp.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the 'Compare Exchange' feature see: [Compare Exchange Overview](../../../../client-api/operations/compare-exchange/overview.mdx). * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#syntax) - * [Example I - Create a new key](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#example-i---create-a-new-key) - * [Example II - Update an existing key](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#example-ii---update-an-existing-key) - * [Example III - Try to create an item with a non-zero index](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#example-iii---try-to-create-an-item-with-a-non-zero-index) + * [Syntax](#syntax) + * [Example I - Create a new key](#example-i---create-a-new-key) + * [Example II - Update an existing key](#example-ii---update-an-existing-key) + * [Example III - Try to create an item with a non-zero index](#example-iii---try-to-create-an-item-with-a-non-zero-index) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-java.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-java.mdx index 9fad77aa71..1da4f94038 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-java.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the 'Compare Exchange' feature see: [Compare Exchange Overview](../../../../client-api/operations/compare-exchange/overview.mdx). * In this page: - * [Syntax](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#syntax) - * [Example I - Create a new key](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#example-i---create-a-new-key) - * [Example II - Update an existing key](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#example-ii---update-an-existing-key) + * [Syntax](#syntax) + * [Example I - Create a new key](#example-i---create-a-new-key) + * [Example II - Update an existing key](#example-ii---update-an-existing-key) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-nodejs.mdx index 48e9bba972..955322c4af 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/content/_put-compare-exchange-value-nodejs.mdx @@ -14,10 +14,10 @@ import CodeBlock from '@theme/CodeBlock'; or from the [Studio](../../../../studio/database/documents/compare-exchange-view.mdx). * In this page: - * [Create new cmpXchg item](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#create-new-cmpxchg-item) - * [Create new cmpXchg item with metadata](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#create-new-cmpxchg-item-with-metadata) - * [Update existing cmpXchg item](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#update-existing-cmpxchg-item) - * [Syntax](../../../../client-api/operations/compare-exchange/put-compare-exchange-value.mdx#syntax) + * [Create new cmpXchg item](#create-new-cmpxchg-item) + * [Create new cmpXchg item with metadata](#create-new-cmpxchg-item-with-metadata) + * [Update existing cmpXchg item](#update-existing-cmpxchg-item) + * [Syntax](#syntax) ## Create new cmpXchg item diff --git a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-csharp.mdx index 0e38d5309e..58aa3375a1 100644 --- a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-csharp.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#kill-operation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#kill-operation) ## Why use operations @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `Send` method on the `Operations` property in the DocumentStore. @@ -186,7 +186,7 @@ Task> SendAsync(PatchOperation * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `Send` method on the `Maintenance` property in the DocumentStore. @@ -381,7 +381,7 @@ Task SendAsync(IMaintenanceOperation operation, Use [ForNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `Send` method on the `Maintenance.Server` property in the DocumentStore. diff --git a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-nodejs.mdx index 20bfc3adea..c4d4f5bf4b 100644 --- a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-nodejs.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * __Operation types__: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#killoperation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#killoperation) ## Why use operations @@ -56,7 +56,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * __Background operations__: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property in the DocumentStore. @@ -161,7 +161,7 @@ await send(patchOperation, sessionInfo, resultType); * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -327,7 +327,7 @@ __Send syntax__: Use [forNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-php.mdx b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-php.mdx index bee9388fef..e2cfb286d1 100644 --- a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-php.mdx @@ -14,14 +14,14 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) ## Why use operations @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property in the DocumentStore. @@ -155,7 +155,7 @@ public function send(...$parameters); * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -316,7 +316,7 @@ $status = $indexStats->getStatus(); // will be "Paused" Use [forNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-python.mdx b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-python.mdx index ac868886e1..1e453bbe2d 100644 --- a/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/content/_what-are-operations-python.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#kill-operation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#kill-operation) ## Why use operations @@ -58,7 +58,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property in the DocumentStore. @@ -155,7 +155,7 @@ def send_patch_operation_with_entity_class( * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -317,7 +317,7 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper Use [for_node](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx index e0d0512557..a612588a1d 100644 --- a/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server-maintenance operations - ForNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server-maintenance operations - ForNode](#server-maintenance-operations---fornode) ## Server maintenance operations - ForNode diff --git a/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx index 550e850c3e..98a9a1aa1b 100644 --- a/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server maintenance operations - forNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server maintenance operations - forNode](#server-maintenance-operations---fornode) ## Server maintenance operations - forNode diff --git a/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx b/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx index 5744f29c27..bc63cb591a 100644 --- a/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server-maintenance operations - ForNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server-maintenance operations - ForNode](#server-maintenance-operations---fornode) ## Server maintenance operations - ForNode diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/backup-overview.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/backup-overview.mdx index 83050a936e..6fd9df2996 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/backup-overview.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/backup-overview.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * RavenDB's Backup task is an [Ongoing-Task](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx) designed to run periodically on a pre-defined schedule. You can run it as a one-time operation as well, by using [Export](../../../../client-api/smuggler/what-is-smuggler.mdx#export) - or executing a backup task [immediately](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution). + or executing a backup task [immediately](#initiate-immediate-backup-execution). * On a [sharded](../../../../sharding/overview.mdx) database, a single backup task is defined by the user for all shards, and RavenDB automatically defines @@ -27,18 +27,18 @@ import LanguageContent from "@site/src/components/LanguageContent"; Read about backups on a sharded database [in the section dedicated to it](../../../../sharding/backup-and-restore/backup.mdx). * In this page: - * [Backup Types](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-types) - * [Logical-Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup) - * [Snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) - * [Backup Scope](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-scope) - * [Full Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#full-backup) - * [Incremental Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup) - * [Backup to Local and Remote Destinations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations) - * [Backup Retention Policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy) - * [Server-Wide Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#server-wide-backup) - * [Initiate Immediate Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution) - * [Delay Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#delay-backup-execution) - * [Recommended Precautions](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#recommended-precautions) + * [Backup Types](#backup-types) + * [Logical-Backup](#logical-backup) + * [Snapshot](#snapshot) + * [Backup Scope](#backup-scope) + * [Full Backup](#full-backup) + * [Incremental Backup](#incremental-backup) + * [Backup to Local and Remote Destinations](#backup-to-local-and-remote-destinations) + * [Backup Retention Policy](#backup-retention-policy) + * [Server-Wide Backup](#server-wide-backup) + * [Initiate Immediate Backup Execution](#initiate-immediate-backup-execution) + * [Delay Backup Execution](#delay-backup-execution) + * [Recommended Precautions](#recommended-precautions) ## Backup Types @@ -110,7 +110,7 @@ var result = await docStore.Maintenance.SendAsync(operation); * If Incremental backups are created for a Snapshot-type backup: * The first backup will be a full Snapshot. * The following backups will be Incremental. - * [Incremental backups](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup) + * [Incremental backups](#incremental-backup) have different storage contents than Snapshots. * Code Sample: @@ -360,7 +360,7 @@ The retention policy is a property of `PeriodicBackupConfiguration`: You can create a Server-Wide Backup task to back-up **all the databases in your cluster** at a scheduled time. Individual databases can be excluded from the backup. Learn more in [Studio: Server-Wide Backup](../../../../studio/server/server-wide-backup.mdx). -Backups can be made locally, as well as to a [set of remote locations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations). +Backups can be made locally, as well as to a [set of remote locations](#backup-to-local-and-remote-destinations). #### Examples @@ -584,7 +584,7 @@ await docStore.Maintenance.SendAsync( * An ACIDity of backed-up data, to keep its independence during restoration. * **Remove old backup files regularly**. - Set the [backup retention policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy) + Set the [backup retention policy](#backup-retention-policy) to remove unneeded backup files so that they don't build up. While setting how many days to keep your backups, consider how much of a recent database history you would like to have access to. diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/encrypted-backup.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/encrypted-backup.mdx index 7b83b8d266..a2e39af32e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/encrypted-backup.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/encrypted-backup.mdx @@ -28,19 +28,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; using the same encryption key provided for the full backup. * In this page: - * [RavenDB's Security Approach](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#ravendb) - * [Secure Client-Server Communication](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#secure-client-server-communication) - * [Database Encryption](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#database-encryption) - * [Backup-Encryption Overview](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#backup-encryption-overview) - * [Prerequisites to Encrypting Backups](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#prerequisites-to-encrypting-backups) - * [Choosing Encryption Mode & Key](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#choosing-encryption-mode--key) - * [Creating an Encrypted Logical-Backup](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#creating-an-encrypted-logical-backup) - * [For a Non-Encrypted Database](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#for-a-non-encrypted-database) - * [For an Encrypted Database](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#for-an-encrypted-database) - * [Creating an Encrypted Snapshot](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#creating-an-encrypted-snapshot) - * [Restoring an Encrypted Backup](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-backup) - * [Restoring an encrypted Logical-Backup](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-logical-backup) - * [Restoring a Snapshot](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-a-snapshot) + * [RavenDB's Security Approach](#ravendb) + * [Secure Client-Server Communication](#secure-client-server-communication) + * [Database Encryption](#database-encryption) + * [Backup-Encryption Overview](#backup-encryption-overview) + * [Prerequisites to Encrypting Backups](#prerequisites-to-encrypting-backups) + * [Choosing Encryption Mode & Key](#choosing-encryption-mode--key) + * [Creating an Encrypted Logical-Backup](#creating-an-encrypted-logical-backup) + * [For a Non-Encrypted Database](#for-a-non-encrypted-database) + * [For an Encrypted Database](#for-an-encrypted-database) + * [Creating an Encrypted Snapshot](#creating-an-encrypted-snapshot) + * [Restoring an Encrypted Backup](#restoring-an-encrypted-backup) + * [Restoring an encrypted Logical-Backup](#restoring-an-encrypted-logical-backup) + * [Restoring a Snapshot](#restoring-a-snapshot) ## RavenDB's Security Approach @@ -87,7 +87,7 @@ Secure the data stored on the server by * **Secure communication to enable database encryption.** An encrypted database can only be created when the - [client-server communication is secure](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#secure-client-server-communication). + [client-server communication is secure](#secure-client-server-communication). @@ -286,7 +286,7 @@ docStore.Maintenance.Server.Send(restoreBackupTask); #### Restoring an encrypted Logical-Backup -A database is [restored](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-backup) from a logical-backup +A database is [restored](#restoring-an-encrypted-backup) from a logical-backup to its **unencrypted** form. To restore a database and encrypt its contents, you have to address it explicitly. @@ -325,7 +325,7 @@ docStore.Maintenance.Server.Send(restoreBackupTask); #### Restoring a Snapshot -Restore a snapshot as specified in [Restoring an Encrypted Database](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-backup). +Restore a snapshot as specified in [Restoring an Encrypted Database](#restoring-an-encrypted-backup). * The database of an un-encrypted snapshot is restored to its un-encrypted form. * The database of an encrypted snapshot is restored to its encrypted form. diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/faq.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/faq.mdx index ea90398cb0..fe7a7b9582 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/faq.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/faq.mdx @@ -15,15 +15,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Is there a one-time backup?](../../../../client-api/operations/maintenance/backup/faq.mdx#is-there-a-one-time-backup) - * [How do I create a backup of my cluster, not just one database?](../../../../client-api/operations/maintenance/backup/faq.mdx#how-do-i-create-a-backup-of-my-cluster-not-just-one-database) - * [How should the servers' time be set in a multi-node cluster?](../../../../client-api/operations/maintenance/backup/faq.mdx#how-should-the-servers-time-be-set-in-a-multi-node-cluster) - * [Is an External Replication a good substitute for a backup task?](../../../../client-api/operations/maintenance/backup/faq.mdx#is-an-external-replication-task-a-good-substitute-for-a-backup-task) - * [Can I simply copy the database folder contents whenever I need to create a backup?](../../../../client-api/operations/maintenance/backup/faq.mdx#can-i-simply-copy-the-database-folder-contents-whenever-i-need-to-create-a-backup) - * [Does RavenDB automatically delete old backups?](../../../../client-api/operations/maintenance/backup/faq.mdx#does-ravendb-automatically-delete-old-backups) - * [Are there any locations that backup files should NOT be stored at?](../../../../client-api/operations/maintenance/backup/faq.mdx#are-there-any-locations-that-backup-files-should-not-be-stored-at) - * [What happens when a backup process fails before it is completed?](../../../../client-api/operations/maintenance/backup/faq.mdx#what-happens-when-a-backup-process-fails-before-completion) - * [What happens if the node responsible for a backup task is down?](../../../../client-api/operations/maintenance/backup/faq.mdx#what-happens-if-the-node-responsible-for-a-backup-task-is-down) + * [Is there a one-time backup?](#is-there-a-one-time-backup) + * [How do I create a backup of my cluster, not just one database?](#how-do-i-create-a-backup-of-my-cluster-not-just-one-database) + * [How should the servers' time be set in a multi-node cluster?](#how-should-the-servers-time-be-set-in-a-multi-node-cluster) + * [Is an External Replication a good substitute for a backup task?](#is-an-external-replication-task-a-good-substitute-for-a-backup-task) + * [Can I simply copy the database folder contents whenever I need to create a backup?](#can-i-simply-copy-the-database-folder-contents-whenever-i-need-to-create-a-backup) + * [Does RavenDB automatically delete old backups?](#does-ravendb-automatically-delete-old-backups) + * [Are there any locations that backup files should NOT be stored at?](#are-there-any-locations-that-backup-files-should-not-be-stored-at) + * [What happens when a backup process fails before it is completed?](#what-happens-when-a-backup-process-fails-before-completion) + * [What happens if the node responsible for a backup task is down?](#what-happens-if-the-node-responsible-for-a-backup-task-is-down) ## FAQ @@ -56,7 +56,7 @@ and databases can be [restored from backup](../../../../studio/database/create-n **To prevent downtime while rebuilding**, you can [replicate your database](../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx) so that there is a live version available to distribute the workload and act as a failover. -[Is an External Replication a good substitute for a backup task?](../../../../client-api/operations/maintenance/backup/faq.mdx#is-an-external-replication-task-a-good-substitute-for-a-backup-task) +[Is an External Replication a good substitute for a backup task?](#is-an-external-replication-task-a-good-substitute-for-a-backup-task) ### How should the servers' time be set in a multi-node cluster? The backup task runs on schedule according to the executing server's local time. @@ -94,7 +94,7 @@ Learn how to change the [Retention Policy via API](../../../../client-api/operat It is recommended **not to store backups on the same drive as your database** data files, since both the database and the backups would be exposed to the same risks. -* Disk space can run low as backups start piling up unless you [set your retention policy for backups](../../../../client-api/operations/maintenance/backup/faq.mdx#does-ravendb-automatically-delete-old-backups). +* Disk space can run low as backups start piling up unless you [set your retention policy for backups](#does-ravendb-automatically-delete-old-backups). * There are many [options for backup locations](../../../../studio/database/tasks/backup-task.mdx#destination). * We recommend creating ongoing backups in two different types of locations (cloud and local machine). You can store your backups in multiple locations by setting up one [on-going backup task](../../../../studio/database/tasks/backup-task.mdx) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/restore.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/restore.mdx index ff3cd0662d..fe592dc8e7 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/backup/restore.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/backup/restore.mdx @@ -23,12 +23,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * [Restoring a Database: Configuration and Execution](../../../../client-api/operations/maintenance/backup/restore.mdx#restoring-a-database:-configuration-and-execution) - * [Optional Settings](../../../../client-api/operations/maintenance/backup/restore.mdx#optional-settings) - * [Restore Database to a Single Node](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-a-single-node) - * [Restore Database to Multiple Nodes](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-multiple-nodes) - * [Restore to a Single Node & Replicate to Other Nodes](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-a-single-node--replicate-it-to-other-nodes) - * [Restore to Multiple Nodes Simultaneously](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-multiple-nodes-simultaneously) - * [Recommended Precautions](../../../../client-api/operations/maintenance/backup/restore.mdx#recommended-precautions) + * [Optional Settings](#optional-settings) + * [Restore Database to a Single Node](#restore-database-to-a-single-node) + * [Restore Database to Multiple Nodes](#restore-database-to-multiple-nodes) + * [Restore to a Single Node & Replicate to Other Nodes](#restore-database-to-a-single-node--replicate-it-to-other-nodes) + * [Restore to Multiple Nodes Simultaneously](#restore-database-to-multiple-nodes-simultaneously) + * [Recommended Precautions](#recommended-precautions) ## Restoring a Database: Configuration and Execution @@ -122,7 +122,7 @@ This is where you need to provide your encryption key if your backup is encrypte ### `DisableOngoingTasks` set **DisableOngoingTasks** to **true** to disable the execution of ongoing tasks after restoration. -See [Recommended Precautions](../../../../client-api/operations/maintenance/backup/restore.mdx#recommended-precautions). +See [Recommended Precautions](#recommended-precautions). {`// Do or do not run ongoing tasks after restoration. @@ -212,7 +212,7 @@ and not in any ongoing tasks that may have existed during backup. * E.g., an ETL ongoing task from a production cluster may have unwanted results in a testing environment. -In such cases, **disable** ongoing tasks using the [DisableOngoingTasks](../../../../client-api/operations/maintenance/backup/restore.mdx#section-1) flag. +In such cases, **disable** ongoing tasks using the [DisableOngoingTasks](#section-1) flag. * Code Sample: diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx index fa4c3296b3..4c4fb8a58c 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx index c8228847e7..2dceaceb77 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx index 5bbf13f04f..922167b8ed 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx index 2b86f1ff2f..bca13a0045 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx index a1882b8c92..42a111998d 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx index 606fa07cd5..484c3db08e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx index 60d1f73c4e..5d4e01225e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx index ad46e4c334..534dfcb800 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx index 7fdf0fb004..541af8f192 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx index ec9d1548a2..62d64159e0 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx index 40bd2eb343..f30ce85ce8 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx index c4fadd3471..c8fd7d4e49 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * Use the [PutConnectionStringOperation](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#the%c2%a0putconnectionstringoperation%c2%a0method) method to define a connection string in your database. * In this page: - * [Add a RavenDB connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-ravendb-connection-string) - * [Add an SQL connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-sql-connection-string) - * [Add an OLAP connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-olap-connection-string) - * [Add an Elasticsearch connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-elasticsearch-connection-string) - * [Add a Kafka connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-kafka-connection-string) - * [Add a RabbitMQ connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-rabbitmq-connection-string) - * [Add an Azure Queue Storage connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-azure-queue-storage-connection-string) + * [Add a RavenDB connection string](#add-a-ravendb-connection-string) + * [Add an SQL connection string](#add-an-sql-connection-string) + * [Add an OLAP connection string](#add-an-olap-connection-string) + * [Add an Elasticsearch connection string](#add-an-elasticsearch-connection-string) + * [Add a Kafka connection string](#add-a-kafka-connection-string) + * [Add a RabbitMQ connection string](#add-a-rabbitmq-connection-string) + * [Add an Azure Queue Storage connection string](#add-an-azure-queue-storage-connection-string) * [The PutConnectionStringOperation method](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#the%c2%a0putconnectionstringoperation%c2%a0method) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx index 95abc1e135..a8b69a3a2a 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to create a new connection string, see [Add Connection String Operation](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx). * In this page: - * [Get connection string by name and type](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#get-connection-string-by-name-and-type) - * [Get all connection strings](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#get-all-connnection-strings) - * [Syntax](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#syntax) + * [Get connection string by name and type](#get-connection-string-by-name-and-type) + * [Get all connection strings](#get-all-connnection-strings) + * [Syntax](#syntax) ## Get connection string by name and type diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx index 69eda73d4b..81b24da81a 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `RemoveConnectionStringOperation` to remove a connection string definition from the database. * In this page: - * [Remove connection string](../../../../../client-api/operations/maintenance/connection-strings/remove-connection-string.mdx#remove-connecion-string) - * [Syntax](../../../../../client-api/operations/maintenance/connection-strings/remove-connection-string.mdx#syntax) + * [Remove connection string](#remove-connecion-string) + * [Syntax](#syntax) ## Remove connection string diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-csharp.mdx index 512ebf3689..b96eb56aa4 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-csharp.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [ForDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [ForDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-java.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-java.mdx index 1fae1c14e5..df718630b8 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-java.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [ForDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [ForDatabase](#get-stats-for-another-database). * In this page: - * [Get collection stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-stats) - * [Get detailed collection stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-stats) - * [Get database stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-stats) - * [Get detailed database stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats) - * [Get stats for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database) + * [Get collection stats](#get-collection-stats) + * [Get detailed collection stats](#get-detailed-collection-stats) + * [Get database stats](#get-database-stats) + * [Get detailed database stats](#get-detailed-database-stats) + * [Get stats for another database](#get-stats-for-another-database) ## Get collection stats diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-nodejs.mdx index 0d3dc4753a..097ecccc2e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-nodejs.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [forDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [forDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-php.mdx index e71b112ca2..8508a669fa 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-php.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [forDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [forDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-python.mdx index 48a81b5992..58863dc624 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/content/_get-stats-python.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [for_database](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [for_database](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx index 462e002ce2..7c4af21d70 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Add RavenDB ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-ravendb-etl-task) - * [Add SQL ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-sql-etl-task) - * [Add OLAP ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-olap-etl-task) - * [Add Elasticsearch ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-elasticsearch-etl-task) - * [Add Kafka ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-kafka-etl-task) - * [Add RabbitMQ ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-rabbitmq-etl-task) - * [Add Azure Queue Storage ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-azure-queue-storage-etl-task) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Add RavenDB ETL task](#add-ravendb-etl-task) + * [Add SQL ETL task](#add-sql-etl-task) + * [Add OLAP ETL task](#add-olap-etl-task) + * [Add Elasticsearch ETL task](#add-elasticsearch-etl-task) + * [Add Kafka ETL task](#add-kafka-etl-task) + * [Add RabbitMQ ETL task](#add-rabbitmq-etl-task) + * [Add Azure Queue Storage ETL task](#add-azure-queue-storage-etl-task) + * [Syntax](#syntax) ## Add RavenDB ETL task diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-java.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-java.mdx index 3f1d1cd14e..3d1a32b908 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-java.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to manage ETL tasks from the Studio, see [Ongoing tasks - overview](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx). * In this page: - * [Example - add Raven ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-raven-etl) - * [Example - add SQL ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-sql-etl) - * [Example - add OLAP ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-olap-etl) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Example - add Raven ETL](#example---add-raven-etl) + * [Example - add SQL ETL](#example---add-sql-etl) + * [Example - add OLAP ETL](#example---add-olap-etl) + * [Syntax](#syntax) ## Example - add Raven ETL diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx index 58170dae88..183150f6e8 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to manage ETL tasks from the Studio, see [Ongoing tasks - overview](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx). * In this page: - * [Example - add Raven ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-raven-etl) - * [Example - add SQL ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-sql-etl) - * [Example - add OLAP ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-olap-etl) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Example - add Raven ETL](#example---add-raven-etl) + * [Example - add SQL ETL](#example---add-sql-etl) + * [Example - add OLAP ETL](#example---add-olap-etl) + * [Syntax](#syntax) ## Example - add Raven ETL diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx index 09d03d3609..bfac0591d0 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx @@ -26,8 +26,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx index f7cbc6f2b1..bafbc76300 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx @@ -23,8 +23,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-php.mdx index 8194b0f966..122fab333b 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-php.mdx @@ -26,8 +26,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-python.mdx index 1c54707c75..90875ad0ee 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_get-identities-python.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx index a66fb5d3a6..c3fce10f04 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx index ea2d1d1e78..eac448b7a8 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx index c56dd45fa9..8e3bbb6d14 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx index 7b1d4db3c9..cd30e17816 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx index d369cc606f..b95b3f0252 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx index f677028677..04b1f81bb3 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx index cff41d67c5..6a75c48d3a 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx index 566905305a..101a42c5d5 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx index c23fc026f5..f7fe67a74f 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx index a93f84d8e7..ebef111c90 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx index e02fc1e16b..4d6e0c8812 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx index 92fa250e9a..79e0c07a20 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx index f1e376d6a0..f25efd5775 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx index 0426f99d7c..c3fd5f3ff1 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx index 4c93cd2d87..8f593bc293 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx index f429f6bcff..c9ae0351b8 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx index 4e222aee78..24a4bb1ef8 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -143,7 +143,7 @@ public DisableIndexOperation(string indexName, bool clusterWide) ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx index 746ab05918..f42084f905 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -109,7 +109,7 @@ await documentStore.maintenance.send(disableIndexOp); ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx index 7b891ccebb..d4b46dd567 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -109,7 +109,7 @@ $store->maintenance()->send($disableIndexOp); ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx index c511961bc9..034eed0aad 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -110,7 +110,7 @@ store.maintenance.send(disable_index_op) ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx index a2775febbb..f5e3044502 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx index 621c2e63ec..b3ab68d902 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx index 997762dea7..36191a1aed 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx index 708d8c7303..8abe1ca66f 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx index 15e958192d..93f3960a59 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx index 194fa2b579..965fc8c3d5 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx index aa00d20fa5..c28a2a89c6 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx index f86695b186..307603df9c 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx index d2baafcaf9..d8529c4350 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx index 671350cba8..c1ff0ddadb 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx index 71fa11aaa3..6c710b24b0 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx index 05a9e103b6..218e602b9e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) + * [Get index names example](#get-index-names-example) ## Get index names example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx index e86703a4bd..1bdda73349 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx index e87e0b571f..607390c08b 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-php.mdx index f901848ff9..de493677c5 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-python.mdx index c324e3105e..875f311218 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-index-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx index f05d5abfbf..029edea463 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx index f444d444bb..15e308f289 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx index 56996c3dfb..174f705673 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx index 34c5e18583..312e115833 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx index 9ff827853f..77f349695c 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx index 8435b10c26..9361b1277d 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx index d2fa71d61f..8180d4a934 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx index 9f4ee0f571..ce8ad5c817 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx index 974984aede..4f8ebbb266 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx index 04f615feb4..4c1512ba91 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx index 3782d749dc..b8b51ced5b 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx index e75506f9bb..2e52cff22c 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx index 79fdf3d095..0f04730ffe 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx index 05544da750..3e7d69f423 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx index c6a4034ec3..8c8f88937c 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx index fd7ad51212..ddbcaa23c4 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx index 32564305aa..5d5e163906 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; will put it back to the **normal** running state on the local node where the action was performed. * In this page: - * [Reset index](../../../../../client-api/operations/maintenance/indexes/reset-index.mdx#reset-index) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/reset-index.mdx#syntax) + * [Reset index](#reset-index) + * [Syntax](#syntax) ## Reset index diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx index f5bb188103..5ff3e542da 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx index 965351ae94..9f8f378b5e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx index 779b275563..15676966f5 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx index e645f480f2..f7f124bbe6 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx index 7f875b0d11..595f7bd417 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx index 76e601122b..6012fcf834 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx index 0ca03bdf2a..9c1a709b7a 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx index 0cf2d12046..bc7506e7bd 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx index 24595073f8..935fc1204c 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx index f6d9a7b91b..3b32ef6b88 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-php.mdx index 14ef2aae9e..b70cb2c25e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-python.mdx index 2fe3efecd1..94c86dbd14 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-index-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx index 3b9784baba..4013b8689d 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx index 64bd9cb18b..a5048570c3 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx index 26f607769e..7a23a6382d 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx index 745ccb26f2..a5f5959c6a 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx index b159519f88..029f8269c0 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx index 60db5fe885..807841aaef 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx index b6986b2db1..b822eda2b2 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx index 680d333d17..0e495c8486 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx index 0980efe6c6..d77178e55e 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx index 99620f9bf5..3e43f11785 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx index 88d0d1d7e0..28887a5003 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx index df4617a7f6..058b46e519 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx index 238952e037..2fefe04bad 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Ongoing tasks can also be managed via the [Tasks list view](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#ongoing-tasks---view) in the Studio. * In this page: - * [Get ongoing task info](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#get-ongoing-task-info) - * [Delete ongoing task](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#delete-ongoing-task) - * [Toggle ongoing task state](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#toggle-ongoing-task-state) - * [Syntax](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#syntax) + * [Get ongoing task info](#get-ongoing-task-info) + * [Delete ongoing task](#delete-ongoing-task) + * [Toggle ongoing task state](#toggle-ongoing-task-state) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx index 55f1ffe37b..c31f12be57 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded to the server from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#put-custom-sorter) - * [Syntax](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#syntax) + * [Put custom sorter](#put-custom-sorter) + * [Syntax](#syntax) ## Put custom sorter diff --git a/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx index 3672828b09..2a947549a4 100644 --- a/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded to the server from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#put-custom-sorter) - * [Syntax](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#syntax) + * [Put custom sorter](#put-custom-sorter) + * [Syntax](#syntax) ## Put custom sorter diff --git a/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-csharp.mdx index 0ff0844c73..ee8ce1a90e 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-csharp.mdx @@ -13,9 +13,9 @@ This is usually not the case for NoSQL databases where set based operations are The same queries and indexes that are used for data retrieval are used for the set based operations. The syntax defining which documents to work on is exactly the same as you'd specified for those documents to be pulled from the store. In this page: -[Syntax overview](../../../../client-api/operations/patching/set-based.mdx#syntax-overview) -[Examples](../../../../client-api/operations/patching/set-based.mdx#examples) -[Additional notes](../../../../client-api/operations/patching/set-based.mdx#additional-notes) +[Syntax overview](#syntax-overview) +[Examples](#examples) +[Additional notes](#additional-notes) diff --git a/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-java.mdx b/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-java.mdx index ac9cdc38a8..cf9f60c909 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-java.mdx @@ -13,9 +13,9 @@ This is usually not the case for NoSQL databases where set based operations are The same queries and indexes that are used for data retrieval are used for the set based operations. The syntax defining which documents to work on is exactly the same as you'd specified for those documents to be pulled from the store. In this page: -[Syntax overview](../../../../client-api/operations/patching/set-based.mdx#syntax-overview) -[Examples](../../../../client-api/operations/patching/set-based.mdx#examples) -[Additional notes](../../../../client-api/operations/patching/set-based.mdx#additional-notes) +[Syntax overview](#syntax-overview) +[Examples](#examples) +[Additional notes](#additional-notes) diff --git a/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-nodejs.mdx index c99225cd8d..5599978e5b 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/content/_set-based-nodejs.mdx @@ -11,21 +11,21 @@ import CodeBlock from '@theme/CodeBlock'; Set-based patching can also be done from the [Studio](../../../../studio/database/documents/patch-view.mdx). * In this page: - * [Overview](../../../../client-api/operations/patching/set-based.mdx#overview) - * [Defining set-based patching](../../../../client-api/operations/patching/set-based.mdx#defining-set-based-patching) - * [Important characteristics](../../../../client-api/operations/patching/set-based.mdx#important-characteristics) - * [Examples](../../../../client-api/operations/patching/set-based.mdx#examples) - * [Update by collection query](../../../../client-api/operations/patching/set-based.mdx#update-by-collection-query) - * [Update by collection query - access metadata](../../../../client-api/operations/patching/set-based.mdx#update-by-collection-query---access-metadata) - * [Update by dynamic query](../../../../client-api/operations/patching/set-based.mdx#update-by-dynamic-query) - * [Update by static index query](../../../../client-api/operations/patching/set-based.mdx#update-by-static-index-query) - * [Update all documents](../../../../client-api/operations/patching/set-based.mdx#update-all-documents) - * [Update by document ID](../../../../client-api/operations/patching/set-based.mdx#update-by-document-id) - * [Update by document ID using parameters](../../../../client-api/operations/patching/set-based.mdx#update-by-document-id-using-parameters) - * [Allow updating stale results](../../../../client-api/operations/patching/set-based.mdx#allow-updating-stale-results) - * [Syntax](../../../../client-api/operations/patching/set-based.mdx#syntax) - * [Send syntax](../../../../client-api/operations/patching/set-based.mdx#send-syntax) - * [PatchByQueryOperation syntax](../../../../client-api/operations/patching/set-based.mdx#syntax) + * [Overview](#overview) + * [Defining set-based patching](#defining-set-based-patching) + * [Important characteristics](#important-characteristics) + * [Examples](#examples) + * [Update by collection query](#update-by-collection-query) + * [Update by collection query - access metadata](#update-by-collection-query---access-metadata) + * [Update by dynamic query](#update-by-dynamic-query) + * [Update by static index query](#update-by-static-index-query) + * [Update all documents](#update-all-documents) + * [Update by document ID](#update-by-document-id) + * [Update by document ID using parameters](#update-by-document-id-using-parameters) + * [Allow updating stale results](#allow-updating-stale-results) + * [Syntax](#syntax) + * [Send syntax](#send-syntax) + * [PatchByQueryOperation syntax](#syntax) ## Overview @@ -83,7 +83,7 @@ update \{ * __Patching stale indexes__: By default, set-based patch operations will only succeed if the index is Not [stale](../../../../indexes/stale-indexes.mdx). For indexes that are frequently updated, you can explicitly allow patching on stale results if needed. - An example can be seen in the [Allow updating stale results](../../../../client-api/operations/patching/set-based.mdx#allow-updating-stale-results) example. + An example can be seen in the [Allow updating stale results](#allow-updating-stale-results) example. * __Manage lengthy patch operations__: The set-based patch operation (`PatchByQueryOperation`) runs in the server background may take a long time to complete. diff --git a/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-csharp.mdx index c3c639ce97..73ff8adff7 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-csharp.mdx @@ -15,39 +15,39 @@ import CodeBlock from '@theme/CodeBlock'; * The current page covers patch operations on single documents. -* Patching has three possible interfaces: [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api), -[Session API using Defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer), -and [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api). +* Patching has three possible interfaces: [Session API](#session-api), +[Session API using Defer](#session-api-using-defer), +and [Operations API](#operations-api). -* Patching can be done from the [client API](../../../../client-api/operations/patching/single-document.mdx#examples) as well as in the [studio](../../../../studio/database/documents/patch-view.mdx). +* Patching can be done from the [client API](#examples) as well as in the [studio](../../../../studio/database/documents/patch-view.mdx). In this page: -* [API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) - * [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api) - * [Session API using Defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer) - * [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api) - * [List of script methods](../../../../client-api/operations/patching/single-document.mdx#list-of-script-methods) -* [Examples](../../../../client-api/operations/patching/single-document.mdx#examples) - * [Change value of single field](../../../../client-api/operations/patching/single-document.mdx#change-value-of-single-field) - * [Change values of two fields](../../../../client-api/operations/patching/single-document.mdx#change-values-of-two-fields) - * [Increment value](../../../../client-api/operations/patching/single-document.mdx#increment-value) - * [Add or increment](../../../../client-api/operations/patching/single-document.mdx#add-or-increment) - * [Add or patch](../../../../client-api/operations/patching/single-document.mdx#add-or-patch) - * [Add or patch to an existing array](../../../../client-api/operations/patching/single-document.mdx#add-or-patch-to-an-existing-array) - * [Add item to array](../../../../client-api/operations/patching/single-document.mdx#add-item-to-array) - * [Insert item into specific position in array](../../../../client-api/operations/patching/single-document.mdx#insert-item-into-specific-position-in-array) - * [Modify item in specific position in array](../../../../client-api/operations/patching/single-document.mdx#modify-item-in-specific-position-in-array) - * [Remove items from array](../../../../client-api/operations/patching/single-document.mdx#remove-items-from-array) - * [Loading documents in a script](../../../../client-api/operations/patching/single-document.mdx#loading-documents-in-a-script) - * [Remove property](../../../../client-api/operations/patching/single-document.mdx#remove-property) - * [Rename property](../../../../client-api/operations/patching/single-document.mdx#rename-property) - * [Add document](../../../../client-api/operations/patching/single-document.mdx#add-document) - * [Clone document](../../../../client-api/operations/patching/single-document.mdx#clone-document) - * [Increment counter](../../../../client-api/operations/patching/single-document.mdx#increment-counter) - * [Delete counter](../../../../client-api/operations/patching/single-document.mdx#delete-counter) - * [Get counter](../../../../client-api/operations/patching/single-document.mdx#get-counter) - * [Patching using inline string compilation](../../../../client-api/operations/patching/single-document.mdx#patching-using-inline-string-compilation) +* [API overview](#api-overview) + * [Session API](#session-api) + * [Session API using Defer](#session-api-using-defer) + * [Operations API](#operations-api) + * [List of script methods](#list-of-script-methods) +* [Examples](#examples) + * [Change value of single field](#change-value-of-single-field) + * [Change values of two fields](#change-values-of-two-fields) + * [Increment value](#increment-value) + * [Add or increment](#add-or-increment) + * [Add or patch](#add-or-patch) + * [Add or patch to an existing array](#add-or-patch-to-an-existing-array) + * [Add item to array](#add-item-to-array) + * [Insert item into specific position in array](#insert-item-into-specific-position-in-array) + * [Modify item in specific position in array](#modify-item-in-specific-position-in-array) + * [Remove items from array](#remove-items-from-array) + * [Loading documents in a script](#loading-documents-in-a-script) + * [Remove property](#remove-property) + * [Rename property](#rename-property) + * [Add document](#add-document) + * [Clone document](#clone-document) + * [Increment counter](#increment-counter) + * [Delete counter](#delete-counter) + * [Get counter](#get-counter) + * [Patching using inline string compilation](#patching-using-inline-string-compilation) diff --git a/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-java.mdx b/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-java.mdx index 450920f197..1b31568340 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-java.mdx @@ -9,13 +9,13 @@ The whole operation is executed on the server side and is useful as a performanc The current page deals with patch operations on single documents. -Patching has three possible interfaces: [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api), [Session API using defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer), and [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api). +Patching has three possible interfaces: [Session API](#session-api), [Session API using defer](#session-api-using-defer), and [Operations API](#operations-api). Patching can be done from the client as well as in the studio. In this page: -[API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) -[Examples](../../../../client-api/operations/patching/single-document.mdx#examples) +[API overview](#api-overview) +[Examples](#examples) ## API overview diff --git a/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-nodejs.mdx index 10367121ff..7c358f9cf7 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/content/_single-document-nodejs.mdx @@ -19,39 +19,39 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) + * [API overview](#api-overview) - * [Examples](../../../../client-api/operations/patching/single-document.mdx#examples) - * [Modify value of single field](../../../../client-api/operations/patching/single-document.mdx#modify-value-of-single-field) - * [Modify values of two fields](../../../../client-api/operations/patching/single-document.mdx#modify-values-of-two-fields) - * [Increment value](../../../../client-api/operations/patching/single-document.mdx#increment-value) - * [Add or increment](../../../../client-api/operations/patching/single-document.mdx#add-or-increment) - * [Add or patch](../../../../client-api/operations/patching/single-document.mdx#add-or-patch) - * [Add item to array](../../../../client-api/operations/patching/single-document.mdx#add-item-to-array) - * [Add or patch an existing array](../../../../client-api/operations/patching/single-document.mdx#add-or-patch-an-existing-array) - * [Insert item into specific position in array](../../../../client-api/operations/patching/single-document.mdx#insert-item-into-specific-position-in-array) - * [Modify item in specific position in array](../../../../client-api/operations/patching/single-document.mdx#modify-item-in-specific-position-in-array) - * [Remove items from array](../../../../client-api/operations/patching/single-document.mdx#remove-items-from-array) - * [Load documents in a script](../../../../client-api/operations/patching/single-document.mdx#load-documents-in-a-script) - * [Remove property](../../../../client-api/operations/patching/single-document.mdx#remove-property) - * [Rename property](../../../../client-api/operations/patching/single-document.mdx#rename-property) - * [Add document](../../../../client-api/operations/patching/single-document.mdx#add-document) - * [Clone document](../../../../client-api/operations/patching/single-document.mdx#clone-document) - * [Create/Increment counter](../../../../client-api/operations/patching/single-document.mdx#createincrement-counter) - * [Delete counter](../../../../client-api/operations/patching/single-document.mdx#delete-counter) - * [Get counter](../../../../client-api/operations/patching/single-document.mdx#get-counter) - * [Patching using inline string compilation](../../../../client-api/operations/patching/single-document.mdx#patching-using-inline-string-compilation) + * [Examples](#examples) + * [Modify value of single field](#modify-value-of-single-field) + * [Modify values of two fields](#modify-values-of-two-fields) + * [Increment value](#increment-value) + * [Add or increment](#add-or-increment) + * [Add or patch](#add-or-patch) + * [Add item to array](#add-item-to-array) + * [Add or patch an existing array](#add-or-patch-an-existing-array) + * [Insert item into specific position in array](#insert-item-into-specific-position-in-array) + * [Modify item in specific position in array](#modify-item-in-specific-position-in-array) + * [Remove items from array](#remove-items-from-array) + * [Load documents in a script](#load-documents-in-a-script) + * [Remove property](#remove-property) + * [Rename property](#rename-property) + * [Add document](#add-document) + * [Clone document](#clone-document) + * [Create/Increment counter](#createincrement-counter) + * [Delete counter](#delete-counter) + * [Get counter](#get-counter) + * [Patching using inline string compilation](#patching-using-inline-string-compilation) - * [Syntax](../../../../client-api/operations/patching/single-document.mdx#syntax) - * [Session API syntax](../../../../client-api/operations/patching/single-document.mdx#session-api-syntax) - * [Session API using defer syntax](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer-syntax) - * [Operations API syntax](../../../../client-api/operations/patching/single-document.mdx#operations-api-syntax) - * [List of script methods syntax](../../../../client-api/operations/patching/single-document.mdx#list-of-script-methods-syntax) + * [Syntax](#syntax) + * [Session API syntax](#session-api-syntax) + * [Session API using defer syntax](#session-api-using-defer-syntax) + * [Operations API syntax](#operations-api-syntax) + * [List of script methods syntax](#list-of-script-methods-syntax) ## API overview -Patching can be performed using either of the following interfaces (detailed syntax is provided [below](../../../../client-api/operations/patching/single-document.mdx#syntax)): +Patching can be performed using either of the following interfaces (detailed syntax is provided [below](#syntax)): * **Session API** * **Session API using defer** @@ -65,7 +65,7 @@ Patching can be performed using either of the following interfaces (detailed syn * Multiple patch methods can be defined on the [session](../../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx) and are sent to the server for execution in a single batch (along with any other modified documents) only when calling [SaveChanges](../../../../client-api/session/saving-changes.mdx). -* This API includes the following patching methods (see examples [below](../../../../client-api/operations/patching/single-document.mdx#examples)): +* This API includes the following patching methods (see examples [below](#examples)): * `patch` * `addOrPatch` * `increment` diff --git a/versioned_docs/version-6.2/client-api/operations/patching/json-patch-syntax.mdx b/versioned_docs/version-6.2/client-api/operations/patching/json-patch-syntax.mdx index 03f0b620cf..fb208b615b 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/json-patch-syntax.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/json-patch-syntax.mdx @@ -33,16 +33,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Test** whether the patching succeeded * In this page: - * [JSON Patches](../../../client-api/operations/patching/json-patch-syntax.mdx#json-patches) - * [Running JSON Patches](../../../client-api/operations/patching/json-patch-syntax.mdx#running-json-patches) - * [Patch Operations](../../../client-api/operations/patching/json-patch-syntax.mdx#patch-operations) - * [Add Document Property](../../../client-api/operations/patching/json-patch-syntax.mdx#add-operation) - * [Remove Document Property](../../../client-api/operations/patching/json-patch-syntax.mdx#remove-document-property) - * [Replace Document Property Contents](../../../client-api/operations/patching/json-patch-syntax.mdx#replace-document-property-contents) - * [Copy Document Property Contents to Another Property](../../../client-api/operations/patching/json-patch-syntax.mdx#copy-document-property-contents-to-another-property) - * [Move Document Property Contents to Another Property](../../../client-api/operations/patching/json-patch-syntax.mdx#move-document-property-contents-to-another-property) - * [Test Patching Operation](../../../client-api/operations/patching/json-patch-syntax.mdx#test-patching-operation) - * [Additional JSON Patching Options](../../../client-api/operations/patching/json-patch-syntax.mdx#additional-json-patching-options) + * [JSON Patches](#json-patches) + * [Running JSON Patches](#running-json-patches) + * [Patch Operations](#patch-operations) + * [Add Document Property](#add-operation) + * [Remove Document Property](#remove-document-property) + * [Replace Document Property Contents](#replace-document-property-contents) + * [Copy Document Property Contents to Another Property](#copy-document-property-contents-to-another-property) + * [Move Document Property Contents to Another Property](#move-document-property-contents-to-another-property) + * [Test Patching Operation](#test-patching-operation) + * [Additional JSON Patching Options](#additional-json-patching-options) ## JSON Patches diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx index 31d1262405..3eaaf309a3 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx index ff29acf58f..d0aa9032f7 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx index a3c5a9c645..377f371039 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx index fce920222a..d840b4c97c 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; the next time it makes a request to the database. * In this page: * [Put client-configuration (server-wide)](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#put-client-configuration-(server-wide)) - * [Syntax](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Put client-configuration (server-wide) diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx index 0e467c833c..6fbc9d9c8a 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; the next time it makes a request to the database. * In this page: * [Put client-configuration (server-wide)](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#put-client-configuration-(server-wide)) - * [Syntax](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Put client-configuration (server-wide) diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-csharp.mdx index a276dc7464..4f2e2152e0 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx index 4f4f3fd485..1283ee43e5 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-php.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-php.mdx index 9b73dd3f10..6bb51d67dc 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-python.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-python.mdx index e5b058a507..8509fc89c5 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_add-database-node-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-csharp.mdx index 3671447e6b..37f6254633 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-csharp.mdx @@ -26,14 +26,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-nodejs.mdx index 60f762a229..b974e885fa 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-nodejs.mdx @@ -26,14 +26,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-php.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-php.mdx index 1786e738ff..644c21c6c3 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-php.mdx @@ -25,14 +25,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-python.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-python.mdx index 5a9abb06b0..51bc805228 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_compact-database-python.mdx @@ -25,12 +25,12 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) ## Examples diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-csharp.mdx index f0e2f7cad2..c1956cee48 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; To learn which operations are allowed at each level, see [Security clearance and permissions](../../../../server/security/authorization/security-clearance-and-permissions.mdx). * In this article: - * [Create new database](../../../../client-api/operations/server-wide/create-database.mdx#create-new-database) - * [Example I - Create non-sharded database](../../../../client-api/operations/server-wide/create-database.mdx#example-i---create-non-sharded-database) - * [Example II - Create sharded database](../../../../client-api/operations/server-wide/create-database.mdx#example-ii---create-sharded-database) - * [Example III - Ensure database does not exist before creating](../../../../client-api/operations/server-wide/create-database.mdx#example-iii---ensure-database-does-not-exist-before-creating) - * [Syntax](../../../../client-api/operations/server-wide/create-database.mdx#syntax) + * [Create new database](#create-new-database) + * [Example I - Create non-sharded database](#example-i---create-non-sharded-database) + * [Example II - Create sharded database](#example-ii---create-sharded-database) + * [Example III - Ensure database does not exist before creating](#example-iii---ensure-database-does-not-exist-before-creating) + * [Syntax](#syntax) ## Create new database @@ -339,9 +339,9 @@ public CreateDatabaseOperation(Action builder | Parameter | Description | |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **databaseRecord** | Instance of `DatabaseRecord` containing database configuration.
See [The Database Record](../../../../client-api/operations/server-wide/create-database.mdx#the-database-record) below. | +| **databaseRecord** | Instance of `DatabaseRecord` containing database configuration.
See [The Database Record](#the-database-record) below. | | **replicationFactor** | Number of nodes the database should be replicated to.

If not specified, the value is taken from `databaseRecord.Topology.ReplicationFactor`,
or defaults to **`1`** if that is not set.

If `Topology` is provided, the `replicationFactor` is ignored. | -| **builder** | Callback used to initialize and fluently configure a new DatabaseRecord.
Receives an `IDatabaseRecordBuilderInitializer` on which you invoke builder methods to construct the record. See [The Database Record Builder](../../../../client-api/operations/server-wide/create-database.mdx#the-database-record-builder) below. | +| **builder** | Callback used to initialize and fluently configure a new DatabaseRecord.
Receives an `IDatabaseRecordBuilderInitializer` on which you invoke builder methods to construct the record. See [The Database Record Builder](#the-database-record-builder) below. | ### The Database Record: The `DatabaseRecord` is a collection of database configurations: diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-java.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-java.mdx index cfb2afb138..c756d088d7 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-java.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_create-database-java.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn which operations are allowed at each level, see [Security clearance and permissions](../../../../server/security/authorization/security-clearance-and-permissions.mdx). * In this article: - * [Create new database](../../../../client-api/operations/server-wide/create-database.mdx#create-new-database) - * [Example I - Create database](../../../../client-api/operations/server-wide/create-database.mdx#example-i---create-non-sharded-database) - * [Example II - Ensure database does not exist before creating](../../../../client-api/operations/server-wide/create-database.mdx#example-ii---ensure-database-does-not-exist-before-creating) - * [Syntax](../../../../client-api/operations/server-wide/create-database.mdx#syntax) + * [Create new database](#create-new-database) + * [Example I - Create database](#example-i---create-non-sharded-database) + * [Example II - Ensure database does not exist before creating](#example-ii---ensure-database-does-not-exist-before-creating) + * [Syntax](#syntax) ## Create new database diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx index 38df44762b..73b25abc06 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx index 3f44ee5cad..e7f8eb546d 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx index 9e2a453d62..f472089b15 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx index e9b4630154..8564dc961f 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx index 97b8362bde..c716cfd912 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded server-wide from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter server-wide](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#put-custom-sorter-server-wide) - * [Syntax](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#syntax) + * [Put custom sorter server-wide](#put-custom-sorter-server-wide) + * [Syntax](#syntax) ## Put custom sorter server-wide diff --git a/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx b/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx index a439af29c6..b4f9ebf959 100644 --- a/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded server-wide from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter server-wide](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#put-custom-sorter-server-wide) - * [Syntax](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#syntax) + * [Put custom sorter server-wide](#put-custom-sorter-server-wide) + * [Syntax](#syntax) ## Put custom sorter server-wide diff --git a/versioned_docs/version-6.2/client-api/rest-api/document-commands/batch-commands.mdx b/versioned_docs/version-6.2/client-api/rest-api/document-commands/batch-commands.mdx index 8b3a827dba..6e46cb8116 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/document-commands/batch-commands.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/document-commands/batch-commands.mdx @@ -17,20 +17,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use this endpoint with the **`POST`** method to send multiple commands in one request: `/databases//bulk_docs` -* The commands are sent as a JSON array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#body). +* The commands are sent as a JSON array in the [request body](#body). * All the commands in the batch will either succeed or fail as a **single transaction**. Changes will not be visible until the entire batch completes. -* [Options](../../../client-api/rest-api/document-commands/batch-commands.mdx#batch-options) can be set to make the server wait +* [Options](#batch-options) can be set to make the server wait for indexing and replication to complete before returning. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/batch-commands.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format) - * [Commands](../../../client-api/rest-api/document-commands/batch-commands.mdx#commands) - * [Response Format](../../../client-api/rest-api/document-commands/batch-commands.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/batch-commands.mdx#more-examples) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Commands](#commands) + * [Response Format](#response-format) + * [More Examples](#more-examples) ## Basic Example @@ -113,7 +113,7 @@ Raven-Server-Version: 4.2.4.42 ## Request Format This is the general format of a cURL request with a batch of commands that _does not_ include a Put Attachment Command -(see the format for batching a Put Attachment Command [below](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command)): +(see the format for batching a Put Attachment Command [below](#put-attachment-command)): @@ -133,7 +133,7 @@ Linebreaks are added for clarity. #### Query String -The query string takes [batch options](../../../client-api/rest-api/document-commands/batch-commands.mdx#batch-options), which +The query string takes [batch options](#batch-options), which can make the server wait for indexing and replication to finish before responding. @@ -142,7 +142,7 @@ can make the server wait for indexing and replication to finish before respondin The header `Content-Type` is required and takes one of two values: * `application/json` - if the batch _does not_ include a Put Attachment Command. -* `multipart/mixed; boundary=` - if the batch [_does_](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command) +* `multipart/mixed; boundary=` - if the batch [_does_](#put-attachment-command) include a Put Attachment Command. The "separator" is an arbitrary string used to demarcate the attachment streams and commands array. @@ -172,12 +172,12 @@ using a backslash: `"` -> `\"`. The following commands can be sent using the batch command: -* [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command) -* [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command) -* [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command) -* [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command) -* [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command) -* [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command) +* [Put Document Command](#put-document-command) +* [Patch Document Command](#patch-document-command) +* [Delete Document Command](#delete-document-command) +* [Delete by Prefix Command](#delete-by-prefix-command) +* [Put Attachment Command](#put-attachment-command) +* [Delete Attachment Command](#delete-attachment-command) ### Batch Options These options, configured in the query string, make the server wait until indexing or replication have completed before responding. If these have not @@ -220,7 +220,7 @@ Linebreaks are added for clarity. Upload a new document or update an existing document. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -250,7 +250,7 @@ Format within the `Commands` array in the [request body](../../../client-api/res Update a document. A [patch](../../../client-api/operations/patching/single-document.mdx) is executed on the server side and does not involve loading the document, avoiding the cost of sending the entire document in a round trip over the network. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -280,8 +280,8 @@ Format within the `Commands` array in the [request body](../../../client-api/res | - | - | - | | **Id** | ID of a document to execute the patch on | Yes | | **ChangeVector** | The document's expected [change vector](../../../server/clustering/replication/change-vector.mdx). If it does not match the server-side change vector a concurrency exception is thrown. | No | -| **Patch** | A script that modifies the specified document. [Details below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-request). | Yes | -| **PatchIfMissing** | An alternative script to be executed if no document with the given ID is found. This will create a new document with the given ID. [Details below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-request). | No | +| **Patch** | A script that modifies the specified document. [Details below](#patch-request). | Yes | +| **PatchIfMissing** | An alternative script to be executed if no document with the given ID is found. This will create a new document with the given ID. [Details below](#patch-request). | No | | **Type** | Set to `PATCH` | Yes | #### Patch Request @@ -297,7 +297,7 @@ wrap strings. Delete a document by its ID. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -319,7 +319,7 @@ Format within the `Commands` array in the [request body](../../../client-api/res Delete all documents whose IDs begin with a certain prefix. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -390,7 +390,7 @@ Command-Type: AttachmentStream Delete an attachment in a certain document. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -441,12 +441,12 @@ Results appear in the same order as the commands in the request body. * Format within the `Results` array in the response body: - * [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command-1) - * [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command-1) - * [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command-1) - * [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command-1) - * [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command-1) - * [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command-1) + * [Put Document Command](#put-document-command-1) + * [Patch Document Command](#patch-document-command-1) + * [Delete Document Command](#delete-document-command-1) + * [Delete by Prefix Command](#delete-by-prefix-command-1) + * [Put Attachment Command](#put-attachment-command-1) + * [Delete Attachment Command](#delete-attachment-command-1) ### Put Document Command @@ -490,7 +490,7 @@ Results appear in the same order as the commands in the request body. | **@change-vector** | The document's change vector after the command was executed. Returns `null` if the command did not result in any changes. | | **@last-modified** | Date and time (UTC) of the most recent modification made to the document. | | **Type** | Same as the `Type` of the command sent - in this case `PATCH`. | -| **PatchStatus** | See [below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patchstatus) | +| **PatchStatus** | See [below](#patchstatus) | | **Debug** | Should always return `null` in the context of batch commands. | #### PatchStatus @@ -596,12 +596,12 @@ Results appear in the same order as the commands in the request body. [About Northwind](../../../start/about-examples.mdx), the database used in our examples. * In this section: - * [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command-2) - * [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command-2) - * [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command-2) - * [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command-2) - * [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command-2) - * [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command-2) + * [Put Document Command](#put-document-command-2) + * [Patch Document Command](#patch-document-command-2) + * [Delete Document Command](#delete-document-command-2) + * [Delete by Prefix Command](#delete-by-prefix-command-2) + * [Put Attachment Command](#put-attachment-command-2) + * [Delete Attachment Command](#delete-attachment-command-2) ### Put Document Command Request: diff --git a/versioned_docs/version-6.2/client-api/rest-api/document-commands/delete-document.mdx b/versioned_docs/version-6.2/client-api/rest-api/document-commands/delete-document.mdx index 5fc0f8f445..cfd51578c6 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/document-commands/delete-document.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/document-commands/delete-document.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//docs?id=` * In this page: - * [Example](../../../client-api/rest-api/document-commands/delete-document.mdx#example) - * [Request Format](../../../client-api/rest-api/document-commands/delete-document.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/delete-document.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-all-documents.mdx b/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-all-documents.mdx index 3fe7b6375b..2c3b05df73 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-all-documents.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-all-documents.mdx @@ -20,13 +20,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query parameters can be used to page the results. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-all-documents.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-all-documents.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-all-documents.mdx#response-format) - * [Query Parameter Examples](../../../client-api/rest-api/document-commands/get-all-documents.mdx#query-parameter-examples) - * [start](../../../client-api/rest-api/document-commands/get-all-documents.mdx#start) - * [pageSize](../../../client-api/rest-api/document-commands/get-all-documents.mdx#pagesize) - * [metadataOnly](../../../client-api/rest-api/document-commands/get-all-documents.mdx#metadataonly) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [Query Parameter Examples](#query-parameter-examples) + * [start](#start) + * [pageSize](#pagesize) + * [metadataOnly](#metadataonly) ## Basic Example @@ -189,9 +189,9 @@ Linebreaks are added for clarity. In this section: -* [start](../../../client-api/rest-api/document-commands/get-all-documents.mdx#start) -* [pageSize](../../../client-api/rest-api/document-commands/get-all-documents.mdx#pagesize) -* [metadataOnly](../../../client-api/rest-api/document-commands/get-all-documents.mdx#metadataonly) +* [start](#start) +* [pageSize](#pagesize) +* [metadataOnly](#metadataonly) ### start Skip first 1,057 documents, and retrieve the rest (our version of Northwind contains 1,059 documents). diff --git a/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-id.mdx b/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-id.mdx index 6e4b690b16..ad2ed729ed 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-id.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-id.mdx @@ -21,14 +21,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; [counters](../../../document-extensions/counters/overview.mdx). * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#more-examples) - * [Get Multiple Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-multiple-documents) - * [Get Related Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-related-documents) - * [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-metadata-only) - * [Get Document Counters](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-counters) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) + * [Get Multiple Documents](#get-multiple-documents) + * [Get Related Documents](#get-related-documents) + * [Get Document Metadata Only](#get-document-metadata-only) + * [Get Document Counters](#get-document-counters) ## Basic Example @@ -187,10 +187,10 @@ Linebreaks are added for clarity. In this section: -* [Get Multiple Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-multiple-documents) -* [Get Related Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-related-documents) -* [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-metadata-only) -* [Get Document Counters](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-counters) +* [Get Multiple Documents](#get-multiple-documents) +* [Get Related Documents](#get-related-documents) +* [Get Document Metadata Only](#get-document-metadata-only) +* [Get Document Counters](#get-document-counters) ### Get Multiple Documents Example cURL request: diff --git a/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-prefix.mdx b/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-prefix.mdx index bf5dd875ac..078bb7b7d5 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-prefix.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/document-commands/get-documents-by-prefix.mdx @@ -20,15 +20,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query parameters can be used to filter and page the results. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#more-examples) - * [Get Using `matches`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using) - * [Get Using `matches` and `exclude`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-usingand) - * [Get Using `startAfter`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using-1) - * [Page Results](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#page-results) - * [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-document-metadata-only) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) + * [Get Using `matches`](#get-using) + * [Get Using `matches` and `exclude`](#get-usingand) + * [Get Using `startAfter`](#get-using-1) + * [Page Results](#page-results) + * [Get Document Metadata Only](#get-document-metadata-only) ## Basic Example @@ -191,11 +191,11 @@ Linebreaks are added for clarity. In this section: -* [Get Using `matches`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using) -* [Get Using `matches` and `exclude`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-usingand) -* [Get Using `startAfter`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using-1) -* [Page Results](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#page-results) -* [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-document-metadata-only) +* [Get Using `matches`](#get-using) +* [Get Using `matches` and `exclude`](#get-usingand) +* [Get Using `startAfter`](#get-using-1) +* [Page Results](#page-results) +* [Get Document Metadata Only](#get-document-metadata-only) ### Get Using `matches` cURL request: diff --git a/versioned_docs/version-6.2/client-api/rest-api/document-commands/put-documents.mdx b/versioned_docs/version-6.2/client-api/rest-api/document-commands/put-documents.mdx index 800516c5b6..e6514113a4 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/document-commands/put-documents.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/document-commands/put-documents.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//docs` * In this page: - * [Examples](../../../client-api/rest-api/document-commands/put-documents.mdx#examples) - * [Request Format](../../../client-api/rest-api/document-commands/put-documents.mdx#request-format) - * [Request Body](../../../client-api/rest-api/document-commands/put-documents.mdx#request-body) - * [Response Format](../../../client-api/rest-api/document-commands/put-documents.mdx#response-format) + * [Examples](#examples) + * [Request Format](#request-format) + * [Request Body](#request-body) + * [Response Format](#response-format) ## Examples diff --git a/versioned_docs/version-6.2/client-api/rest-api/queries/delete-by-query.mdx b/versioned_docs/version-6.2/client-api/rest-api/queries/delete-by-query.mdx index b7f1d79122..0e63a04d71 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/queries/delete-by-query.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/queries/delete-by-query.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//queries` * In this page: - * [Example](../../../client-api/rest-api/queries/delete-by-query.mdx#example) - * [Request Format](../../../client-api/rest-api/queries/delete-by-query.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/delete-by-query.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/versioned_docs/version-6.2/client-api/rest-api/queries/patch-by-query.mdx b/versioned_docs/version-6.2/client-api/rest-api/queries/patch-by-query.mdx index a6e29d4fac..8f3c8607e3 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/queries/patch-by-query.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/queries/patch-by-query.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Patching](../../../client-api/operations/patching/set-based.mdx) occurs on the server side. * In this page: - * [Example](../../../client-api/rest-api/queries/patch-by-query.mdx#example) - * [Request Format](../../../client-api/rest-api/queries/patch-by-query.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/patch-by-query.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/versioned_docs/version-6.2/client-api/rest-api/queries/query-the-database.mdx b/versioned_docs/version-6.2/client-api/rest-api/queries/query-the-database.mdx index fe9be7e8db..ba36c13406 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/queries/query-the-database.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/queries/query-the-database.mdx @@ -20,10 +20,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Queries are written in [RQL](../../../client-api/session/querying/what-is-rql.mdx), our user friendly SQL-like query language. * In this page: - * [Basic Example](../../../client-api/rest-api/queries/query-the-database.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/queries/query-the-database.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/query-the-database.mdx#response-format) - * [More Examples](../../../client-api/rest-api/queries/query-the-database.mdx#more-examples) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) ## Basic Example @@ -237,7 +237,7 @@ you will probably need to escape all double quotes within the request body using | **IsStale** | Whether the results are [stale](../../../indexes/stale-indexes.mdx) | | **ResultEtag** | A hash of type `long` representing the results. When making another request identical to this one, this value can be sent in the `If-None-Match` header to check whether the results have been modified since this response. If not, the results will be retrieved from a local cache instead of from the server. | | **NodeTag** | The tag of the Cluster Node that responded to the query. Values are `A` to `Z`. See [Cluster Topology](../../../server/clustering/rachis/cluster-topology.mdx). | -| **Timings** | If [requested](../../../client-api/session/querying/debugging/query-timings.mdx), the duration of the query operation and each of its sub-stages. See the structure of the [`Timings` object](../../../client-api/rest-api/queries/query-the-database.mdx#the--object) and the [timings example](../../../client-api/rest-api/queries/query-the-database.mdx#get-timing-details) below. | +| **Timings** | If [requested](../../../client-api/session/querying/debugging/query-timings.mdx), the duration of the query operation and each of its sub-stages. See the structure of the [`Timings` object](#the--object) and the [timings example](#get-timing-details) below. | #### The `Timings` Object @@ -283,9 +283,9 @@ roughly add up to the duration of the parent stage because `DurationInMs` values In this section: -* [Include Related Documents](../../../client-api/rest-api/queries/query-the-database.mdx#include-related-documents) -* [Page Results](../../../client-api/rest-api/queries/query-the-database.mdx#page-results) -* [Get Timing Details](../../../client-api/rest-api/queries/query-the-database.mdx#get-timing-details) +* [Include Related Documents](#include-related-documents) +* [Page Results](#page-results) +* [Get Timing Details](#get-timing-details) ### Include Related Documents This query tells the server to include a [related document](../../../client-api/how-to/handle-document-relationships.mdx#includes). diff --git a/versioned_docs/version-6.2/client-api/rest-api/rest-api-intro.mdx b/versioned_docs/version-6.2/client-api/rest-api/rest-api-intro.mdx index 3b2cd16106..5bc4cb2fdd 100644 --- a/versioned_docs/version-6.2/client-api/rest-api/rest-api-intro.mdx +++ b/versioned_docs/version-6.2/client-api/rest-api/rest-api-intro.mdx @@ -24,10 +24,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [REST API Tutorial website](https://www.restapitutorial.com/) * In this page: - * [cURL Basics](../../client-api/rest-api/rest-api-intro.mdx#curl-basics) - * [Document Format and Structure](../../client-api/rest-api/rest-api-intro.mdx#document-format-and-structure) - * [Using cURL With HTTPS](../../client-api/rest-api/rest-api-intro.mdx#using-curl-with-https) - * [Common HTTP Status Codes](../../client-api/rest-api/rest-api-intro.mdx#common-http-status-codes) + * [cURL Basics](#curl-basics) + * [Document Format and Structure](#document-format-and-structure) + * [Using cURL With HTTPS](#using-curl-with-https) + * [Common HTTP Status Codes](#common-http-status-codes) ## cURL Basics diff --git a/versioned_docs/version-6.2/client-api/security/content/_deserialization-security-csharp.mdx b/versioned_docs/version-6.2/client-api/security/content/_deserialization-security-csharp.mdx index c58238e8be..8f10cb0ce4 100644 --- a/versioned_docs/version-6.2/client-api/security/content/_deserialization-security-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/security/content/_deserialization-security-csharp.mdx @@ -15,14 +15,14 @@ import ContentFrame from "@site/src/components/ContentFrame"; is forbidden or allowed. * In this article: - * [Securing deserialization](../../../client-api/security/deserialization-security.mdx#securing-deserialization) - * [The deserialization risk](../../../client-api/security/deserialization-security.mdx#the-deserialization-risk) - * [Direct vs. indirect gadget loading](../../../client-api/security/deserialization-security.mdx#direct-vs-indirect-gadget-loading) - * [DefaultRavenSerializationBinder](../../../client-api/security/deserialization-security.mdx#defaultravenserializationbinder) - * [RegisterForbiddenNamespace](../../../client-api/security/deserialization-security.mdx#registerforbiddennamespace) - * [RegisterForbiddenType](../../../client-api/security/deserialization-security.mdx#registerforbiddentype) - * [RegisterSafeType](../../../client-api/security/deserialization-security.mdx#registersafetype) - * [Example](../../../client-api/security/deserialization-security.mdx#example) + * [Securing deserialization](#securing-deserialization) + * [The deserialization risk](#the-deserialization-risk) + * [Direct vs. indirect gadget loading](#direct-vs-indirect-gadget-loading) + * [DefaultRavenSerializationBinder](#defaultravenserializationbinder) + * [RegisterForbiddenNamespace](#registerforbiddennamespace) + * [RegisterForbiddenType](#registerforbiddentype) + * [RegisterSafeType](#registersafetype) + * [Example](#example) @@ -52,7 +52,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; - `System.Xml.XmlDataDocument` - `System.Management.Automation.PSObject` -* Users can [customize](../../../client-api/security/deserialization-security.mdx#defaultravenserializationbinder) +* Users can [customize](#defaultravenserializationbinder) the list of namespaces and types for which deserialization is forbidden or allowed. @@ -115,7 +115,7 @@ trusted types. Create a new `DefaultRavenSerializationBinder` instance, call the registration methods to define your overrides, then configure the instance as a serialization -convention as shown in the [example](../../../client-api/security/deserialization-security.mdx#example). +convention as shown in the [example](#example). diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-csharp.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-csharp.mdx index 5e5382b346..2078190b37 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-csharp.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; Saving a document will be prevented if another session has modified the document. * In this article: - * [Atomic guard creation and update](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) ## Atomic guard creation and update diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-nodejs.mdx index 21b6fd6457..4d8f6389b9 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-nodejs.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; Saving a document will be prevented if another session has modified the document. * In this article: - * [Atomic guard creation and update](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) ## Atomic guard creation and update diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-php.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-php.mdx index 84bc667593..19488640e6 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-php.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; Saving a document will be prevented if another session has modified the document. * In this article: - * [Atomic guard creation and update](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) ## Atomic guard creation and update diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-python.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-python.mdx index ff5083e072..f7572ed6de 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_atomic-guards-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; Saving a document will be prevented if another session has modified the document. * In this article: - * [Atomic guard creation and update](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) ## Atomic guard creation and update diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-csharp.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-csharp.mdx index 1c44f1a251..8ab9a39215 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; the session **must be opened as a [cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction)**. * In this page: - * [Create compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#create-compare-exchange) - * [Get compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#get-compare-exchange) - * [Delete compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#delete-compare-exchange) + * [Create compare-exchange](#create-compare-exchange) + * [Get compare-exchange](#get-compare-exchange) + * [Delete compare-exchange](#delete-compare-exchange) ## Create compare-exchange diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-nodejs.mdx index 0104bfa0df..457fd530b4 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; the session **must be opened as a [cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction)**. * In this page: - * [Create compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#create-compare-exchange) - * [Get compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#get-compare-exchange) - * [Delete compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#delete-compare-exchange) + * [Create compare-exchange](#create-compare-exchange) + * [Get compare-exchange](#get-compare-exchange) + * [Delete compare-exchange](#delete-compare-exchange) ## Create compare-exchange diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-php.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-php.mdx index c509d7e553..816726490a 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; the session **must be opened as a [cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction)**. * In this page: - * [Create compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#create-compare-exchange) - * [Get compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#get-compare-exchange) - * [Delete compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#delete-compare-exchange) + * [Create compare-exchange](#create-compare-exchange) + * [Get compare-exchange](#get-compare-exchange) + * [Delete compare-exchange](#delete-compare-exchange) ## Create compare-exchange diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-python.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-python.mdx index 25612edcc5..5497c13ebb 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_compare-exchange-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; the session **must be opened as a [cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction)**. * In this page: - * [Create compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#create-compare-exchange) - * [Get compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#get-compare-exchange) - * [Delete compare-exchange](../../../../client-api/session/cluster-transaction/compare-exchange.mdx#delete-compare-exchange) + * [Create compare-exchange](#create-compare-exchange) + * [Get compare-exchange](#get-compare-exchange) + * [Delete compare-exchange](#delete-compare-exchange) ## Create compare-exchange diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-csharp.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-csharp.mdx index 5fe08edee8..cad1bb9b3d 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-csharp.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-nodejs.mdx index 10f8b2db81..bc5a7b250d 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-nodejs.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-php.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-php.mdx index f96ce844cf..e91596beae 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-php.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-python.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-python.mdx index b4de0c9623..9f747cb017 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/content/_overview-python.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **CLUSTER-WIDE** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx index f254d57070..81deb1acc6 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) - * [Using 'Include' in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) + * [Using 'Include' in a NoTracking session will throw](#using-) ## Disable tracking changes for a specific entity diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx index 0925884aa0..5ecf54f934 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) - * [Using 'Include' in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) + * [Using 'Include' in a NoTracking session will throw](#using-) ## Disable tracking changes for a specific entity diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx index c8d3939362..934c521f87 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) ## Disable tracking changes for a specific entity diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx index db84155333..71fb1799ae 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) ## Disable tracking changes for a specific entity @@ -120,7 +120,7 @@ session.save_changes() * You can further customize and fine-tune which entities will not be tracked by configuring the `should_ignore_entity_changes` convention method on the document store. * This customization rule will apply to all sessions opened for this document store. -* Implement rules under your [ShouldIgnoreEntityChanges](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#syntax) subclass. +* Implement rules under your [ShouldIgnoreEntityChanges](#syntax) subclass. Apply the class's `check` method to control the ignore flow. **Example**: diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx index 63ca8c90a4..ed45e17156 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx index 11fd121412..718367eed4 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx index 1d1629bf3e..41acae09a9 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx index 672387bb93..6df246bba5 100644 --- a/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-csharp.mdx b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-csharp.mdx index 8169038ce0..876a8ea8a5 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-csharp.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [Load](../../../client-api/session/loading-entities.mdx#load) - - [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) - - [Stream](../../../client-api/session/loading-entities.mdx#stream) - - [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) + - [Load](#load) + - [Load with Includes](#load-with-includes) + - [Load - multiple entities](#load---multiple-entities) + - [LoadStartingWith](#loadstartingwith) + - [ConditionalLoad](#conditionalload) + - [Stream](#stream) + - [IsLoaded](#isloaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-java.mdx b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-java.mdx index 95ebeba1f7..2c8ba5337d 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-java.mdx @@ -9,13 +9,13 @@ There are several methods with many overloads that allow users to download docum from the database and convert them to entities. This article will cover the following methods: -- [Load](../../../client-api/session/loading-entities.mdx#load) -- [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) -- [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) -- [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) -- [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) -- [Stream](../../../client-api/session/loading-entities.mdx#stream) -- [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) +- [Load](#load) +- [Load with Includes](#load-with-includes) +- [Load - multiple entities](#load---multiple-entities) +- [LoadStartingWith](#loadstartingwith) +- [ConditionalLoad](#conditionalload) +- [Stream](#stream) +- [IsLoaded](#isloaded) ## Load diff --git a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-nodejs.mdx index 4165150126..e8b6ae1c1f 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-nodejs.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [Load](../../../client-api/session/loading-entities.mdx#load) - - [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) - - [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) - - [Stream](../../../client-api/session/loading-entities.mdx#stream) + - [Load](#load) + - [Load with Includes](#load-with-includes) + - [Load - multiple entities](#load---multiple-entities) + - [LoadStartingWith](#loadstartingwith) + - [ConditionalLoad](#conditionalload) + - [IsLoaded](#isloaded) + - [Stream](#stream) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-php.mdx b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-php.mdx index 995c0073f3..1ca8ffb5a0 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-php.mdx @@ -9,12 +9,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [`load`](../../../client-api/session/loading-entities.mdx#load) - - [`load` with `include`](../../../client-api/session/loading-entities.mdx#load-with-include) - - [`load` - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [`loadStartingWith`](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [`conditionalLoad`](../../../client-api/session/loading-entities.mdx#conditionalload) - - [`isLoaded`](../../../client-api/session/loading-entities.mdx#isloaded) + - [`load`](#load) + - [`load` with `include`](#load-with-include) + - [`load` - multiple entities](#load---multiple-entities) + - [`loadStartingWith`](#loadstartingwith) + - [`conditionalLoad`](#conditionalload) + - [`isLoaded`](#isloaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-python.mdx b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-python.mdx index b6bdadfe36..4c210ad2cf 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_loading-entities-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_loading-entities-python.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [load](../../../client-api/session/loading-entities.mdx#load) - - [load with includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [load_starting_with](../../../client-api/session/loading-entities.mdx#load_starting_with) - - [load_starting_with_into_stream](../../../client-api/session/loading-entities.mdx#load_starting_with_into_stream) - - [conditional_load](../../../client-api/session/loading-entities.mdx#conditional_load) - - [stream](../../../client-api/session/loading-entities.mdx#stream) - - [is_loaded](../../../client-api/session/loading-entities.mdx#is_loaded) + - [load](#load) + - [load with includes](#load-with-includes) + - [load_starting_with](#load_starting_with) + - [load_starting_with_into_stream](#load_starting_with_into_stream) + - [conditional_load](#conditional_load) + - [stream](#stream) + - [is_loaded](#is_loaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-csharp.mdx b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-csharp.mdx index a67c6656b5..4cfd9d5919 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; * Be sure to wrap the Session variable with a 'using' statement to ensure proper disposal. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -58,7 +58,7 @@ IAsyncDocumentSession OpenAsyncSession(SessionOptions options); | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `string` | The Session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------------------------|-------------------------------| diff --git a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-nodejs.mdx index 1a7f6b5ae9..25fc2681d7 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Refer to the specific documentation for each method usage. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -38,7 +38,7 @@ openSession(sessionOptions); | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | string | The session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with session configuration options. See details [below](#session-options). | | Return Value | Description | |---------------------|--------------------------------| diff --git a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-php.mdx b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-php.mdx index b4dec622f0..c5255a76c4 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-php.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; If no database is specified in the options then the [Default Database](../../../client-api/setting-up-default-database.mdx) (stored in the Document Store) is assumed. * Make sure you release allocated session resources using the `close` method or wrapping - the session object in a `try` statement ([see below](../../../client-api/session/opening-a-session.mdx#example-3---releasing-session-resources)). + the session object in a `try` statement ([see below](#example-3---releasing-session-resources)). * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session examples](../../../client-api/session/opening-a-session.mdx#open-session-examples) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session examples](#open-session-examples) ## Syntax @@ -41,7 +41,7 @@ public function openSession(SessionOptions $sessionOptions): DocumentSessionInte | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `string` | The Session will operate on this database,
overriding the default database set in the document store. | -| **options** | `sessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `sessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------|----------------------------| diff --git a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-python.mdx b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-python.mdx index e3724d9d50..7abb3835f3 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_opening-a-session-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * Be sure to wrap the session variable using a 'with' statement to ensure proper disposal. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -38,7 +38,7 @@ def open_session( | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `str` | The session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------------------------|-------------------------------| diff --git a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-csharp.mdx b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-csharp.mdx index 273571a4ea..33414f1831 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-csharp.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-nodejs.mdx index 0bc85e3d35..096237d59a 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-nodejs.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-php.mdx b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-php.mdx index 690e396fab..ab165855fc 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-php.mdx @@ -20,8 +20,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-python.mdx b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-python.mdx index 131b8dfdc4..2b3aa06954 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_updating-entities-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_updating-entities-python.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx index 3becc3349e..8447c9268c 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx index cf51d7a180..3d707460a3 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx index 14f8dd9c0a..589fed0073 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx index 1ba1be86b7..eac5d534c7 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx index 6cc0531f18..d75eef2df2 100644 --- a/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx index 1d2fdc9a35..14639ac3b6 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx index 6fcaa38c65..b1ff90dc63 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx @@ -12,8 +12,8 @@ operations. from the server, and it does not cause the session to track the document. * In this page: - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) - * [Example](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#example) + * [Syntax](#syntax) + * [Example](#example) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx index b49bb903ca..12ca96c51c 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx index 243e5326b6..f08e27c686 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document or the attachment to the session, and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx index 001acc290d..b5b57e65f8 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document or the attachment to the session, and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx index f33892d369..83617e9a73 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-java.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-java.mdx index a69c605d03..72044a1f0d 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-java.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * This does not [load](../../../../client-api/session/loading-entities.mdx) the document from the server or cause the session to track it. * In this page: - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) - * [Example](../../../../client-api/session/how-to/check-if-document-exists.mdx#example) + * [Syntax](#syntax) + * [Example](#example) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx index 63ca8a5abf..2684b10001 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-php.mdx index a5ccc2944b..4bfb1279c7 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-php.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document entity to the session, and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-python.mdx index daf2cca619..c0b40978bf 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-document-exists-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document entity to the session, and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx index ecde7a2667..6842390fad 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx index ce1ce8b0b4..9924dfd784 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx index 7d03bc04ae..3d1a89d402 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes on all tracked entities, see [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx index 4e957b7fad..2a68ef132d 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes to **all** tracked entities, see [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx index e949c38a74..1a83e39801 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx index 7241697279..453dcd5c91 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx index a75bf55fec..2a0f051e1c 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes on a specific **entity**, see [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx index 9eb9e1ee14..093e3e94ca 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes to a specific **entity**, see [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-csharp.mdx index 2e7ee57764..5924ce12f4 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * To remove only a **single entity** from tracking, see [Evict a single entity](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx). * In this article: - * [Clear the session's state](../../../../client-api/session/how-to/clear-a-session.mdx#clear-the-sessions-state) - * [Syntax](../../../../client-api/session/how-to/clear-a-session.mdx#syntax) + * [Clear the session's state](#clear-the-sessions-state) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-nodejs.mdx index 464c6e53ff..4e587e5706 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_clear-a-session-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * To remove only a **single entity** from tracking, see [Evict a single entity](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx). * In this article: - * [Clear the session's state](../../../../client-api/session/how-to/clear-a-session.mdx#clear-the-sessions-state) - * [Syntax](../../../../client-api/session/how-to/clear-a-session.mdx#syntax) + * [Clear the session's state](#clear-the-sessions-state) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-csharp.mdx index 9229817f2a..81ef9747f4 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are __executed as part of the session's SaveChanges transaction__. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-nodejs.mdx index 70a1a0963d..bd58180f8a 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are __executed as part of the session's saveChanges transaction__. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-php.mdx index 70997e97f5..16599c75d7 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are **executed as part of the session's `saveChanges` transaction**. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-python.mdx index 5810a03d23..2b53557d01 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_defer-operations-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are **executed as part of the session's `save_changes` transaction**. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx index 2e18238d01..520620848e 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx @@ -17,11 +17,11 @@ import CodeBlock from '@theme/CodeBlock'; To prevent an entity from being tracked, see [DisableTracking](../../../../client-api/session/configuration/how-to-disable-tracking.mdx). * In this article: - * [Evict an entity before saving](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-before-saving) - * [Evict an entity to force reload from server](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-to-force-reload-from-server) - * [Evict an entity from the session's delete queue](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-from-the-sessions-delete-queue) - * [Limitations](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#limitations) - * [Syntax](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#syntax) + * [Evict an entity before saving](#evict-an-entity-before-saving) + * [Evict an entity to force reload from server](#evict-an-entity-to-force-reload-from-server) + * [Evict an entity from the session's delete queue](#evict-an-entity-from-the-sessions-delete-queue) + * [Limitations](#limitations) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx index 9e73f3bd99..30f9b4b3b8 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx @@ -17,11 +17,11 @@ import CodeBlock from '@theme/CodeBlock'; To prevent an entity from being tracked, see [DisableTracking](../../../../client-api/session/configuration/how-to-disable-tracking.mdx). * In this article: - * [Evict an entity before saving](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-before-saving) - * [Evict an entity to force reload from server](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-to-force-reload-from-server) - * [Evict an entity from the session's delete queue](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-from-the-sessions-delete-queue) - * [Limitations](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#limitations) - * [Syntax](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#syntax) + * [Evict an entity before saving](#evict-an-entity-before-saving) + * [Evict an entity to force reload from server](#evict-an-entity-to-force-reload-from-server) + * [Evict an entity from the session's delete queue](#evict-an-entity-from-the-sessions-delete-queue) + * [Limitations](#limitations) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-csharp.mdx index 9af6bc0334..3b75188557 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; The counter names are available for each entity using the `GetCountersFor()` method from the `Advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx index 9738d3119d..70e6455d78 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; The counter names are available for each entity using the `getCountersFor()` method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-php.mdx index 9cc3089246..358febe537 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-php.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-python.mdx index f6466a011f..8d5ce95f97 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-entity-counters-python.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx index 3df1d61e83..34d6d5b7aa 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes). * In this page: - * [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx#get-tracked-entities) - * [Syntax](../../../../client-api/session/how-to/get-tracked-entities.mdx#syntax) + * [Get tracked entities](#get-tracked-entities) + * [Syntax](#syntax) ## Get tracked entities diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx index a1441b1309..169e1347c7 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes). * In this page: - * [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx#get-tracked-entities) - * [Syntax](../../../../client-api/session/how-to/get-tracked-entities.mdx#syntax) + * [Get tracked entities](#get-tracked-entities) + * [Syntax](#syntax) ## Get tracked entities diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx index ddca454e13..f31008965b 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx index a4fab7bcc3..416754e706 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily:](../../../../client-api/session/how-to/perform-operations-lazily.mdx#requests-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadentities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadwithinclude) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadstartingwith) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditionalload) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#runquery) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#getcompareexchange) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#implicit) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#explicit) + * [Requests that can be executed lazily:](#requests-that-can-be-executed-lazily) + * [Load entities](#loadentities) + * [Load entities with include](#loadwithinclude) + * [Load entities starting with](#loadstartingwith) + * [Conditional load](#conditionalload) + * [Run query](#runquery) + * [Get revisions](#getrevisions) + * [Get compare-exchange value](#getcompareexchange) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#implicit) + * [Execute all requests - explicitly](#explicit) ## Operations that can be executed lazily diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-php.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-php.mdx index bb414f7c14..ba0d365449 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-php.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-python.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-python.mdx index cbc34b9a31..70e5c32ef1 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_perform-operations-lazily-python.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx index 2dc6c754ed..9fdda9722d 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx @@ -19,18 +19,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [OnBeforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforestore) - * [OnBeforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforedelete) - * [OnAfterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#onaftersavechanges) - * [OnBeforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforequery) - * [OnBeforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforeconversiontodocument) - * [OnAfterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#onafterconversiontodocument) - * [OnBeforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforeconversiontoentity) - * [OnAfterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#onafterconversiontoentity) - * [OnSessionDisposing](../../../../client-api/session/how-to/subscribe-to-events.mdx#onsessiondisposing) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [OnBeforeStore](#onbeforestore) + * [OnBeforeDelete](#onbeforedelete) + * [OnAfterSaveChanges](#onaftersavechanges) + * [OnBeforeQuery](#onbeforequery) + * [OnBeforeConversionToDocument](#onbeforeconversiontodocument) + * [OnAfterConversionToDocument](#onafterconversiontodocument) + * [OnBeforeConversionToEntity](#onbeforeconversiontoentity) + * [OnAfterConversionToEntity](#onafterconversiontoentity) + * [OnSessionDisposing](#onsessiondisposing) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-java.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-java.mdx index 3f87a301f7..0c96db83fb 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-java.mdx @@ -20,17 +20,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [beforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforestore) - * [beforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforedelete) - * [afterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#aftersavechanges) - * [beforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforequery) - * [beforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontodocument) - * [afterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontodocument) - * [beforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontoentity) - * [afterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontoentity) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [beforeStore](#beforestore) + * [beforeDelete](#beforedelete) + * [afterSaveChanges](#aftersavechanges) + * [beforeQuery](#beforequery) + * [beforeConversionToDocument](#beforeconversiontodocument) + * [afterConversionToDocument](#afterconversiontodocument) + * [beforeConversionToEntity](#beforeconversiontoentity) + * [afterConversionToEntity](#afterconversiontoentity) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx index 952ab70fa8..49883a3e6f 100644 --- a/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx @@ -20,17 +20,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [beforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforestore) - * [beforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforedelete) - * [afterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#aftersavechanges) - * [beforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforequery) - * [beforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontodocument) - * [afterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontodocument) - * [beforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontoentity) - * [afterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontoentity) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [beforeStore](#beforestore) + * [beforeDelete](#beforedelete) + * [afterSaveChanges](#aftersavechanges) + * [beforeQuery](#beforequery) + * [beforeConversionToDocument](#beforeconversiontodocument) + * [afterConversionToDocument](#afterconversiontodocument) + * [beforeConversionToEntity](#beforeconversiontoentity) + * [afterConversionToEntity](#afterconversiontoentity) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx index f2faf6fd5d..16348e4aa3 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx @@ -7,11 +7,11 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [Count](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) + * [Count](#count) - * [LongCount](../../../../client-api/session/querying/how-to-count-query-results.mdx#longcount) + * [LongCount](#longcount) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [Get number of results from query stats](#get-count-from-query-stats) ## Count diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx index 7793fc996c..7e90880b81 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx @@ -7,9 +7,9 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [Count](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) + * [Count](#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [Get number of results from query stats](#get-count-from-query-stats) ## Count diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-php.mdx index 330d80edfa..59055d3cc6 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-php.mdx @@ -7,8 +7,8 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [`Count`](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [`Count`](#count) + * [Get number of results from query stats](#get-count-from-query-stats) ## `Count` diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-python.mdx index 9a77265c1b..be71f3c103 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-count-query-results-python.mdx @@ -7,8 +7,8 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [`count`](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [`count`](#count) + * [Get number of results from query stats](#get-count-from-query-stats) ## `count` diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-csharp.mdx index 6f72ff4b78..298ce40339 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-csharp.mdx @@ -15,17 +15,17 @@ import CodeBlock from '@theme/CodeBlock'; * Customization methods available: - - [BeforeQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#beforequeryexecuted) - - [AfterQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterqueryexecuted) - - [AfterStreamExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterstreamexecuted) - - [NoCaching](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) - - [NoTracking](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) - - [Projection](../../../../client-api/session/querying/how-to-customize-query.mdx#projection) - - [RandomOrdering](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [Timings](../../../../client-api/session/querying/how-to-customize-query.mdx#timings) - - [WaitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) - -* [Methods return value](../../../../client-api/session/querying/how-to-customize-query.mdx#methods-return-value) + - [BeforeQueryExecuted](#beforequeryexecuted) + - [AfterQueryExecuted](#afterqueryexecuted) + - [AfterStreamExecuted](#afterstreamexecuted) + - [NoCaching](#nocaching) + - [NoTracking](#notracking) + - [Projection](#projection) + - [RandomOrdering](#randomordering) + - [Timings](#timings) + - [WaitForNonStaleResults](#waitfornonstaleresults) + +* [Methods return value](#methods-return-value) diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-java.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-java.mdx index 17f36a07cd..5c9adcde99 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-java.mdx @@ -7,14 +7,14 @@ import CodeBlock from '@theme/CodeBlock'; The following query customization options are available in the `IDocumentQueryCustomization` interface: -- [BeforeQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#beforequeryexecuted) -- [AfterQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterqueryexecuted) -- [AfterStreamExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterstreamexecuted) -- [NoCaching](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) -- [NoTracking](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) -- [ProjectionBehavior](../../../../client-api/session/querying/how-to-customize-query.mdx#projectionbehavior) -- [RandomOrdering](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) -- [WaitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) +- [BeforeQueryExecuted](#beforequeryexecuted) +- [AfterQueryExecuted](#afterqueryexecuted) +- [AfterStreamExecuted](#afterstreamexecuted) +- [NoCaching](#nocaching) +- [NoTracking](#notracking) +- [ProjectionBehavior](#projectionbehavior) +- [RandomOrdering](#randomordering) +- [WaitForNonStaleResults](#waitfornonstaleresults) ## BeforeQueryExecuted diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx index b0846bfd60..37f493767e 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; - [on ("beforeQueryExecuted")](../../../../client-api/session/querying/how-to-customize-query.mdx#on-("beforequeryexecuted")) - [on ("afterQueryExecuted")](../../../../client-api/session/querying/how-to-customize-query.mdx#on-("afterqueryexecuted")) - - [noCaching](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) - - [noTracking](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) - - [projectionBehavior](../../../../client-api/session/querying/how-to-customize-query.mdx#projectionbehavior) - - [randomOrdering](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [timings](../../../../client-api/session/querying/how-to-customize-query.mdx#timings) - - [waitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) + - [noCaching](#nocaching) + - [noTracking](#notracking) + - [projectionBehavior](#projectionbehavior) + - [randomOrdering](#randomordering) + - [timings](#timings) + - [waitForNonStaleResults](#waitfornonstaleresults) ## on (beforeQueryExecuted) diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-php.mdx index 05e3077616..18d4751baf 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-php.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; [subscribing to `OnBeforeQuery`](../../../../client-api/session/how-to/subscribe-to-events.mdx). * Available customization methods : - - [`addBeforeQueryExecutedListener` and `removeBeforeQueryExecutedListener`](../../../../client-api/session/querying/how-to-customize-query.mdx#addbeforequeryexecutedlistener-and-removebeforequeryexecutedlistener) - - [`addAfterQueryExecutedListener` and `removeAfterQueryExecutedListener`](../../../../client-api/session/querying/how-to-customize-query.mdx#addafterqueryexecutedlistener-and-removeafterqueryexecutedlistener) - - [`noCaching`](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) - - [`noTracking`](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) - - [Projection](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [`randomOrdering`](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [`waitForNonStaleResults`](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) -* [Methods return value](../../../../client-api/session/querying/how-to-customize-query.mdx#methods-return-value) + - [`addBeforeQueryExecutedListener` and `removeBeforeQueryExecutedListener`](#addbeforequeryexecutedlistener-and-removebeforequeryexecutedlistener) + - [`addAfterQueryExecutedListener` and `removeAfterQueryExecutedListener`](#addafterqueryexecutedlistener-and-removeafterqueryexecutedlistener) + - [`noCaching`](#nocaching) + - [`noTracking`](#notracking) + - [Projection](#randomordering) + - [`randomOrdering`](#randomordering) + - [`waitForNonStaleResults`](#waitfornonstaleresults) +* [Methods return value](#methods-return-value) diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-python.mdx index 59971c84cd..48ffccd90b 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-customize-query-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * Customization methods available: - - [before_query_executed](../../../../client-api/session/querying/how-to-customize-query.mdx#before_query_executed) - - [after_query_executed](../../../../client-api/session/querying/how-to-customize-query.mdx#after_query_executed) - - [after_stream_executed](../../../../client-api/session/querying/how-to-customize-query.mdx#after_stream_executed) - - [no_caching](../../../../client-api/session/querying/how-to-customize-query.mdx#no_caching) - - [no_tracking](../../../../client-api/session/querying/how-to-customize-query.mdx#no_tracking) - - [projection](../../../../client-api/session/querying/how-to-customize-query.mdx#projection) - - [random_ordering](../../../../client-api/session/querying/how-to-customize-query.mdx#random_ordering) - - [timings](../../../../client-api/session/querying/how-to-customize-query.mdx#timings) - - [wait_for_non_stale_results](../../../../client-api/session/querying/how-to-customize-query.mdx#wait_for_non_stale_results) - -* [Methods return value](../../../../client-api/session/querying/how-to-customize-query.mdx#methods-return-value) + - [before_query_executed](#before_query_executed) + - [after_query_executed](#after_query_executed) + - [after_stream_executed](#after_stream_executed) + - [no_caching](#no_caching) + - [no_tracking](#no_tracking) + - [projection](#projection) + - [random_ordering](#random_ordering) + - [timings](#timings) + - [wait_for_non_stale_results](#wait_for_non_stale_results) + +* [Methods return value](#methods-return-value) diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx index 3dd2140f50..0e9fb45f89 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-java.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-java.mdx index b1bab1beae..bc12559544 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-java.mdx @@ -11,8 +11,8 @@ from the [Document Query](../../../../client-api/session/querying/document-query * If a document doesn't contain the specified field, it is excluded from the query results. * In this page: - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) - * [Examples](../../../../client-api/session/querying/how-to-filter-by-field.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx index 984ca5bf62..ee662878cd 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-php.mdx index 84bd60c3ad..c6b6de4cc7 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-python.mdx index 96eb83dec6..40347fd50e 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-field-python.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; Documents that do not contain the specified field will be excluded from the query results. * In this page: - * [Filter by Field Name or Path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name-or-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) - * [Examples](../../../../client-api/session/querying/how-to-filter-by-field.mdx#examples) + * [Filter by Field Name or Path](#filter-by-field-name-or-path) + * [Syntax](#syntax) + * [Examples](#examples) ## Filter by Field Name or Path diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx index 7b2fbf3277..5e12013b83 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx index 19d3be38ef..f7bbd65730 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx index d9232aad1e..a07adee803 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * There are situations where new fields are added to some documents in a collection over time. * To find documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx index e0978388fe..495d2805c4 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx index 806d3cfcc5..d61fb1f6a1 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx @@ -20,8 +20,8 @@ import Panel from '@site/src/components/Panel'; In such cases, the resulting `QueryStatistics` object will remain with its default values. * In this article: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx index d45633a999..31d7888a69 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx index 655fb415b4..fb36c057dd 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx index 91f6cb6f9d..aa3a188566 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx index 1413ec54da..6854efef87 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx @@ -23,21 +23,21 @@ import CodeBlock from '@theme/CodeBlock'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this page: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`Spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialFieldFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteriaFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`OrderByDistance`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`OrderByDistanceDescending`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`Spatial`](#section) + * [`DynamicSpatialFieldFactory`](#section-1) + * [`SpatialCriteriaFactory`](#section-2) + * [`OrderByDistance`](#section-3) + * [`OrderByDistanceDescending`](#section-4) ## Search by radius diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx index 04e23253f4..32db6d9c6f 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx @@ -5,9 +5,9 @@ import CodeBlock from '@theme/CodeBlock'; Spatial indexes can be queried using the `spatial` method which contains a full spectrum of spatial methods. The following article will cover these methods: -- [Spatial](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial) -- [OrderByDistance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistance) -- [OrderByDistanceDescending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistancedescending) +- [Spatial](#spatial) +- [OrderByDistance](#orderbydistance) +- [OrderByDistanceDescending](#orderbydistancedescending) ## Spatial diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx index 3781ae2f63..e29cdec724 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx @@ -23,16 +23,16 @@ import CodeBlock from '@theme/CodeBlock'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this page: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistance) - * [Order by distance desc](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistancedesc) - * [Rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#roundeddistance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#getresultingdistance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#orderbydistance) + * [Order by distance desc](#orderbydistancedesc) + * [Rounded distance](#roundeddistance) + * [Get resulting distance](#getresultingdistance) + * [Spatial API](#spatial-api) ## Search by radius diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx index a574b5b0e3..d7856a714d 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx @@ -23,21 +23,21 @@ import CodeBlock from '@theme/CodeBlock'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this page: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialField`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteria`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`order_by_distance`, `order_by_distance_wkt`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`order_by_distance_descending`, `order_by_distance_descending_wkt`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`spatial`](#section) + * [`DynamicSpatialField`](#section-1) + * [`SpatialCriteria`](#section-2) + * [`order_by_distance`, `order_by_distance_wkt`](#section-3) + * [`order_by_distance_descending`, `order_by_distance_descending_wkt`](#section-4) ## Search by radius diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx index d7ed44ad12..9965776c7c 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; creating auto map-reduce indexes. * In This Page: - * [Group By a Single Field](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-a-single-field) - * [Group By Multiple Fields](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-multiple-fields) - * [Select Composite GroupBy Key](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#select-composite-groupby-key) - * [Group By Array](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-array) - * [By Array Values](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-values) - * [By Array Content](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-content) - * [Sorting](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#sorting) - * [By Count](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-count) - * [By Sum](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-sum) + * [Group By a Single Field](#group-by-a-single-field) + * [Group By Multiple Fields](#group-by-multiple-fields) + * [Select Composite GroupBy Key](#select-composite-groupby-key) + * [Group By Array](#group-by-array) + * [By Array Values](#by-array-values) + * [By Array Content](#by-array-content) + * [Sorting](#sorting) + * [By Count](#by-count) + * [By Sum](#by-sum) ## Group By a Single Field diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx index 4fdf7472f7..34e176d008 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx index 652167ed64..36803a3e72 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx index 8531414868..71868517ff 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx @@ -16,11 +16,11 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more about queries in this [query overview](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy Aggregation](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-aggregation) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy Aggregation](#lazy-aggregation) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx index d667aab40e..2ff448a8e0 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx index 3284cf5129..69bfc81074 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; For projecting results when querying a **static-index** see [project index query results](../../../../indexes/querying/projections.mdx). * In this article: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) - * [Select](../../../../client-api/session/querying/how-to-project-query-results.mdx#select) - * [ProjectInto](../../../../client-api/session/querying/how-to-project-query-results.mdx#projectinto) - * [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Projections overview](#projections-overview) + * [Projection Methods](#projection-methods) + * [Select](#select) + * [ProjectInto](#projectinto) + * [SelectFields](#selectfields) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -66,11 +66,11 @@ import CodeBlock from '@theme/CodeBlock'; but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. * Only a single projection request can be made per Query (and DocumentQuery). - Learn more in [single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query). + Learn more in [single projection per query](#single-projection-per-query). **The cost of projections**: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-java.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-java.mdx index 2438925907..80350d8411 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-java.mdx @@ -6,8 +6,8 @@ import CodeBlock from '@theme/CodeBlock'; Instead of pulling full documents in query results you can just grab some pieces of data from documents. You can also transform the projected results. The projections are defined with the usage of: -- [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) -- [OfType](../../../../client-api/session/querying/how-to-project-query-results.mdx#oftype---simple-projection) +- [SelectFields](#selectfields) +- [OfType](#oftype---simple-projection) ## SelectFields diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx index 8aeaff4448..e92ad858f1 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; For projecting results when querying a **static-index** see [project index query results](../../../../indexes/querying/projections.mdx). * In this article: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) - * [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) - * [Projecting nested object types](../../../../client-api/session/querying/how-to-project-query-results.mdx#projecting-nested-object-types) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) - * [Syntax](../../../../client-api/session/querying/how-to-project-query-results.mdx#syntax) + * [Projections overview](#projections-overview) + * [SelectFields](#selectfields) + * [Projecting nested object types](#projecting-nested-object-types) + * [Single projection per query](#single-projection-per-query) + * [Syntax](#syntax) ## Projections overview @@ -30,7 +30,7 @@ import CodeBlock from '@theme/CodeBlock'; * The query can load [related documents](../../../../indexes/indexing-related-documents.mdx#what-are-related-documents) and have their data merged into the projection results. -* Content from inner objects and arrays can be projected in addition to [projecting the nested object types](../../../../client-api/session/querying/how-to-project-query-results.mdx#projecting-nested-object-types). +* Content from inner objects and arrays can be projected in addition to [projecting the nested object types](#projecting-nested-object-types). * An alias name can be given to the projected fields, and any calculations can be applied within the projection. **When to use projections**: @@ -67,7 +67,7 @@ import CodeBlock from '@theme/CodeBlock'; **The cost of projections**: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example-v---projection-with-calculations) + However, you can perform any [calculations](#example-v---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-php.mdx index 433242d4a9..6198deedb9 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-php.mdx @@ -13,13 +13,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) + * [Projections overview](#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) + * [Projection Methods](#projection-methods) * [`select`, `selectFields`](../../../../client-api/session/querying/how-to-project-query-results.mdx#select,-selectfields) - * [`ofType`](../../../../client-api/session/querying/how-to-project-query-results.mdx#oftype) + * [`ofType`](#oftype) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -73,12 +73,12 @@ import CodeBlock from '@theme/CodeBlock'; * Within the projection you can only filter what data will be returned from the matching documents, but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. -* Only a [single projection request](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) can be made per query. +* Only a [single projection request](#single-projection-per-query) can be made per query. ### The cost of projections: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-python.mdx index 6cf008121f..96f4fd6a62 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-project-query-results-python.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) + * [Projections overview](#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) - * [select_fields_query_data](../../../../client-api/session/querying/how-to-project-query-results.mdx#select_fields_query_data) - * [raw_query with `select`](../../../../client-api/session/querying/how-to-project-query-results.mdx#raw_query-with-select) - * [select_fields](../../../../client-api/session/querying/how-to-project-query-results.mdx#select_fields) + * [Projection Methods](#projection-methods) + * [select_fields_query_data](#select_fields_query_data) + * [raw_query with `select`](#raw_query-with-select) + * [select_fields](#select_fields) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -75,12 +75,12 @@ import CodeBlock from '@theme/CodeBlock'; but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. * Only a single projection request can be made per query. - Learn more in [single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query). + Learn more in [single projection per query](#single-projection-per-query). ### The cost of projections: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) * inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-csharp.mdx index 1ff1efe98c..5d9268deb6 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-csharp.mdx @@ -15,7 +15,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined with `Query` or `DocumentQuery` are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -29,12 +29,12 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [Session.Query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [Session.Advanced.DocumentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) - * [Session.Advanced.RawQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) - * [Custom methods and extensions for LINQ](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [Session.Query](#sessionquery) + * [Session.Advanced.DocumentQuery](#sessionadvanceddocumentquery) + * [Session.Advanced.RawQuery](#sessionadvancedrawquery) + * [Custom methods and extensions for LINQ](#custom-methods-and-extensions-for-linq) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -53,9 +53,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: - 1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) - 2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) - 3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) + 1. [Index query](#indexquery) + 2. [Dynamic query](#dynamicquery) + 3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -107,7 +107,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) and [Counters](../../../../document-extensions/counters/indexing.mdx). @@ -139,7 +139,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -152,7 +152,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -540,7 +540,7 @@ from "Employees" where FirstName = "Robert" ## Session.Advanced.RawQuery -* Queries defined with [Query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) or [DocumentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) +* Queries defined with [Query](#sessionquery) or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `RawQuery` method. @@ -588,7 +588,7 @@ List employees = await asyncSession ## Custom methods and extensions for LINQ -Available custom methods and extensions for the session's [Query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available custom methods and extensions for the session's [Query](#sessionquery) method: - [AggregateBy](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) - AnyAsync @@ -662,7 +662,7 @@ IRawDocumentQuery RawQuery(string query); | Return Value | | | - | - | -| `IRavenQueryable`
`IDocumentQuery`
`IRawDocumentQuery` | Instances exposing additional query methods and [extensions](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq) | +| `IRavenQueryable`
`IDocumentQuery`
`IRawDocumentQuery` | Instances exposing additional query methods and [extensions](#custom-methods-and-extensions-for-linq) | diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-nodejs.mdx index a6702af9ad..22a50154a3 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-nodejs.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined with the `query` method are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -27,11 +27,11 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [session.advanced.rawQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) - * [query API](../../../../client-api/session/querying/how-to-query.mdx#query-api) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#sessionquery) + * [session.advanced.rawQuery](#sessionadvancedrawquery) + * [query API](#query-api) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -50,9 +50,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: -1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) -2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) -3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) +1. [Index query](#indexquery) +2. [Dynamic query](#dynamicquery) +3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -104,7 +104,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) and [Counters](../../../../document-extensions/counters/indexing.mdx). @@ -136,7 +136,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -144,7 +144,7 @@ For each scenario, a different index type is used, as described below. ## session.query * The simplest way to issue a query is by using the session's `query` method. - Customize your query with these [API methods](../../../../client-api/session/querying/how-to-query.mdx#query-api). + Customize your query with these [API methods](#query-api). * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. @@ -341,7 +341,7 @@ from "products" limit 5, 10 // skip 5, take 10 ## session.advanced.rawQuery -* Queries defined with [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. +* Queries defined with [query](#sessionquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. @@ -369,7 +369,7 @@ const employees = await session.advanced ## query API -Available methods for the session's [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available methods for the session's [query](#sessionquery) method: - addOrder - addParameter @@ -479,7 +479,7 @@ session.rawQuery(query); | Return Value | | | - | - | -| `object` | Instance implementing `IDocumentQuery` exposing the additional [query methods](../../../../client-api/session/querying/how-to-query.mdx#query-api). | +| `object` | Instance implementing `IDocumentQuery` exposing the additional [query methods](#query-api). | * Note: Use `await` when executing the query, e.g. when calling `.all`, `.single`, `.first`, `.count`, etc. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-php.mdx index 44600ba484..3866a4359f 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-php.mdx @@ -15,7 +15,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined using `query` or `documentQuery` are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All RavenDB queries use an **index** to provide results, even when an index is not explicitly defined. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article shows examples of dynamic queries only. @@ -31,12 +31,12 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [session.advanced.documentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) - * [session.advanced.rawQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) - * [Custom methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#sessionquery) + * [session.advanced.documentQuery](#sessionadvanceddocumentquery) + * [session.advanced.rawQuery](#sessionadvancedrawquery) + * [Custom methods](#custom-methods) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -55,9 +55,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: -1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) -2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) -3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) +1. [Index query](#indexquery) +2. [Dynamic query](#dynamicquery) +3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -109,7 +109,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * RQL Example:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) @@ -142,7 +142,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -155,7 +155,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -339,8 +339,8 @@ from "Employees" where FirstName = "Robert" ## session.advanced.rawQuery -* Queries defined with [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - or [documentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) +* Queries defined with [query](#sessionquery) + or [documentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -370,7 +370,7 @@ $employees = $session ## Custom methods -Available custom methods for session's [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available custom methods for session's [query](#sessionquery) method: - [aggregateBy](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) - [count](../../../../client-api/session/querying/how-to-count-query-results.mdx) @@ -424,7 +424,7 @@ public function rawQuery(?string $className, string $query): RawDocumentQueryInt | Return Value | | | - | - | -| `DocumentQueryInterface`
`RawDocumentQueryInterface` | Interfaces exposing additional query methods and [extensions](../../../../client-api/session/querying/how-to-query.mdx#custom-methods) | +| `DocumentQueryInterface`
`RawDocumentQueryInterface` | Interfaces exposing additional query methods and [extensions](#custom-methods) | diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-python.mdx index 3928220ba0..781c2900ed 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-query-python.mdx @@ -15,7 +15,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined with `query` or `document_query` are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -29,12 +29,12 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [session.advanced.document_query](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocument_query) - * [session.advanced.raw_query](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedraw_query) - * [Custom methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#sessionquery) + * [session.advanced.document_query](#sessionadvanceddocument_query) + * [session.advanced.raw_query](#sessionadvancedraw_query) + * [Custom methods](#custom-methods) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -53,9 +53,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: -1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) -2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) -3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) +1. [Index query](#indexquery) +2. [Dynamic query](#dynamicquery) +3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -107,7 +107,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) and [Counters](../../../../document-extensions/counters/indexing.mdx). @@ -139,7 +139,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -151,7 +151,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -392,7 +392,7 @@ from "Employees" where FirstName = "Robert" ## session.advanced.raw_query -* Queries defined with [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) or [document_query](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocument_query) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) +* Queries defined with [query](#sessionquery) or [document_query](#sessionadvanceddocument_query) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `raw_query` method. @@ -422,7 +422,7 @@ employees = list( # Execute the query ## Custom methods -Available custom methods for session's [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available custom methods for session's [query](#sessionquery) method: - [aggregate_by](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) - [count](../../../../client-api/session/querying/how-to-count-query-results.mdx) @@ -508,7 +508,7 @@ def raw_query(self, query: str, object_type: Optional[Type[_T]] = None) -> RawDo | Return Value | | | - | - | -| `DocumentQuery[_T]`
`RawDocumentQuery[_T]` | Instances exposing additional query methods and [extensions](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq) | +| `DocumentQuery[_T]`
`RawDocumentQuery[_T]` | Instances exposing additional query methods and [extensions](#custom-methods-and-extensions-for-linq) | diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx index f287fbb234..dc0d6576a0 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx @@ -14,19 +14,19 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Streaming overview](../../../../client-api/session/querying/how-to-stream-query-results.mdx#streaming-overview) + * [Streaming overview](#streaming-overview) - * [Stream by query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-query) - * [Stream a dynamic query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-query) - * [Stream a dynamic raw query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-raw-query) - * [Stream a projected query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-projected-query) - * [Stream an index query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-an-index-query) - * [Stream related documents](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents) - * [By query syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-query-syntax) + * [Stream by query](#stream-by-query) + * [Stream a dynamic query](#stream-a-dynamic-query) + * [Stream a dynamic raw query](#stream-a-dynamic-raw-query) + * [Stream a projected query](#stream-a-projected-query) + * [Stream an index query](#stream-an-index-query) + * [Stream related documents](#stream-related-documents) + * [By query syntax](#by-query-syntax) - * [Stream by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-prefix) - * [Stream results by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-results-by-prefix) - * [By prefix syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-prefix-syntax) + * [Stream by prefix](#stream-by-prefix) + * [Stream results by prefix](#stream-results-by-prefix) + * [By prefix syntax](#by-prefix-syntax) ## Streaming overview @@ -50,7 +50,7 @@ import CodeBlock from '@theme/CodeBlock'; So calling [WaitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) is Not supported and will result in an exception. * Using [Include](../../../../client-api/how-to/handle-document-relationships.mdx#includes) to load a related document to the session in a streaming query is Not supported. - Learn how to __stream related documents__ here [below](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents). + Learn how to __stream related documents__ here [below](#stream-related-documents). diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx index 37adf6c91a..9286cf7de3 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx @@ -14,19 +14,19 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Streaming overview](../../../../client-api/session/querying/how-to-stream-query-results.mdx#streaming-overview) + * [Streaming overview](#streaming-overview) - * [Stream by query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-query) - * [Stream a dynamic query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-query) - * [Stream a dynamic raw query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-raw-query) - * [Stream a projected query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-projected-query) - * [Stream an index query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-an-index-query) - * [Stream related documents](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents) - * [By query syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-query-syntax) + * [Stream by query](#stream-by-query) + * [Stream a dynamic query](#stream-a-dynamic-query) + * [Stream a dynamic raw query](#stream-a-dynamic-raw-query) + * [Stream a projected query](#stream-a-projected-query) + * [Stream an index query](#stream-an-index-query) + * [Stream related documents](#stream-related-documents) + * [By query syntax](#by-query-syntax) - * [Stream by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-prefix) - * [Stream results by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-results-by-prefix) - * [By prefix syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-prefix-syntax) + * [Stream by prefix](#stream-by-prefix) + * [Stream results by prefix](#stream-results-by-prefix) + * [By prefix syntax](#by-prefix-syntax) ## Streaming overview @@ -50,7 +50,7 @@ import CodeBlock from '@theme/CodeBlock'; So calling [waitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) is Not supported and will result in an exception. * Using [include](../../../../client-api/session/loading-entities.mdx#load-with-includes) to load a related document to the session in a streaming query is Not supported. - Learn how to __stream related documents__ here [below](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents). + Learn how to __stream related documents__ here [below](#stream-related-documents). diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx index 02a7c436af..bd029be47f 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -85,7 +85,7 @@ List products = session * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx index ba55785cca..e0c66df8eb 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -85,7 +85,7 @@ const products = await session * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx index 8b7100a036..f5ea1949e9 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for a single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -87,7 +87,7 @@ public function suggestUsing(null|SuggestionBase|Closure $suggestionOrBuilder): * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx index 9d6ed237b1..91b67c67c6 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -82,7 +82,7 @@ products = list(session.query(object_type=Product).where_equals("name", "chaig") * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-csharp.mdx index 5a6b82c493..b714a3e784 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-csharp.mdx @@ -23,17 +23,17 @@ import Panel from '@site/src/components/Panel'; For sorting results when querying a **static-index** see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -106,7 +106,7 @@ order by UnitsInStock as long * E.g. in the above example, ordering by `x => x.UnitsInStock` will result in `OrderingType.Long` because that property data type is an integer. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-nodejs.mdx index 97989ccaff..de25d0fa4a 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-nodejs.mdx @@ -21,17 +21,17 @@ import CodeBlock from '@theme/CodeBlock'; For sorting results when querying a __static-index__ see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -75,7 +75,7 @@ __Ordering Type__: * In the above example, the ordering type was set to `Long`. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-php.mdx index 4395fe40c0..c6e291fdbc 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-php.mdx @@ -21,17 +21,17 @@ import CodeBlock from '@theme/CodeBlock'; For sorting results when querying a **static-index** see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -94,7 +94,7 @@ order by UnitsInStock as long * E.g. in the above example, ordering by `UnitsInStock` will result in `OrderingType::long` because this property's data type is integer. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-python.mdx index f6c6d4f2a1..95e32830a6 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/content/_sort-query-results-python.mdx @@ -21,17 +21,17 @@ import CodeBlock from '@theme/CodeBlock'; For sorting results when querying a **static-index** see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -78,7 +78,7 @@ order by UnitsInStock as long * E.g. in the above example, ordering by `x => x.units_in_stock` will result in `OrderingType.LONG` because that property data type is an integer. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx index db89081436..787da44432 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; For including explanations when querying a **static-index** see [Include explanations in index query](../../../../../indexes/querying/include-explanations.mdx). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx index 0e0e0bedac..56cb59b39d 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; For including explanations when querying a **static-index** see [Include explanations in index query](../../../../../indexes/querying/include-explanations.mdx). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-php.mdx index 85aefaa859..2ebfb9ff82 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-php.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-python.mdx index 5f5fc0efc1..ffc82e08ac 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_include-explanations-python.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-csharp.mdx index a694912f6d..836844b4c6 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-csharp.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-java.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-java.mdx index e9a3379dad..c9fe49a387 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-java.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-java.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx index d74ca7eaa3..27c4b04cd7 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-php.mdx index 149d462ffe..e0a8e1b47a 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-php.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-python.mdx index ff9f34b627..cc4de89b34 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/debugging/content/_query-timings-python.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx index 6a1947bd31..f83e0864fc 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * The main differences between `Query` and `DocumentQuery` are outlined in this article. * In this page: - * [API support](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#api-support) - * [Immutability](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#immutability) - * [Default query operator](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#default-query-operator) + * [API support](#api-support) + * [Immutability](#immutability) + * [Default query operator](#default-query-operator) ## API support diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx index 2454832fa2..907741e752 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; `documentQuery` examples as well. * In this page: - * [API support](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#api-support) - * [`query `and `documentQuery` equivalents](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#queryand-documentquery-equivalents) + * [API support](#api-support) + * [`query `and `documentQuery` equivalents](#queryand-documentquery-equivalents) ## API support diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx index 6ae3824af9..d5c740d076 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; `document_query` examples as well. * In this page: - * [API support](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#api-support) - * [Mutability](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#mutability) - * [Default query operator](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#default-query-operator) + * [API support](#api-support) + * [Mutability](#mutability) + * [Default query operator](#default-query-operator) ## API support diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx index a71ff8f744..2bd3286ab7 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx @@ -13,10 +13,10 @@ import CodeBlock from '@theme/CodeBlock'; as it provides low-level querying capabilities. See [Query -vs- DocumentQuery](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx) for all differences. * In this page: - * [DocumentQuery examples](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#documentquery-examples) - * [Convert between DocumentQuery and Query](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#convert-between-documentquery-and-query) - * [Custom Methods and Extensions](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#custom-methods-and-extensions) - * [Syntax](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#syntax) + * [DocumentQuery examples](#documentquery-examples) + * [Convert between DocumentQuery and Query](#convert-between-documentquery-and-query) + * [Custom Methods and Extensions](#custom-methods-and-extensions) + * [Syntax](#syntax) ## DocumentQuery examples diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx index afc0499fbf..a23467eb5e 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; for additional details. * In this page: - * [documentQuery examples](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#documentquery-examples) - * [Custom methods](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#custom-methods) - * [Syntax](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#syntax) + * [documentQuery examples](#documentquery-examples) + * [Custom methods](#custom-methods) + * [Syntax](#syntax) ## documentQuery examples diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx index bf3e6011af..3204eb6826 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; `document_query` examples as well. * In this page: - * [`document_query` Examples](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#document_query-examples) - * [Convert between `document_query` and `query`](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#convert-between-document_query-and-query) - * [Available Custom Methods and Extensions](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#convert-between-document_query-and-query) + * [`document_query` Examples](#document_query-examples) + * [Convert between `document_query` and `query`](#convert-between-document_query-and-query) + * [Available Custom Methods and Extensions](#convert-between-document_query-and-query) ## `document_query` Examples diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx index f24ff0660a..85044d8302 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx index f739878858..36efc42489 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-php.mdx index afec9ee7d4..2db6616c11 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-php.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-python.mdx index b35fc8eff4..c2e1b31463 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_boost-search-results-python.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx index 9f327739a3..96638a2ef4 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [EndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#endswith) + * [EndsWith](#endswith) * [EndsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#endswith-(case-sensitive)) - * [Negate EndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-endswith) + * [Negate EndsWith](#negate-endswith) ## EndsWith diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx index a78d599e5a..3dc15b046b 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx @@ -15,10 +15,10 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [whereEndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#whereendswith) + * [whereEndsWith](#whereendswith) * [whereEndsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#whereendswith-(case-sensitive)) - * [Negate whereEndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-whereendswith) - * [Syntax](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#syntax) + * [Negate whereEndsWith](#negate-whereendswith) + * [Syntax](#syntax) ## whereEndsWith diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-php.mdx index e35bde40b7..2102b52f58 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with) + * [where_ends_with](#where_ends_with) * [where_ends_with (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with-(case-sensitive)) - * [Negate where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-where_ends_with) + * [Negate where_ends_with](#negate-where_ends_with) ## where_ends_with diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-python.mdx index 5680751ecc..57a0295800 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_ends-with-query-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with) + * [where_ends_with](#where_ends_with) * [where_ends_with (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with-(case-sensitive)) - * [Negate where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-where_ends_with) + * [Negate where_ends_with](#negate-where_ends_with) ## where_ends_with diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx index 7871aaa8cc..9e0a32f0b7 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; using the [default exact analyzer](../../../../../indexes/using-analyzers.mdx#ravendb) where the casing of the original text is not changed. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx index 488a5ae35e..711fd8a101 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; using the [default exact analyzer](../../../../../indexes/using-analyzers.mdx#ravendb) where the casing of the original text is not changed. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-php.mdx index 1d57417b2e..fec318b8c1 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; where the casing of the original text is unchanged. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-python.mdx index 65260c6a8a..a4a01b0705 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_exact-match-query-python.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; where the casing of the original text is unchanged. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx index 4ae75bf59e..a2b87e04b7 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -122,7 +122,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -239,7 +239,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search options](#search-operators). diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx index 934235157f..315e9c597e 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx @@ -28,12 +28,12 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-php.mdx index 4722745241..73833ded78 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-php.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -108,7 +108,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -198,7 +198,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-python.mdx index 3603b4beab..cb227fe0b8 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_full-text-search-python.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -90,7 +90,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -131,7 +131,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search options](#search-operators). diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx index beb2a9dad2..0a605cf7ea 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Fuzzy` method when querying with `WhereEquals`. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx index 207482bada..f918b7f8d0 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `fuzzy` method when querying with `whereEquals`. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx index 38f12424ce..f56f513204 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; misspelled or has minor variations. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx index 47e3a70125..d28f096303 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `fuzzy` method when querying with `where_equals`. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx index 1d52ef49d8..3ada57bdad 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -168,7 +168,7 @@ string fragmentsHtml = builder.AppendLine("").ToString(); - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx index 3c56a7354d..016238ca5b 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a __dynamic-query__. For highlighting search results when querying a __static-index__ see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -131,7 +131,7 @@ fragmentsHtml += ""; - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be __customized__ to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx index 954c3d56c7..d1fc04d268 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -134,7 +134,7 @@ $fragmentsHtml = $builder; - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx index 0f7e0b4cfc..f06540cb03 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -132,7 +132,7 @@ fragments_html = builder.append(f"\{os.linesep\}") - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx index fff8325ff5..02ed429c7d 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx @@ -13,10 +13,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Proximity` method when running a **full-text search** by the [Search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx index a1880d69c7..241c80d8a3 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a __full-text search__ by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-php.mdx index b8aae434d8..9411af649f 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a **full-text search** by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-python.mdx index fe1f59aa8f..e65b9ba21b 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_proximity-search-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a **full-text search** by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx index c5a42d9cb5..e2eeb1cacc 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx index 32bff0e775..88c3a5606e 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx @@ -10,10 +10,10 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [whereStartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#wherestartswith) + * [whereStartsWith](#wherestartswith) * [whereStartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#wherestartswith-(case-sensitive)) - * [Negate whereStartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-wherestartswith) - * [Syntax](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#syntax) + * [Negate whereStartsWith](#negate-wherestartswith) + * [Syntax](#syntax) ## whereStartsWith diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-php.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-php.mdx index b6eb7fb103..3e9eff6bb4 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-php.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-python.mdx b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-python.mdx index d8b9ad2d9e..f3f257a8f0 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-python.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/text-search/content/_starts-with-query-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/versioned_docs/version-6.2/client-api/session/querying/what-is-rql.mdx b/versioned_docs/version-6.2/client-api/session/querying/what-is-rql.mdx index ce6f2132b7..c7cc9f5d17 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/what-is-rql.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/what-is-rql.mdx @@ -30,29 +30,29 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [The query pipeline](../../../client-api/session/querying/what-is-rql.mdx#the-query-pipeline) + * [The query pipeline](#the-query-pipeline) - * [RQL keywords and methods](../../../client-api/session/querying/what-is-rql.mdx#rql-keywords-and-methods) + * [RQL keywords and methods](#rql-keywords-and-methods) - * [`declare`](../../../client-api/session/querying/what-is-rql.mdx#declare) - * [`from`](../../../client-api/session/querying/what-is-rql.mdx#from) - * [`where`](../../../client-api/session/querying/what-is-rql.mdx#where) - * [`group by`](../../../client-api/session/querying/what-is-rql.mdx#group-by) - * [`include`](../../../client-api/session/querying/what-is-rql.mdx#include) - * [`order by`](../../../client-api/session/querying/what-is-rql.mdx#order-by) - * [`select`](../../../client-api/session/querying/what-is-rql.mdx#select) - * [`load`](../../../client-api/session/querying/what-is-rql.mdx#load) - * [`limit`](../../../client-api/session/querying/what-is-rql.mdx#limit) - * [`update`](../../../client-api/session/querying/what-is-rql.mdx#update) + * [`declare`](#declare) + * [`from`](#from) + * [`where`](#where) + * [`group by`](#group-by) + * [`include`](#include) + * [`order by`](#order-by) + * [`select`](#select) + * [`load`](#load) + * [`limit`](#limit) + * [`update`](#update) - * [RQL comments](../../../client-api/session/querying/what-is-rql.mdx#rql-comments) + * [RQL comments](#rql-comments) ## The query pipeline The query pipeline in RavenDB includes the following main stages: -1. __Detect query source__ ([`from`](../../../client-api/session/querying/what-is-rql.mdx#from)) +1. __Detect query source__ ([`from`](#from)) * Based on your query, RavenDB will determine the appropriate data source from which to retrieve results. @@ -67,23 +67,23 @@ The query pipeline in RavenDB includes the following main stages: * Learn more about these __query scenarios__ in this [Query Overview](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). -2. __Filter the data__ ([`where`](../../../client-api/session/querying/what-is-rql.mdx#where)) +2. __Filter the data__ ([`where`](#where)) * The index is scanned for records that match the query predicate. -3. __Include related documents__ ([`include`](../../../client-api/session/querying/what-is-rql.mdx#include)) +3. __Include related documents__ ([`include`](#include)) * [Related documents](../../../client-api/how-to/handle-document-relationships.mdx#includes) that are included in the query will be retrieved and returned to the client along with the resulting matching documents, reducing the need to do another network round trip to the database when accessing the included documents. -4. __Sort results__ ([`order by`](../../../client-api/session/querying/what-is-rql.mdx#order-by)) +4. __Sort results__ ([`order by`](#order-by)) * Query results can be sorted. For example, you can order by a field value, by the resulting documents' score, by random ordering, etc. -5. __Limit results__ ([`limit`](../../../client-api/session/querying/what-is-rql.mdx#limit)) +5. __Limit results__ ([`limit`](#limit)) * You can specify the number of results you want to get back from the query and the number of results you want to skip. -6. __Project results__ ([`select`](../../../client-api/session/querying/what-is-rql.mdx#select)) +6. __Project results__ ([`select`](#select)) * [Projections](../../../indexes/querying/projections.mdx) are specified when you need to retrieve only specific document fields, instead of the whole full document. This reduces the amount of data sent over the network and is useful when only partial data is needed. When projections are Not defined on the query - then the full document content is retrieved from the document storage. @@ -92,7 +92,7 @@ The query pipeline in RavenDB includes the following main stages: This means that the projection doesn't apply to all the documents in the database, only to the results that are actually returned. - * Data can be loaded ([`load`](../../../client-api/session/querying/what-is-rql.mdx#load)) from related documents to be used in the projected fields. + * Data can be loaded ([`load`](#load)) from related documents to be used in the projected fields. * For each record, the server extracts the requested field: If a field is stored in the index - the server will fetch it from the index. @@ -106,12 +106,12 @@ The query pipeline in RavenDB includes the following main stages: The following keywords and methods are available in RQL: -- [DECLARE](../../../client-api/session/querying/what-is-rql.mdx#declare) -- [FROM](../../../client-api/session/querying/what-is-rql.mdx#from) +- [DECLARE](#declare) +- [FROM](#from) - index -- [GROUP BY](../../../client-api/session/querying/what-is-rql.mdx#group-by) +- [GROUP BY](#group-by) - [array()](../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-content) -- [WHERE](../../../client-api/session/querying/what-is-rql.mdx#where) +- [WHERE](#where) - id() - [search()](../../../client-api/session/querying/text-search/full-text-search.mdx) - cmpxchg() @@ -128,7 +128,7 @@ The following keywords and methods are available in RQL: - [spatial.disjoint()](../../../indexes/querying/spatial.mdx) - [spatial.intersects()](../../../indexes/querying/spatial.mdx) - [moreLikeThis()](../../../client-api/session/querying/how-to-use-morelikethis.mdx) -- [ORDER BY](../../../client-api/session/querying/what-is-rql.mdx#order-by) +- [ORDER BY](#order-by) - [ASC | ASCENDING](../../../indexes/querying/sorting.mdx#basics) - [DESC | DESCENDING](../../../indexes/querying/sorting.mdx#basics) - [AS](../../../indexes/querying/sorting.mdx#basics) @@ -139,8 +139,8 @@ The following keywords and methods are available in RQL: - [random()](../../../indexes/querying/sorting.mdx#random-ordering) - [score()](../../../indexes/querying/sorting.mdx#ordering-by-score) - [spatial.distance()](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) -- [LOAD](../../../client-api/session/querying/what-is-rql.mdx#load) -- [SELECT](../../../client-api/session/querying/what-is-rql.mdx#select) +- [LOAD](#load) +- [SELECT](#select) - DISTINCT - key() - sum() @@ -148,9 +148,9 @@ The following keywords and methods are available in RQL: - [facet()](../../../indexes/querying/faceted-search.mdx) - [timeseries()](../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#syntax) - [counter()](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) -- [LIMIT](../../../client-api/session/querying/what-is-rql.mdx#limit) -- [UPDATE](../../../client-api/session/querying/what-is-rql.mdx#update) -- [INCLUDE](../../../client-api/session/querying/what-is-rql.mdx#include) +- [LIMIT](#limit) +- [UPDATE](#update) +- [INCLUDE](#include) With the following operators: diff --git a/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-csharp.mdx b/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-csharp.mdx index 4bdf46a8fc..eff1ee8bd7 100644 --- a/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-csharp.mdx +++ b/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-csharp.mdx @@ -44,7 +44,7 @@ Task ExportAsync( | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `string` | Path to a file where exported data will be written | | **token** | `CancellationToken` | Token used to cancel the operation | @@ -64,7 +64,7 @@ Task ExportAsync( | **IncludeArtificial** | `bool` | Should artificial documents be exported.
Default: `false` | | **IncludeArchived** | `bool` | Should archived documents be exported.
Default: `true` | | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes.
Default: `false` | -| **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **MaxStepsForTransformScript** | `int` | Maximum number of steps that the transform script can process before failing.
Default: **10000** | ### Example @@ -111,7 +111,7 @@ Task ImportAsync( | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `Stream` | Stream with data to import | | **fromFile** | `string` | Path to a file from which data will be imported | | **token** | `CancellationToken` | Token used to cancel the operation | @@ -131,7 +131,7 @@ Task ImportAsync( | **IncludeArtificial** | `bool` | Should artificial documents be imported.
Default: `false` | | **IncludeArchived** | `bool` | Should archived documents be imported.
Default: `true` | | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes.
Default: `false` | -| **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](#transformscript). | | **MaxStepsForTransformScript** | `int` | Maximum number of steps that the transform script can process before failing.
Default: **10000** | ### Example diff --git a/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-java.mdx b/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-java.mdx index dd4f20fd0c..4aa61924d9 100644 --- a/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-java.mdx +++ b/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-java.mdx @@ -37,7 +37,7 @@ public Operation exportAsync(DatabaseSmugglerExportOptions options, DatabaseSmug | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `String` | Path to a file where exported data will be written | @@ -54,7 +54,7 @@ public Operation exportAsync(DatabaseSmugglerExportOptions options, DatabaseSmug | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be exported from database record. Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications` | | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | ### Example @@ -83,7 +83,7 @@ public Operation importAsync(DatabaseSmugglerImportOptions options, InputStream | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `InputStream` | Stream with data to import | | **fromFile** | `String` | Path to a file from which data will be imported | @@ -100,7 +100,7 @@ public Operation importAsync(DatabaseSmugglerImportOptions options, InputStream | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be imported. Default: `CLIENT`, `CONFLICT_SOLVER_CONFIG`, `EXPIRATION`, `EXTERNAL_REPLICATIONS`, `PERIODIC_BACKUPS`, `RAVEN_CONNECTION_STRINGS`, `RAVEN_ETLS`, `REVISIONS`, `SQL_CONNECTION_STRINGS`, `SORTERS`, `SQL_ETLS`, `HUB_PULL_REPLICATIONS`, `SINK_PULL_REPLICATIONS` | | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | diff --git a/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx b/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx index ca9f9b333d..23e3b30d17 100644 --- a/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx +++ b/versioned_docs/version-6.2/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx @@ -38,7 +38,7 @@ const operation = await store.smuggler.export(options, toFile); | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `string` | Path to a file where exported data will be written | @@ -56,7 +56,7 @@ const operation = await store.smuggler.export(options, toFile); | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | **includeArtificial** | `boolean` | ? | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | **skipRevisionCreation** | `boolean` | skip revision creation | | **encryptionKey** | `string` | Encryption key used for restore | @@ -92,7 +92,7 @@ const operation = await store.smuggler.import(options, stream); | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `Stream` | Stream with data to import | | **fromFile** | `string` | Path to a file from which data will be imported | @@ -109,7 +109,7 @@ const operation = await store.smuggler.import(options, stream); | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | **includeArtificial** | `boolean` | ? | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | **skipRevisionCreation** | `boolean` | skip revision creation | | **encryptionKey** | `string` | Encryption key used for restore | diff --git a/versioned_docs/version-6.2/data-archival/content/_archived-documents-and-other-features-csharp.mdx b/versioned_docs/version-6.2/data-archival/content/_archived-documents-and-other-features-csharp.mdx index eeb0ba1e40..53584863d7 100644 --- a/versioned_docs/version-6.2/data-archival/content/_archived-documents-and-other-features-csharp.mdx +++ b/versioned_docs/version-6.2/data-archival/content/_archived-documents-and-other-features-csharp.mdx @@ -21,16 +21,16 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more below about how various RavenDB features interact with archived documents. * In this article: - * [Archived documents and indexing](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-indexing) - * [Archived documents and querying](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-querying) - * [Archived documents and data subscriptions](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-subscriptions) - * [Archived documents and document extensions](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-document-extensions) + * [Archived documents and indexing](#archived-documents-and-indexing) + * [Archived documents and querying](#archived-documents-and-querying) + * [Archived documents and data subscriptions](#archived-documents-and-subscriptions) + * [Archived documents and document extensions](#archived-documents-and-document-extensions) * [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.mdx#archived-documents-and-expiration) - * [Archived documents and ETL](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-etl) - * [Archived documents and backup](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-backup) - * [Archived documents and replication](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-replication) - * [Archived documents and patching](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-patching) + * [Archived documents and expiration](#archived-documents-and-expiration) + * [Archived documents and ETL](#archived-documents-and-etl) + * [Archived documents and backup](#archived-documents-and-backup) + * [Archived documents and replication](#archived-documents-and-replication) + * [Archived documents and patching](#archived-documents-and-patching) ## Archived documents and indexing diff --git a/versioned_docs/version-6.2/data-archival/content/_enable-data-archiving-csharp.mdx b/versioned_docs/version-6.2/data-archival/content/_enable-data-archiving-csharp.mdx index edf5a2ee0a..89613a3570 100644 --- a/versioned_docs/version-6.2/data-archival/content/_enable-data-archiving-csharp.mdx +++ b/versioned_docs/version-6.2/data-archival/content/_enable-data-archiving-csharp.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to schedule documents for archival in [Schedule document archiving](../../data-archival/schedule-document-archiving.mdx). * In this article: - * [Enable archiving - from the Client API](../../data-archival/enable-data-archiving.mdx#enable-archiving---from-the-client-api) - * [Enable archiving - from the Studio](../../data-archival/enable-data-archiving.mdx#enable-archiving---from-the-studio) + * [Enable archiving - from the Client API](#enable-archiving---from-the-client-api) + * [Enable archiving - from the Studio](#enable-archiving---from-the-studio) ## Enable archiving - from the Client API diff --git a/versioned_docs/version-6.2/data-archival/content/_schedule-document-archiving-csharp.mdx b/versioned_docs/version-6.2/data-archival/content/_schedule-document-archiving-csharp.mdx index abd4693fdf..ccf2571a9b 100644 --- a/versioned_docs/version-6.2/data-archival/content/_schedule-document-archiving-csharp.mdx +++ b/versioned_docs/version-6.2/data-archival/content/_schedule-document-archiving-csharp.mdx @@ -21,10 +21,10 @@ import CodeBlock from '@theme/CodeBlock'; * You can schedule documents for archival even if the archiving feature is not yet enabled. These documents will be archived once the feature is enabled and the task runs - provided the scheduled time has already passed. * In this article: - * [Schedule a SINGLE document for archiving - from the Client API](../../data-archival/schedule-document-archiving.mdx#schedule-a-single-document-for-archiving---from-the-client-api) - * [Schedule a SINGLE document for archiving - from the Studio](../../data-archival/schedule-document-archiving.mdx#schedule-a-single-document-for-archiving---from-the-studio) - * [Schedule MULTIPLE documents for archiving - from the Client API](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving---from-the-client-api) - * [Schedule MULTIPLE documents for archiving - from the Studio](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving---from-the-studio) + * [Schedule a SINGLE document for archiving - from the Client API](#schedule-a-single-document-for-archiving---from-the-client-api) + * [Schedule a SINGLE document for archiving - from the Studio](#schedule-a-single-document-for-archiving---from-the-studio) + * [Schedule MULTIPLE documents for archiving - from the Client API](#schedule-multiple-documents-for-archiving---from-the-client-api) + * [Schedule MULTIPLE documents for archiving - from the Studio](#schedule-multiple-documents-for-archiving---from-the-studio) ## Schedule a SINGLE document for archiving - from the Client API @@ -259,7 +259,7 @@ To learn more about the `PatchByQueryOperation`, see [Set-based patch operations **Example**: The following patch script, used directly in the Studio, -performs the same operation as the [Client API example](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving---from-the-client-api) shown above. +performs the same operation as the [Client API example](#schedule-multiple-documents-for-archiving---from-the-client-api) shown above. ![Schedule multiple documents for archiving](../assets/schedule-multiple-documents-for-archiving.png) diff --git a/versioned_docs/version-6.2/data-archival/content/_unarchiving-documents-csharp.mdx b/versioned_docs/version-6.2/data-archival/content/_unarchiving-documents-csharp.mdx index 2f9cdfa358..aec2aeabec 100644 --- a/versioned_docs/version-6.2/data-archival/content/_unarchiving-documents-csharp.mdx +++ b/versioned_docs/version-6.2/data-archival/content/_unarchiving-documents-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; To properly unarchive a document, use the `archived.unarchive()` method as described below. * In this article: - * [Unarchive documents - from the Client API](../../data-archival/unarchiving-documents.mdx#unarchive-documents---from-the-client-api) - * [Unarchive documents - from the Studio](../../data-archival/unarchiving-documents.mdx#unarchive-documents---from-the-studio) - * [Unarchiving documents with index-based patch queries](../../data-archival/unarchiving-documents.mdx#unarchiving-documents-with-index-based-patch-queries) + * [Unarchive documents - from the Client API](#unarchive-documents---from-the-client-api) + * [Unarchive documents - from the Studio](#unarchive-documents---from-the-studio) + * [Unarchiving documents with index-based patch queries](#unarchiving-documents-with-index-based-patch-queries) ## Unarchive documents - from the Client API @@ -141,7 +141,7 @@ await store.Operations.SendAsync(patchByQueryOp); **Example**: The following patch script, used directly in the Studio, -performs the same operation as the [Client API example](../../data-archival/unarchiving-documents.mdx#unarchive-documents---from-the-client-api) shown above. +performs the same operation as the [Client API example](#unarchive-documents---from-the-client-api) shown above. It will unarchive all archived documents in the _Orders_ collection. ![Unarchive documents](../assets/unarchive-documents.png) diff --git a/versioned_docs/version-6.2/data-archival/overview.mdx b/versioned_docs/version-6.2/data-archival/overview.mdx index 185720765b..202c34eae7 100644 --- a/versioned_docs/version-6.2/data-archival/overview.mdx +++ b/versioned_docs/version-6.2/data-archival/overview.mdx @@ -28,11 +28,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To take advantage of the archiving feature, you must first **enable** it. Once enabled, you can **schedule** documents for archiving. - Learn more in the [Overview](../data-archival/overview.mdx#overview) section below. + Learn more in the [Overview](#overview) section below. * In this article: - * [Overview](../data-archival/overview.mdx#overview) - * [The archived document](../data-archival/overview.mdx#the-archived-document) - * [Licensing](../data-archival/overview.mdx#licensing) + * [Overview](#overview) + * [The archived document](#the-archived-document) + * [Licensing](#licensing) ## Overview diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-csharp.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-csharp.mdx index 9129a15fb4..f07ef04c73 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-csharp.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; Use its `AttachmentsFor` interface to add attachments to documents with great speed. * In this page: - * [Usage flow](../../../document-extensions/attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../document-extensions/attachments/bulk-insert.mdx#usage-example) - * [Syntax](../../../document-extensions/attachments/bulk-insert.mdx#syntax) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-nodejs.mdx index 11bbb48bad..ab7c934bdc 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-nodejs.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; Use its `attachmentsFor` interface to add attachments to documents with great speed. * In this page: - * [Usage flow](../../../document-extensions/attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../document-extensions/attachments/bulk-insert.mdx#usage-example) - * [Syntax](../../../document-extensions/attachments/bulk-insert.mdx#syntax) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) + * [Syntax](#syntax) diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-python.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-python.mdx index 683e19c455..75a07cb056 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_bulk-insert-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `store` * In this page: - * [Usage flow](../../../document-extensions/attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../document-extensions/attachments/bulk-insert.mdx#usage-example) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx index bc2d0bcefb..9b619c5e19 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; removing the need to transfer the entire attachment binary data over the network in order to perform the action. * In this page: - * [Copy attachment](../../../document-extensions/attachments/copying-moving-renaming.mdx#copy-attachment) - * [Move attachment](../../../document-extensions/attachments/copying-moving-renaming.mdx#move-attachment) - * [Rename attachment](../../../document-extensions/attachments/copying-moving-renaming.mdx#rename-attachment) - * [Syntax](../../../document-extensions/attachments/copying-moving-renaming.mdx#syntax) + * [Copy attachment](#copy-attachment) + * [Move attachment](#move-attachment) + * [Rename attachment](#rename-attachment) + * [Syntax](#syntax) ## Copy attachment diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-csharp.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-csharp.mdx index ac45de2dc2..21eb99c0f6 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Index attachments details](../../../document-extensions/attachments/indexing.mdx#index-attachments-details) - * [Index details & content - by attachment name](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name) - * [Index details & content - all attachments](../../../document-extensions/attachments/indexing.mdx#index-details--content---all-attachments) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) + * [Index attachments details](#index-attachments-details) + * [Index details & content - by attachment name](#index-details--content---by-attachment-name) + * [Index details & content - all attachments](#index-details--content---all-attachments) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) + * [Syntax](#syntax) ## Index attachments details @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; These details can then be used when defining the index-fields. Once the index is deployed, you can query the index to find Employee documents based on these attachment properties. -* To index **attachments' content**, see the examples [below](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name). +* To index **attachments' content**, see the examples [below](#index-details--content---by-attachment-name). diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-java.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-java.mdx index 4c7f466a2e..bd6549a526 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-java.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-nodejs.mdx index f567024d88..38ccd754dc 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Index attachments details](../../../document-extensions/attachments/indexing.mdx#index-attachments-details) - * [Index details & content - by attachment name](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name) - * [Index details & content - all attachments](../../../document-extensions/attachments/indexing.mdx#index-details--content---all-attachments) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) + * [Index attachments details](#index-attachments-details) + * [Index details & content - by attachment name](#index-details--content---by-attachment-name) + * [Index details & content - all attachments](#index-details--content---all-attachments) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) + * [Syntax](#syntax) ## Index attachments details @@ -32,7 +32,7 @@ import CodeBlock from '@theme/CodeBlock'; These details can then be used when defining the index-fields. Once the index is deployed, you can query the index to find Employee documents based on these attachment properties. -* To index **attachments' content**, see the examples [below](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name). +* To index **attachments' content**, see the examples [below](#index-details--content---by-attachment-name). diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-php.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-php.mdx index eaba66cd10..201e7cde04 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-python.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-python.mdx index a111cc4312..3c111a6179 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_indexing-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/attachments/content/_loading-csharp.mdx b/versioned_docs/version-6.2/document-extensions/attachments/content/_loading-csharp.mdx index 45e94e529e..948ffbd003 100644 --- a/versioned_docs/version-6.2/document-extensions/attachments/content/_loading-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/attachments/content/_loading-csharp.mdx @@ -8,8 +8,8 @@ Learn in this page how to load a part of an attachment, an entire attachment, or multiple attachments. * In this page: - * [Load attachments](../../../document-extensions/attachments/loading.mdx#load-attachments) - * [Load a part of an attachment](../../../document-extensions/attachments/loading.mdx#load-a-part-of-an-attachment) + * [Load attachments](#load-attachments) + * [Load a part of an attachment](#load-a-part-of-an-attachment) ## Load attachments diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-csharp.mdx index 82c92397e3..867dc450e3 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-csharp.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -38,7 +38,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -163,7 +163,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -210,16 +210,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-java.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-java.mdx index 70d4cd51cd..ccfd1cf30a 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-java.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -37,7 +37,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be projected from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -158,7 +158,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -204,15 +204,15 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | ### Counters Bulk-Insert diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx index 5a10815080..79d98f8083 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -37,7 +37,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -159,7 +159,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -205,16 +205,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | ### Counters Bulk-Insert diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-php.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-php.mdx index 015ec29d60..e491f907df 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-php.mdx @@ -10,12 +10,12 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL` + * [Counters and Other Features: summary](#counters-and-other-features-summary) @@ -35,7 +35,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Send the server **raw queries** for execution. * You can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get counter values from a query without downloading whole documents. @@ -150,14 +150,14 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-python.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-python.mdx index a6f4b3f16f..77fa1ad6f8 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_counters-and-other-features-python.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -36,7 +36,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -119,7 +119,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -165,16 +165,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-csharp.mdx index 78ac478369..77db1611c6 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `CountersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`Increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`Increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `Increment` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-java.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-java.mdx index 8ca6e85d3c..c2431a76a3 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-java.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` uage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` uage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-nodejs.mdx index fad6827da4..0d6d73c910 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `Increment` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-php.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-php.mdx index 074a7e3a61..14fc5a54c8 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-python.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-python.mdx index 39e7bae3cd..c579b094bc 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_create-or-modify-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `counters_for ` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-csharp.mdx index 612c1a6c01..2e562c2d25 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `CountersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`Delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`Delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `Delete ` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-java.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-java.mdx index 14ae398fe3..ef88364085 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-java.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-nodejs.mdx index 0b91b01e49..b6825c32f5 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-php.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-php.mdx index 140a5e1ff1..c28441d596 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-python.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-python.mdx index e5ed6eb00a..7aaa3bc370 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_delete-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_delete-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `counters_for` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-csharp.mdx index 73d2d5aae1..52eb147828 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-csharp.mdx @@ -17,18 +17,18 @@ import Panel from '@site/src/components/Panel'; [Create subscription - include counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). * In this article: - * [Sample data](../../../document-extensions/counters/including-counters.mdx#sample-data) - * [Include counters when **loading**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-loading) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters) - * [Include counters when **querying**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-querying) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter-1) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters-1) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters-1) - * [Including multiple item types](../../../document-extensions/counters/including-counters.mdx#including-multiple-item-types) - * [Include behavior and constraints](../../../document-extensions/counters/including-counters.mdx#include-behavior-and-constraints) - * [Syntax](../../../document-extensions/counters/including-counters.mdx#syntax) + * [Sample data](#sample-data) + * [Include counters when **loading**](#include-counters-when-loading) + * [Include single counter](#include-single-counter) + * [Include multiple counters](#include-multiple-counters) + * [Include all counters](#include-all-counters) + * [Include counters when **querying**](#include-counters-when-querying) + * [Include single counter](#include-single-counter-1) + * [Include multiple counters](#include-multiple-counters-1) + * [Include all counters](#include-all-counters-1) + * [Including multiple item types](#including-multiple-item-types) + * [Include behavior and constraints](#include-behavior-and-constraints) + * [Syntax](#syntax) @@ -631,8 +631,8 @@ using (var session = store.OpenSession(new SessionOptions The following sections describe behavior that applies when including counters - whether during **load or query**: -* [Counters that don't exist at include time](../../../document-extensions/counters/including-counters.mdx#counters-that-dont-exist-at-include-time) -* [Do not mix IncludeAllCounters with individual counter includes](../../../document-extensions/counters/including-counters.mdx#do-not-mix-includeallcounters-with-individual-counter-includes) +* [Counters that don't exist at include time](#counters-that-dont-exist-at-include-time) +* [Do not mix IncludeAllCounters with individual counter includes](#do-not-mix-includeallcounters-with-individual-counter-includes) --- diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-nodejs.mdx index 0473522606..5b1c11f880 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_including-counters-nodejs.mdx @@ -17,18 +17,18 @@ import Panel from '@site/src/components/Panel'; [Create subscription - include counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). * In this article: - * [Sample data](../../../document-extensions/counters/including-counters.mdx#sample-data) - * [Include counters when **loading**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-loading) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters) - * [Include counters when **querying**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-querying) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter-1) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters-1) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters-1) - * [Including multiple item types](../../../document-extensions/counters/including-counters.mdx#including-multiple-item-types) - * [Include behavior and constraints](../../../document-extensions/counters/including-counters.mdx#include-behavior-and-constraints) - * [Syntax](../../../document-extensions/counters/including-counters.mdx#syntax) + * [Sample data](#sample-data) + * [Include counters when **loading**](#include-counters-when-loading) + * [Include single counter](#include-single-counter) + * [Include multiple counters](#include-multiple-counters) + * [Include all counters](#include-all-counters) + * [Include counters when **querying**](#include-counters-when-querying) + * [Include single counter](#include-single-counter-1) + * [Include multiple counters](#include-multiple-counters-1) + * [Include all counters](#include-all-counters-1) + * [Including multiple item types](#including-multiple-item-types) + * [Include behavior and constraints](#include-behavior-and-constraints) + * [Syntax](#syntax) @@ -411,8 +411,8 @@ const product = await session.load("products/1-A", { The following sections describe behavior that applies when including counters - whether during **load or query**: -* [Counters that don't exist at include time](../../../document-extensions/counters/including-counters.mdx#counters-that-dont-exist-at-include-time) -* [Do not mix IncludeAllCounters with individual counter includes](../../../document-extensions/counters/including-counters.mdx#do-not-mix-includeallcounters-with-individual-counter-includes) +* [Counters that don't exist at include time](#counters-that-dont-exist-at-include-time) +* [Do not mix IncludeAllCounters with individual counter includes](#do-not-mix-includeallcounters-with-individual-counter-includes) --- diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-csharp.mdx index b29f514b68..5668586e49 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-csharp.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-java.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-java.mdx index e342f170a1..7427114c1b 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-java.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-nodejs.mdx index 9ddac7ee83..0282b47914 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-nodejs.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask ` or `AbstractRawJavaScrip * Auto-indexes for counters are not available at this time. * In this page: - * [Usage](../../../document-extensions/counters/indexing.mdx#usage) - * [AbstractCsharpCountersIndexCreationTask ](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Usage](#usage) + * [AbstractCsharpCountersIndexCreationTask ](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-php.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-php.mdx index 59042cb3e6..132f160803 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-php.mdx @@ -11,9 +11,9 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-python.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-python.mdx index 3b10b00c0d..781e452cfc 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_indexing-python.mdx @@ -11,9 +11,9 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-csharp.mdx index 79d7abb12d..6c69d0fc15 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-csharp.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `CountersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `CountersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-java.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-java.mdx index 9ee2f16a00..b7842ae2e2 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-java.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `CountersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `CountersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-nodejs.mdx index 55125a4171..0b88a42de5 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-nodejs.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `countersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `countersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-php.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-php.mdx index 53a3b68c47..d7e4b02565 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-php.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `countersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `countersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-python.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-python.mdx index b4ee656dbd..59ad374ad2 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_overview-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_overview-python.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `counters_for` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `counters_for` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx index c3fcf41ec3..21deaafddf 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-java.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-java.mdx index 80b4df4ea1..5749da8aea 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-java.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx index 91c3d4f505..65fa2968d0 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-php.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-php.mdx index 1b539f803f..784d3d8f61 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-php.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get values of specific counters](../../../document-extensions/counters/retrieve-counter-values.mdx#get-values-of-specific-counters) - * [`get` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage) - * [`get` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example) - * [`get` syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [`getAll` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage-1) - * [`getAll` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example-1) - * [`getAll` Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax-1) + * [Get values of specific counters](#get-values-of-specific-counters) + * [`get` usage](#usage) + * [`get` example](#example) + * [`get` syntax](#syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [`getAll` usage](#usage-1) + * [`getAll` example](#example-1) + * [`getAll` Syntax](#syntax-1) ## Get values of specific counters diff --git a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-python.mdx b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-python.mdx index 39ae484137..62c5a82f10 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/content/_retrieve-counter-values-python.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [`get` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage) - * [`get` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example) - * [`get` syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [`get_all` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage-1) - * [`get_all` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example-1) - * [`get_all` Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax-1) + * [Get a single Counter's value](#get-a-single-counter) + * [`get` usage](#usage) + * [`get` example](#example) + * [`get` syntax](#syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [`get_all` usage](#usage-1) + * [`get_all` example](#example-1) + * [`get_all` Syntax](#syntax-1) ## Get a single Counter's value diff --git a/versioned_docs/version-6.2/document-extensions/counters/counters-in-clusters.mdx b/versioned_docs/version-6.2/document-extensions/counters/counters-in-clusters.mdx index 02e94661ba..ee0e2b16ed 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/counters-in-clusters.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/counters-in-clusters.mdx @@ -21,14 +21,14 @@ import Panel from '@site/src/components/Panel'; * When conflicting actions (such as _Delete_ and _Increment_) may occur, and how they are resolved * In this article: - * [Counter value modification](../../document-extensions/counters/counters-in-clusters.mdx#counter-value-modification) - * [Value modification and replication flow](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication-flow) - * [Reading a Counter's value](../../document-extensions/counters/counters-in-clusters.mdx#reading-a-counters-value) - * [Counter name modification](../../document-extensions/counters/counters-in-clusters.mdx#counter-name-modification) - * [Concurrent value modification](../../document-extensions/counters/counters-in-clusters.mdx#concurrent-value-modification) - * [Concurrent `Delete` and `Increment`](../../document-extensions/counters/counters-in-clusters.mdx#concurrent-delete-and-increment) - * [In a single-node system](../../document-extensions/counters/counters-in-clusters.mdx#in-a-single-node-system) - * [In a multi-node cluster](../../document-extensions/counters/counters-in-clusters.mdx#in-a-multi-node-cluster) + * [Counter value modification](#counter-value-modification) + * [Value modification and replication flow](#value-modification-and-replication-flow) + * [Reading a Counter's value](#reading-a-counters-value) + * [Counter name modification](#counter-name-modification) + * [Concurrent value modification](#concurrent-value-modification) + * [Concurrent `Delete` and `Increment`](#concurrent-delete-and-increment) + * [In a single-node system](#in-a-single-node-system) + * [In a multi-node cluster](#in-a-multi-node-cluster) @@ -57,7 +57,7 @@ In the following example: | ProductLikes | **B** | **33** | | ProductLikes | C | 10 | -After a Counter’s value is modified on a node, that node [replicates](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication) +After a Counter’s value is modified on a node, that node [replicates](#value-modification-and-replication) the updated value to all other nodes in the cluster. In the above example: * The "ProductLikes" Counter was incremented by 5 on node B. @@ -104,7 +104,7 @@ In the following example: **The same Counter can be concurrently modified by multiple clients**. -As explained in the [Value modification and replication flow](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication-flow) section, +As explained in the [Value modification and replication flow](#value-modification-and-replication-flow) section, each node manages its own portion of a Counter’s value independently. As a result: diff --git a/versioned_docs/version-6.2/document-extensions/overview-extensions.mdx b/versioned_docs/version-6.2/document-extensions/overview-extensions.mdx index fbfd9d7169..6eeefe77f1 100644 --- a/versioned_docs/version-6.2/document-extensions/overview-extensions.mdx +++ b/versioned_docs/version-6.2/document-extensions/overview-extensions.mdx @@ -28,8 +28,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; [dedicated to this subject](../sharding/document-extensions.mdx). * In this page: - * [Document Extensions](../document-extensions/overview-extensions.mdx#document-extensions) - * [Studio Document Extension Views](../document-extensions/overview-extensions.mdx#studio-document-extension-views) + * [Document Extensions](#document-extensions) + * [Studio Document Extension Views](#studio-document-extension-views) ## Document Extensions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-csharp.mdx index 3e9f9d128f..db7f1a1da5 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed from the [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * From the **Client API**, revisions can be configured and managed by: - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-java.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-java.mdx index 517669054d..035a2a35d0 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-java.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Learn about revisions here: [Docuument Revisions Overview](../../../../document-extensions/revisions/overview.mdx) * In this page: - * [Revisions Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Revisions Session methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Revisions Store Operations](#revisions-store-operations) + * [Revisions Session methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-nodejs.mdx index eb28887268..e589e7d003 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed from the [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * From the **Client API**, revisions can be configured and managed by: - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-php.mdx index 290f891ca8..341d26454e 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed using [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * Find below a list of methods that revisions can be configured and managed by. - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions `store` Operations diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-python.mdx index aa1deb7104..0a936c618e 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/content/_overview-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed using [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * Find below a list of methods that revisions can be configured and managed by. - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions `store` Operations diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx index 7bb14d7a4b..454fd259a2 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx index a9d1c3f942..9649d445ff 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; using the Configure Revisions Operation. * In this page: - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) - * [RevisionsCollectionConfiguration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) - * [RevisionsConfiguration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionsconfiguration) - * [ConfigureRevisionsOperation](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#configurerevisionsoperation) - * [Example](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#example) + * [Syntax](#syntax) + * [RevisionsCollectionConfiguration](#revisionscollectionconfiguration) + * [RevisionsConfiguration](#revisionsconfiguration) + * [ConfigureRevisionsOperation](#configurerevisionsoperation) + * [Example](#example) ## Syntax @@ -27,13 +27,13 @@ settings. To configure the revisions settings for a database and/or the collections in that database, follow these steps: -[1.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) +[1.](#revisionscollectionconfiguration) Create a RevisionsCollectionConfiguration` object for each desired collection. -[2.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionsconfiguration) +[2.](#revisionsconfiguration) Put those `RevisionsCollectionConfiguration` objects in a `RevisionsConfiguration` object. -[3.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#configurerevisionsoperation) +[3.](#configurerevisionsoperation) Send that RevisionsConfiguration` to the server. ### RevisionsCollectionConfiguration @@ -96,7 +96,7 @@ configuration. Note that when this object is sent to the server, it overrides the configurations for **all** collections, including all existing configurations currently on the server. If a collection is not listed in `collections` and `defaultConfig` has not been set, the -default values listed in the table [above](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) +default values listed in the table [above](#revisionscollectionconfiguration) are applied. ### ConfigureRevisionsOperation diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx index 4f6b26d10f..dd420e2a24 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx index 30d31e4cd9..41febc2361 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx index 571f2ed252..658e69088b 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx index 1d035bf9ee..d056609af9 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx index 830c7d26d5..2b57d9a678 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx index 31e5ac31f6..0a835b0367 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx index ab72252c40..74575f1ed1 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Delete all revisions - single document](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-all-revisions---single-document) - * [Delete revisions - multiple documents](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions---multiple-documents) - * [Delete revisions by time frame](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions-by-time-frame) - * [Delete revisions by change vectors](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions-by-change-vectors) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#syntax) + * [Delete all revisions - single document](#delete-all-revisions---single-document) + * [Delete revisions - multiple documents](#delete-revisions---multiple-documents) + * [Delete revisions by time frame](#delete-revisions-by-time-frame) + * [Delete revisions by change vectors](#delete-revisions-by-change-vectors) + * [Syntax](#syntax) ## Delete all revisions - single document diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx index b939e97f83..34e00c5698 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [GetCountFor](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx index fd2f34531d..bd0181b2cb 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [getCountFor](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx index 340c2acb32..fb984e7578 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [get_count_for](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx index e001b90934..dfa4c019e0 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [get_count_for](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx index 7ece213782..7440bf2e06 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the advance session method `GetCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx index 2c16073f83..b37e4e853a 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the advance session method `getCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-php.mdx index 42316254e4..807e435fe6 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the session `advanced` method `getCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-python.mdx index 803dc2f4ed..632cd5234c 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_counting-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the session `advanced` method `get_count_for`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-csharp.mdx index e14515fbda..1336e84a2a 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-csharp.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a SINGLE revision can be included per document. - To include MULTIPLE revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include MULTIPLE revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include SINGLE or MULTIPLE document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -512,8 +512,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx index 70a7d963eb..33f022fa2b 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a SINGLE revision can be included per document. - To include MULTIPLE revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include MULTIPLE revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include SINGLE or MULTIPLE document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -388,8 +388,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-php.mdx index cb0428e279..5533aa9bb9 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_including-php.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a **single** revision can be included per document. - To include **multiple** revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include **multiple** revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include single or multiple document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -493,8 +493,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx index c28a13e13b..8a3c7bc981 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx index 2c8aacefca..18091068c2 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-php.mdx index fe28da7797..bb38aae3df 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-python.mdx index 3952370bc2..bb063b677e 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/session/content/_loading-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-csharp.mdx index 1e1e8553cf..4a9028e5ba 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-csharp.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -212,8 +212,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-nodejs.mdx index 5a5f757a5d..772b67e1a6 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-nodejs.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -212,8 +212,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-python.mdx index 5d0011ebe2..a0328a1e4d 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_overview-python.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -239,8 +239,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx index dd71f58a1c..ab70f2f2ae 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx index 90792c663f..4de6c9ab2c 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-php.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-php.mdx index 36adab43bd..98ea2e68e1 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-php.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-python.mdx b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-python.mdx index baba211f92..4ebe5ec46d 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/content/_revisions-and-other-features-python.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx b/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx index faa6af3411..52284f8e48 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; see [Revert documents to specific time](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx). * In this article: - * [Overview](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#overview) - * [Revert documents](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-documents) - * [Revert single document](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-single-document) - * [Revert multiple documents](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-multiple-documents) - * [Syntax](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#syntax) + * [Overview](#overview) + * [Revert documents](#revert-documents) + * [Revert single document](#revert-single-document) + * [Revert multiple documents](#revert-multiple-documents) + * [Syntax](#syntax) @@ -62,7 +62,7 @@ import Panel from '@site/src/components/Panel'; The change-vector of a revision can be obtained via: - * The Client API - follow the code in the examples [below](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-single-document) + * The Client API - follow the code in the examples [below](#revert-single-document) * Or from the document view in the Studio ![Get revision CV](../assets/get-cv-for-revision.png) diff --git a/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx b/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx index fd65202796..331b2c8f42 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx @@ -28,11 +28,11 @@ import Panel from '@site/src/components/Panel'; and facilitate instant recovery without the need to search and retrieve a stored backup. * In this article: - * [The revisions settings view](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#the-revisions-settings-view) - * [Revert documents](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents) - * [Point in time](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#point-in-time) - * [Time Window](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#time-window) - * [Content reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#content-reverted) + * [The revisions settings view](#the-revisions-settings-view) + * [Revert documents](#revert-documents) + * [Point in time](#point-in-time) + * [Time Window](#time-window) + * [Content reverted](#content-reverted) @@ -44,7 +44,7 @@ import Panel from '@site/src/components/Panel'; In the Studio, go to _Settings > Document Revisions_. From this view you can: * [Set](../../../studio/database/settings/document-revisions.mdx#revisions-configuration) revision configurations * [Enforce](../../../studio/database/settings/document-revisions.mdx#enforce-configuration) revision configurations - * [Revert](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents) documents to revisions + * [Revert](#revert-documents) documents to revisions 2. **Revision configurations**: * The ability to revert documents to their past revisions depends on revisions being created. @@ -54,7 +54,7 @@ import Panel from '@site/src/components/Panel'; 3. **Revert documents**: Click the _Revert Revisions_ button to revert documents from all or selected collections to a specified point in time. - Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents). + Learn more [below](#revert-documents). @@ -62,9 +62,9 @@ import Panel from '@site/src/components/Panel'; ![Revert Revisions](./assets/revert-revisions-2.png) -1. Enter the **Point in Time** to which you would like to revert the documents. Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#point-in-time). +1. Enter the **Point in Time** to which you would like to revert the documents. Learn more [below](#point-in-time). -2. Enter the **Time Window**. Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#time-window). +2. Enter the **Time Window**. Learn more [below](#time-window). 3. Revert **All collections** in the database, or toggle to select **Specific collections** to revert. diff --git a/versioned_docs/version-6.2/document-extensions/revisions/revisions-bin-cleaner.mdx b/versioned_docs/version-6.2/document-extensions/revisions/revisions-bin-cleaner.mdx index 6d1d395d8a..d8941fccdc 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/revisions-bin-cleaner.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/revisions-bin-cleaner.mdx @@ -20,10 +20,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; you can also set up a cleaner task to remove them automatically. Learn more below. * In this page: - * [The revisions bin cleaner](../../document-extensions/revisions/revisions-bin-cleaner.mdx#the-revisions-bin-cleaner) - * [Setting the revisions bin cleaner - from the Studio](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-studio) - * [Setting the revisions bin cleaner - from the Client API](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-client-api) - * [Syntax](../../document-extensions/revisions/revisions-bin-cleaner.mdx#syntax) + * [The revisions bin cleaner](#the-revisions-bin-cleaner) + * [Setting the revisions bin cleaner - from the Studio](#setting-the-revisions-bin-cleaner---from-the-studio) + * [Setting the revisions bin cleaner - from the Client API](#setting-the-revisions-bin-cleaner---from-the-client-api) + * [Syntax](#syntax) ## The revisions bin cleaner @@ -40,8 +40,8 @@ ALL the revisions associated with the deleted document are **permanently deleted * **Entries age to keep** - The cleaner deletes revision entries older than this value. * The cleaner task can be managed from: - * The [Revisions bin cleaner view](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio - * The [Client API](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-client-api). + * The [Revisions bin cleaner view](#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio + * The [Client API](#setting-the-revisions-bin-cleaner---from-the-client-api). * When working with a secure server: * Configuring the Revisions Bin Cleaner is logged in the [audit log](../../server/security/audit-log/audit-log-overview.mdx). diff --git a/versioned_docs/version-6.2/document-extensions/revisions/troubleshooting.mdx b/versioned_docs/version-6.2/document-extensions/revisions/troubleshooting.mdx index 3c7e85aaf2..0b570b154f 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/troubleshooting.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/troubleshooting.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`ThrowRevisionKeyTooBig` exception](../../document-extensions/revisions/troubleshooting.mdx#throwrevisionkeytoobig-exception) + * [`ThrowRevisionKeyTooBig` exception](#throwrevisionkeytoobig-exception) ## `ThrowRevisionKeyTooBig` exception diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx index 4c9784b36e..b58dac757a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; but without the overhead associated with the _Session_, resulting in significantly improved performance. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#examples) - * [Append single entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-single-entry) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-entries) - * [Append multiple values per entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-values-per-entry) - * [Append multiple time series](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) - * [Syntax](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append single entry](#append-single-entry) + * [Append multiple entries](#append-multiple-entries) + * [Append multiple values per entry](#append-multiple-values-per-entry) + * [Append multiple time series](#append-multiple-time-series) + * [Syntax](#syntax) @@ -41,7 +41,7 @@ import CodeBlock from '@theme/CodeBlock'; * To append multiple entries, call `Append` as many times as needed. * Ensure there is at least a 1-millisecond interval between each timestamp. * The client converts all timestamps to **UTC** before sending the batch to the server. -* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) below. +* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](#append-multiple-time-series) below. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx index 4096f6adc3..7af153503b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; but without the overhead associated with the _Session_, resulting in significantly improved performance. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#examples) - * [Append single entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-single-entry) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-entries) - * [Append multiple values per entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-values-per-entry) - * [Append multiple time series](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) - * [Syntax](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append single entry](#append-single-entry) + * [Append multiple entries](#append-multiple-entries) + * [Append multiple values per entry](#append-multiple-values-per-entry) + * [Append multiple time series](#append-multiple-time-series) + * [Syntax](#syntax) @@ -41,7 +41,7 @@ import CodeBlock from '@theme/CodeBlock'; * To append multiple entries, call `append` as many times as needed. * Ensure there is at least a 1-millisecond interval between each timestamp. * The client converts all timestamps to **UTC** before sending the batch to the server. -* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) below. +* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](#append-multiple-time-series) below. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx index 5de832d7c5..fde7db2fd4 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; * The server treats timestamps passed in the scripts as **UTC**, no conversion is applied by the client to local time. * In this page: - * [JavaScript time series API methods](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#javascript-time-series-api-methods) - * [timeseries - choose a time series](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section) - * [timeseries.append - append an entry](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-1) - * [timeseries.delete - delete entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) - * [timeseries.get - get entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) - * [Examples](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#examples) + * [JavaScript time series API methods](#javascript-time-series-api-methods) + * [timeseries - choose a time series](#section) + * [timeseries.append - append an entry](#section-1) + * [timeseries.delete - delete entries](#section-2) + * [timeseries.get - get entries](#section-3) + * [Examples](#examples) ## JavaScript time series API methods diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx index a8a8dd226f..896c752a4e 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; * The server treats timestamps passed in the scripts as **UTC**, no conversion is applied by the client to local time. * In this page: - * [JavaScript time series API methods](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#javascript-time-series-api-methods) - * [timeseries - choose a time series](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section) - * [timeseries.append - append an entry](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-1) - * [timeseries.delete - delete entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) - * [timeseries.get - get entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) - * [Examples](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#examples) + * [JavaScript time series API methods](#javascript-time-series-api-methods) + * [timeseries - choose a time series](#section) + * [timeseries.append - append an entry](#section-1) + * [timeseries.delete - delete entries](#section-2) + * [timeseries.get - get entries](#section-3) + * [Examples](#examples) ## JavaScript time series API methods diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx index c2735d6b84..d10029fab8 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; you need to register the time series types on the server. * In this page: - * [Named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#named-values) - * [Define time series type](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#define-time-series-type) - * [Examples](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#examples) - * [Register time series type](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#register-time-series-type) - * [Usage](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#usage) - * [Syntax](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#syntax) + * [Named values](#named-values) + * [Define time series type](#define-time-series-type) + * [Examples](#examples) + * [Register time series type](#register-time-series-type) + * [Usage](#usage) + * [Syntax](#syntax) ## Named values diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx index 47f7dc5d7a..a9830e3332 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; you need to register the named values on the server. * In this page: - * [Named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#named-values) - * [Define time series class with named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#define-time-series-class-with-named-values) - * [Examples](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#examples) - * [Register time series named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#register-time-series-named-values) - * [Usage](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#usage) - * [Syntax](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#syntax) + * [Named values](#named-values) + * [Define time series class with named values](#define-time-series-class-with-named-values) + * [Examples](#examples) + * [Register time series named values](#register-time-series-named-values) + * [Usage](#usage) + * [Syntax](#syntax) ## Named values diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-csharp.mdx index aebb944f2c..02d3eec7cf 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-csharp.mdx @@ -12,10 +12,10 @@ You can use the API to **append** (create and update), **get**, **delete**, **include**, **patch** and **query** time series data. * In this page: - * [Creating and Removing Time Series](../../../../document-extensions/timeseries/client-api/overview.mdx#creating-and-removing-time-series) - * [`session` Methods -vs- `document-store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#session-methods--vs--document-store-operations) - * [Available Time Series `session` methods](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-session-methods) - * [Available Time Series `store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-store-operations) + * [Creating and Removing Time Series](#creating-and-removing-time-series) + * [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations) + * [Available Time Series `session` methods](#available-time-series-session-methods) + * [Available Time Series `store` Operations](#available-time-series-store-operations) ## Creating and Removing Time Series diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx index bd2dc85c4b..32bcf14b1b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx @@ -12,10 +12,10 @@ You can use the API to **append** (create and update), **get**, **delete**, **include**, **patch** and **query** time series data. * In this page: - * [Creating and Removing Time Series](../../../../document-extensions/timeseries/client-api/overview.mdx#creating-and-removing-time-series) - * [`session` Methods -vs- `document-store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#session-methods--vs--document-store-operations) - * [Available Time Series `session` methods](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-session-methods) - * [Available Time Series `store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-store-operations) + * [Creating and Removing Time Series](#creating-and-removing-time-series) + * [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations) + * [Available Time Series `session` methods](#available-time-series-session-methods) + * [Available Time Series `store` Operations](#available-time-series-store-operations) ## Creating and Removing Time Series diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx index b61a2ca8f7..c3f2b88b97 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#delete-multiple-entries) - * [Append & Delete entries in the same batch](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Append & Delete entries in the same batch](#append--delete-entries-in-the-same-batch) + * [Syntax](#syntax) ## Usage @@ -39,7 +39,7 @@ import CodeBlock from '@theme/CodeBlock'; **Note**: * All the added Append and Delete operations will be executed in a single-node transaction. -* Delete actions are executed **before** Append actions. As seen in [this example](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch). +* Delete actions are executed **before** Append actions. As seen in [this example](#append--delete-entries-in-the-same-batch). * Appending entries to a time series that doesn't yet exist yet will create the time series. * An exception will be thrown if the specified document does Not exist. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx index a0084dd06b..8ebd11426b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#delete-multiple-entries) - * [Append & delete entries in the same batch](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Append & delete entries in the same batch](#append--delete-entries-in-the-same-batch) + * [Syntax](#syntax) ## Usage @@ -39,7 +39,7 @@ import CodeBlock from '@theme/CodeBlock'; **Note**: * All the added Append and Delete operations will be executed in a single-node transaction. - * Delete actions are executed **before** Append actions. As seen in [this example](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch). + * Delete actions are executed **before** Append actions. As seen in [this example](#append--delete-entries-in-the-same-batch). * Appending entries to a time series that doesn't yet exist yet will create the time series. * An exception will be thrown if the specified document does Not exist. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx index ec6f818d54..ae4a8859cd 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Get entries - from single time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-single-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax) - * [Get entries - from multiple time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-multiple-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax-1) + * [Get entries - from single time series](#get-entries---from-single-time-series) + * [Example](#example) + * [Syntax](#syntax) + * [Get entries - from multiple time series](#get-entries---from-multiple-time-series) + * [Example](#example-1) + * [Syntax](#syntax-1) ## Get entries - from single time series diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx index dff1839e1d..02aeb7d15a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Get entries - from single time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-single-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax) - * [Get entries - from multiple time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-multiple-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax-1) + * [Get entries - from single time series](#get-entries---from-single-time-series) + * [Example](#example) + * [Syntax](#syntax) + * [Get entries - from multiple time series](#get-entries---from-multiple-time-series) + * [Example](#example-1) + * [Syntax](#syntax-1) ## Get entries - from single time series diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx index 5857407554..abad5f6079 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * Patching time series entries on a single document can also be performed via the [Session](../../../../../document-extensions/timeseries/client-api/session/patch.mdx). * In this page: - * [Patch time series data - single document](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---single-document) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax) - * [Patch time series data - multiple documents](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---multiple-documents) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage-1) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax-1) + * [Patch time series data - single document](#patch-time-series-data---single-document) + * [Usage](#usage) + * [Examples](#examples) + * [Syntax](#syntax) + * [Patch time series data - multiple documents](#patch-time-series-data---multiple-documents) + * [Usage](#usage-1) + * [Examples](#examples-1) + * [Syntax](#syntax-1) ## Patch time series data - single document diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx index f57aa23abc..c022a6c42b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * Patching time series entries on a single document can also be performed via the [session](../../../../../document-extensions/timeseries/client-api/session/patch.mdx). * In this page: - * [Patch time series data - single document](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---single-document) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax) - * [Patch time series data - multiple documents](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---multiple-documents) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage-1) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax-1) + * [Patch time series data - single document](#patch-time-series-data---single-document) + * [Usage](#usage) + * [Examples](#examples) + * [Syntax](#syntax) + * [Patch time series data - multiple documents](#patch-time-series-data---multiple-documents) + * [Usage](#usage-1) + * [Examples](#examples-1) + * [Syntax](#syntax-1) ## Patch time series data - single document diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx index 228dadb0c9..e68653c5ad 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [`Append` usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [`Append` usage](#append-usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## `Append` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx index acacabc919..945425c0e3 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [`append` usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [`append` usage](#append-usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## `append` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-php.mdx index 3ba85de3f5..131e6d7f63 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-php.mdx @@ -21,10 +21,10 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) + * [Usage](#usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-python.mdx index 566c898273..2949e08e1e 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_append-python.mdx @@ -27,11 +27,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx index e5ab3ef769..9c9f5695be 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; To remove the whole time series simply delete all its entries. * In this page: - * [`Delete` usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#examples) - * [Delete single entry](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-single-entry) - * [Delete range of entries](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-range-of-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [`Delete` usage](#delete-usage) + * [Examples](#examples) + * [Delete single entry](#delete-single-entry) + * [Delete range of entries](#delete-range-of-entries) + * [Syntax](#syntax) ## `Delete` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx index 688d691cf8..a17f231e7a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * **Delete the whole time series** * In this page: - * [`delete` usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#examples) - * [Delete single entry](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-single-entry) - * [Delete range of entries](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-range-of-entries) - * [Delete time series](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-time-series-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [`delete` usage](#delete-usage) + * [Examples](#examples) + * [Delete single entry](#delete-single-entry) + * [Delete range of entries](#delete-range-of-entries) + * [Delete time series](#delete-time-series-1) + * [Syntax](#syntax) ## `Delete` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-php.mdx index aa5d0b3302..f8de859488 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * A time series is removed when all of its entries are deleted. * In this page: - * [usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#usage) - * [Example](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#example) + * [usage](#usage) + * [Example](#example) ## usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-python.mdx index 7c68c26d44..04b2c8ab8c 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_delete-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A time series is removed when all of its entries are deleted. * In this page: - * [usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#usage) - * [Example](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [usage](#usage) + * [Example](#example) + * [Syntax](#syntax) ## usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx index 91c7b711e1..edca271545 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx index 981d2f5f19..75a16147f7 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-php.mdx index 906080ac2c..e01239271b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-php.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-python.mdx index b384e3be53..c75b21680f 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_patch-python.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx index d3c63ae569..2cb25c8d48 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx @@ -15,18 +15,18 @@ import CodeBlock from '@theme/CodeBlock'; which can be provided to a `RawQuery` or executed from the Studio's [Query view](../../../../../studio/database/queries/query-view.mdx). * In this page: - * [Query](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query) - * [Query usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-usage) - * [Query examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-examples) - * [Query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax) - * [DocumentQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery) - * [DocumentQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-usage) - * [DocumentQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-examples) - * [DocumentQuery Syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-syntax) - * [RawQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery) - * [RawQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-usage) - * [RawQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-examples) - * [RawQuery syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-syntax) + * [Query](#query) + * [Query usage](#query-usage) + * [Query examples](#query-examples) + * [Query syntax](#query-syntax) + * [DocumentQuery](#documentquery) + * [DocumentQuery usage](#documentquery-usage) + * [DocumentQuery examples](#documentquery-examples) + * [DocumentQuery Syntax](#documentquery-syntax) + * [RawQuery](#rawquery) + * [RawQuery usage](#rawquery-usage) + * [RawQuery examples](#rawquery-examples) + * [RawQuery syntax](#rawquery-syntax) diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx index 8ed03038fa..d52eedd9f5 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx @@ -14,14 +14,14 @@ import CodeBlock from '@theme/CodeBlock'; which can be provided to a `rawQuery` or executed from the Studio's [Query view](../../../../../studio/database/queries/query-view.mdx). * In this page: - * [Query](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query) - * [Query usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-usage) - * [Query examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-examples) - * [Query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax) - * [RawQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery) - * [RawQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-usage) - * [RawQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-examples) - * [RawQuery syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-syntax) + * [Query](#query) + * [Query usage](#query-usage) + * [Query examples](#query-examples) + * [Query syntax](#query-syntax) + * [RawQuery](#rawquery) + * [RawQuery usage](#rawquery-usage) + * [RawQuery examples](#rawquery-examples) + * [RawQuery syntax](#rawquery-syntax) @@ -482,7 +482,7 @@ select timeseries( |------------|----------|----------------------| | **query** | `string` | The RQL query string | -The return value is the same as listed under the [query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax). +The return value is the same as listed under the [query syntax](#query-syntax). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx index 82ed393a5a..3b2d4a69d7 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `TimeSeriesFor.Get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in: [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`Get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`Get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `Get` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx index 65dcab69e6..91736958df 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `timeSeriesFor.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `get` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx index fab02bd6d1..98e311fd8b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx @@ -16,19 +16,19 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `timeSeriesFor.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. * In this page: - * [`get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `get` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx index 131bb68443..fdd56b3be1 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `time_series_for.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in: [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`Get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`Get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `Get` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx index 424c7a7119..6febb1e036 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `Advanced.GetTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`GetTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`GetTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `GetTimeSeriesFor` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx index 337ca5bc91..19a3d206ff 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.getTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`GetTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`GetTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `getTimeSeriesFor` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx index b54109f03e..ca5d369592 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.getTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`getTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`getTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `getTimeSeriesFor` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx index 629ec87b29..2c770f07a0 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.get_time_series_for` to get the names of all time series for the specified entity. * In this page: - * [`get_time_series_for` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#get_time_series_for-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`get_time_series_for` usage](#get_time_series_for-usage) + * [Example](#example) + * [Syntax](#syntax) ## `get_time_series_for` usage diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx index 1a521144ab..011203516f 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; without any additional server calls. * In this page: - * [Include time series when making a raw query](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#include-time-series-when-making-a-raw-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#syntax) + * [Include time series when making a raw query](#include-time-series-when-making-a-raw-query) + * [Syntax](#syntax) ## Include time series when making a raw query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx index 09f427901b..3568d2cdf8 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; without any additional server calls. * In this page: - * [Include time series when making a raw query](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#include-time-series-when-making-a-raw-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#syntax) + * [Include time series when making a raw query](#include-time-series-when-making-a-raw-query) + * [Syntax](#syntax) ## Include time series when making a raw query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx index ce6d837e6a..3a2ad360a7 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when loading a document](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#include-time-series-when-loading-a-document) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#syntax) + * [Include time series when loading a document](#include-time-series-when-loading-a-document) + * [Syntax](#syntax) ## Include time series when loading a document diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx index 5d4b285950..be96ff6baf 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when loading a document](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#include-time-series-when-loading-a-document) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#syntax) + * [Include time series when loading a document](#include-time-series-when-loading-a-document) + * [Syntax](#syntax) ## Include time series when loading a document diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx index 440399f7c0..867e266cf3 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when making a query](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#include-time-series-when-making-a-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#syntax) + * [Include time series when making a query](#include-time-series-when-making-a-query) + * [Syntax](#syntax) ## Include time series when making a query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx index 29bf72b12c..a1ab83ff58 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when making a query](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#include-time-series-when-making-a-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#syntax) + * [Include time series when making a query](#include-time-series-when-making-a-query) + * [Syntax](#syntax) ## Include time series when making a query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-csharp.mdx index 3a5e3e859e..88a3fa8688 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-csharp.mdx @@ -10,17 +10,17 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB time series are stored and managed as document extensions, achieving much greater speed and efficiency compared to storing them as JSON-formatted data within a document. * In this page: - * [Time series architecture](../../../document-extensions/timeseries/design.mdx#time-series-architecture) - * [Time series as a document extension](../../../document-extensions/timeseries/design.mdx#time-series-as-a--document-extension) - * [The `HasTimeSeries` flag](../../../document-extensions/timeseries/design.mdx#the--flag) - * [The time series entry](../../../document-extensions/timeseries/design.mdx#the-time-series-entry) - * [Segmentation](../../../document-extensions/timeseries/design.mdx#segmentation) - * [Compression](../../../document-extensions/timeseries/design.mdx#compression) - * [Updating time series](../../../document-extensions/timeseries/design.mdx#updating-time-series) - * [Document change](../../../document-extensions/timeseries/design.mdx#document-change) - * [No conflicts](../../../document-extensions/timeseries/design.mdx#no-conflicts) - * [Transactions](../../../document-extensions/timeseries/design.mdx#transactions) - * [Case insensitive](../../../document-extensions/timeseries/design.mdx#case-insensitive) + * [Time series architecture](#time-series-architecture) + * [Time series as a document extension](#time-series-as-a--document-extension) + * [The `HasTimeSeries` flag](#the--flag) + * [The time series entry](#the-time-series-entry) + * [Segmentation](#segmentation) + * [Compression](#compression) + * [Updating time series](#updating-time-series) + * [Document change](#document-change) + * [No conflicts](#no-conflicts) + * [Transactions](#transactions) + * [Case insensitive](#case-insensitive) ## Time series architecture @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; * The document and the time series reference each another: * The document's metadata keeps a reference to the time series **name**. The time series **data** itself is stored in a separate location. - * The [segments](../../../document-extensions/timeseries/design.mdx#segmentation) containing the time series data keep a reference to the document ID. + * The [segments](#segmentation) containing the time series data keep a reference to the document ID. ### The `HasTimeSeries` flag * When a document has one or more time series, diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-nodejs.mdx index 8082b97622..33967b5c53 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_design-nodejs.mdx @@ -10,17 +10,17 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB time series are stored and managed as document extensions, achieving much greater speed and efficiency compared to storing them as JSON-formatted data within a document. * In this page: - * [Time series architecture](../../../document-extensions/timeseries/design.mdx#time-series-architecture) - * [Time series as a document extension](../../../document-extensions/timeseries/design.mdx#time-series-as-a--document-extension) - * [The `HasTimeSeries` flag](../../../document-extensions/timeseries/design.mdx#the--flag) - * [The time series entry](../../../document-extensions/timeseries/design.mdx#the-time-series-entry) - * [Segmentation](../../../document-extensions/timeseries/design.mdx#segmentation) - * [Compression](../../../document-extensions/timeseries/design.mdx#compression) - * [Updating time series](../../../document-extensions/timeseries/design.mdx#updating-time-series) - * [Document change](../../../document-extensions/timeseries/design.mdx#document-change) - * [No conflicts](../../../document-extensions/timeseries/design.mdx#no-conflicts) - * [Transactions](../../../document-extensions/timeseries/design.mdx#transactions) - * [Case insensitive](../../../document-extensions/timeseries/design.mdx#case-insensitive) + * [Time series architecture](#time-series-architecture) + * [Time series as a document extension](#time-series-as-a--document-extension) + * [The `HasTimeSeries` flag](#the--flag) + * [The time series entry](#the-time-series-entry) + * [Segmentation](#segmentation) + * [Compression](#compression) + * [Updating time series](#updating-time-series) + * [Document change](#document-change) + * [No conflicts](#no-conflicts) + * [Transactions](#transactions) + * [Case insensitive](#case-insensitive) ## Time series architecture @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; * The document and the time series reference each another: * The document's metadata keeps a reference to the time series **name**. The time series **data** itself is stored in a separate location. - * The [segments](../../../document-extensions/timeseries/design.mdx#segmentation) containing the time series data keep a reference to the document ID. + * The [segments](#segmentation) containing the time series data keep a reference to the document ID. ### The `HasTimeSeries` flag * When a document has one or more time series, diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-csharp.mdx index 16de1783f5..3e6b127581 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-csharp.mdx @@ -10,15 +10,15 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Map index - index all time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-single-collection) - * [Map index - index all time series from all collections](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-all-collections) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Map index - index all time series from single collection](#map-index---index-all-time-series-from-single-collection) + * [Map index - index all time series from all collections](#map-index---index-all-time-series-from-all-collections) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -50,7 +50,7 @@ from entry in segment * Values & timestamp of a time series entry * The entry tag * Content from a document referenced by the tag - * Properties of the containing segment (see **[`TimeSeriesSegment`](../../../document-extensions/timeseries/indexing.mdx#section-5)**) + * Properties of the containing segment (see **[`TimeSeriesSegment`](#section-5)**) * Document index: @@ -80,16 +80,16 @@ from entry in segment There are two main ways to create a time series index: 1. Create a class that inherits from one of the following abstract index creation task classes: - * [`AbstractTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section) + * [`AbstractTimeSeriesIndexCreationTask`](#section) for [map](../../../indexes/map-indexes.mdx) and [map-reduce](../../../indexes/map-reduce-indexes.mdx) time series indexes. - * [`AbstractMultiMapTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section-1) + * [`AbstractMultiMapTimeSeriesIndexCreationTask`](#section-1) for [multi-map](../../../indexes/multi-map-indexes.mdx) time series indexes. - * [`AbstractJavaScriptTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section-2) + * [`AbstractJavaScriptTimeSeriesIndexCreationTask`](#section-2) for static [javascript indexes](../../../indexes/javascript-indexes.mdx). 2. Deploy a time series index definition via [PutIndexesOperation](../../../client-api/operations/maintenance/indexes/put-indexes.mdx): - * Create a [`TimeSeriesIndexDefinition`](../../../document-extensions/timeseries/indexing.mdx#section-3) directly. - * Create a strongly typed index definition using [`TimeSeriesIndexDefinitionBuilder`](../../../document-extensions/timeseries/indexing.mdx#section-4). + * Create a [`TimeSeriesIndexDefinition`](#section-3) directly. + * Create a strongly typed index definition using [`TimeSeriesIndexDefinitionBuilder`](#section-4). @@ -102,7 +102,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-nodejs.mdx index 56d10e47a9..74a6f3844f 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-nodejs.mdx @@ -10,15 +10,15 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Map index - index all time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-single-collection) - * [Map index - index all time series from all collections](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-all-collections) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Map index - index all time series from single collection](#map-index---index-all-time-series-from-single-collection) + * [Map index - index all time series from all collections](#map-index---index-all-time-series-from-all-collections) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * Values & timestamp of a time series entry * The entry tag * Content from a document referenced by the tag - * Properties of the containing segment (see **[segment properties](../../../document-extensions/timeseries/indexing.mdx#segment-properties)**) + * Properties of the containing segment (see **[segment properties](#segment-properties)**) * Document index: @@ -61,9 +61,9 @@ import CodeBlock from '@theme/CodeBlock'; There are two main ways to create a time series index: -1. Create a class that inherits from the abstract index class [`AbstractRawJavaScriptTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section). +1. Create a class that inherits from the abstract index class [`AbstractRawJavaScriptTimeSeriesIndexCreationTask`](#section). -2. Create a [`TimeSeriesIndexDefinition`](../../../document-extensions/timeseries/indexing.mdx#section-1) +2. Create a [`TimeSeriesIndexDefinition`](#section-1) and deploy the time series index definition via [PutIndexesOperation](../../../client-api/operations/maintenance/indexes/put-indexes.mdx). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-php.mdx index 12e10e45bc..28cac6ba4a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-php.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -100,7 +100,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-python.mdx index 578928c705..14fef78a5e 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_indexing-python.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -100,7 +100,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx index 40b95ba56b..e4e91ef7a9 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx index bb25a54a65..481be1efa2 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-php.mdx index ee00a617c8..48927b8f8a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-php.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-python.mdx index f43509620d..a1e305095d 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_rollup-and-retention-python.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx index e98afc66bb..a438877c8c 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; or they have their own pages describing their interaction with time series (such as [indexing](../../../document-extensions/timeseries/indexing.mdx)). * In this page: - * [General features](../../../document-extensions/timeseries/time-series-and-other-features.mdx#general-features) - * [Smuggler](../../../document-extensions/timeseries/time-series-and-other-features.mdx#smuggler) - * [Ongoing tasks](../../../document-extensions/timeseries/time-series-and-other-features.mdx#ongoing-tasks) - * [Revisions](../../../document-extensions/timeseries/time-series-and-other-features.mdx#revisions) + * [General features](#general-features) + * [Smuggler](#smuggler) + * [Ongoing tasks](#ongoing-tasks) + * [Revisions](#revisions) ## General features diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx index 3e308bfa21..ba1c9cb870 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; or they have their own pages describing their interaction with time series (such as [indexing](../../../document-extensions/timeseries/indexing.mdx)). * In this page: - * [General features](../../../document-extensions/timeseries/time-series-and-other-features.mdx#general-features) - * [Smuggler](../../../document-extensions/timeseries/time-series-and-other-features.mdx#smuggler) - * [Ongoing tasks](../../../document-extensions/timeseries/time-series-and-other-features.mdx#ongoing-tasks) - * [Revisions](../../../document-extensions/timeseries/time-series-and-other-features.mdx#revisions) + * [General features](#general-features) + * [Smuggler](#smuggler) + * [Ongoing tasks](#ongoing-tasks) + * [Revisions](#revisions) ## General features diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx index 219d8f12b6..de30c39e7a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Javascript Support](../../../../document-extensions/timeseries/client-api/javascript-support.mdx) has been extended to support incremental time series. -* You can use the Javascript [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#timeseriesincrement) +* You can use the Javascript [timeseries.increment](#timeseriesincrement) method to create and modify incremental time series and their entries. The method behaves the same way it does when it is called [using C#](../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx). @@ -32,9 +32,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [timeseries.get](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) * In this page: - * [The `timeseries` Interface](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#the-timeseries-interface) - * [`timeseries.increment`](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#timeseriesincrement) - * [Usage Sample](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#usage-sample) + * [The `timeseries` Interface](#the-timeseries-interface) + * [`timeseries.increment`](#timeseriesincrement) + * [Usage Sample](#usage-sample) @@ -49,7 +49,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; | name | `string` | Incremental time series Name (e.g. `INC:StockPrice`) | * Use one of the following methods to access the chosen time series: - * [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#the-timeseries-interface) + * [timeseries.increment](#the-timeseries-interface) * [timeseries.delete](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) * [timeseries.get](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx index 242a636808..6ed4cf776e 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Using this method, you can retrieve node values from incremental time series entries. * In this page: - * [`GetTimeSeriesOperation`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#gettimeseriesoperation) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#usage-sample) + * [`GetTimeSeriesOperation`](#gettimeseriesoperation) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#usage-sample) ## `GetTimeSeriesOperation` diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx index 32446f9fe3..9b5e823a67 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx @@ -19,10 +19,10 @@ Delete a range of incremental time series entries using `IncrementalTimeSeriesFo * You can delete a **single entry** or a **range of entries**. * In this page: - * [`IncrementalTimeSeriesFor.Delete`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#incrementaltimeseriesfordelete) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#code-samples) + * [`IncrementalTimeSeriesFor.Delete`](#incrementaltimeseriesfordelete) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#code-samples) ## `IncrementalTimeSeriesFor.Delete` diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx index 1d770d095d..6bac859df2 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx @@ -29,9 +29,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`IncrementalTimeSeriesFor.Get`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#incrementaltimeseriesforget) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#usage-flow) + * [`IncrementalTimeSeriesFor.Get`](#incrementaltimeseriesforget) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) * [Code Samples](../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#code-samples) diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx index a2fff94be1..fc3a1d940b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx @@ -25,10 +25,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; `session.SaveChanges`, to create multiple entries in a single transaction. * In this page: - * [`IncrementalTimeSeriesFor.Increment`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#timeseriesforappend) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#code-samples) + * [`IncrementalTimeSeriesFor.Increment`](#timeseriesforappend) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#code-samples) ## `IncrementalTimeSeriesFor.Increment` diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx index 485e11536e..7959c79247 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx @@ -27,9 +27,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * and Increase a value by some delta. * In this page: - * [Session API Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#session-api-methods) - * [IncrementalTimeSeriesFor Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#methods) - * [Additional Session Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#additional-session-methods) + * [Session API Methods](#session-api-methods) + * [IncrementalTimeSeriesFor Methods](#methods) + * [Additional Session Methods](#additional-session-methods) ## Session API Methods ### `IncrementalTimeSeriesFor` Methods diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/overview.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/overview.mdx index 7fc579aca2..8560c5417b 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/overview.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/incremental-time-series/overview.mdx @@ -29,9 +29,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and via [Studio](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series). * In this page: - * [What are Incremental Time Series and Why Use Them](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#what-are-incremental-time-series-and-why-use-them) - * [Incremental Time Series -vs- Non-incremental Time Series](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#incremental-time-series--vs--non-incremental-time-series) - * [Incremental Time Series Structure](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#incremental-time-series-structure) + * [What are Incremental Time Series and Why Use Them](#what-are-incremental-time-series-and-why-use-them) + * [Incremental Time Series -vs- Non-incremental Time Series](#incremental-time-series--vs--non-incremental-time-series) + * [Incremental Time Series Structure](#incremental-time-series-structure) diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/overview.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/overview.mdx index e8a9956cf2..d7642ec819 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/overview.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/overview.mdx @@ -28,20 +28,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Time series data is **compressed** to lower storage usage and transaction time. * In this page: - * [Overview](../../document-extensions/timeseries/overview.mdx#overview) - * [RavenDB's Time Series Implementation](../../document-extensions/timeseries/overview.mdx#ravendbs-time-series-implementation) - * [Distributed Time Series](../../document-extensions/timeseries/overview.mdx#distributed-time-series) - * [Time Series as Document Extensions](../../document-extensions/timeseries/overview.mdx#time-series-as-document-extensions) - * [Time Series Features](../../document-extensions/timeseries/overview.mdx#time-series-features) - * [Time Series Data](../../document-extensions/timeseries/overview.mdx#time-series-data) - * [Separate Name and Data Storage](../../document-extensions/timeseries/overview.mdx#separate-name-and-data-storage) - * [Time Series Segments](../../document-extensions/timeseries/overview.mdx#time-series-segments) - * [Transactions Performance](../../document-extensions/timeseries/overview.mdx#transactions-performance) - * [Common-Queries Performance](../../document-extensions/timeseries/overview.mdx#common-queries-performance) - * [Time Series Entries](../../document-extensions/timeseries/overview.mdx#time-series-entries) - * [Timestamps](../../document-extensions/timeseries/overview.mdx#timestamps) - * [Values](../../document-extensions/timeseries/overview.mdx#values) - * [Tags](../../document-extensions/timeseries/overview.mdx#tags) + * [Overview](#overview) + * [RavenDB's Time Series Implementation](#ravendbs-time-series-implementation) + * [Distributed Time Series](#distributed-time-series) + * [Time Series as Document Extensions](#time-series-as-document-extensions) + * [Time Series Features](#time-series-features) + * [Time Series Data](#time-series-data) + * [Separate Name and Data Storage](#separate-name-and-data-storage) + * [Time Series Segments](#time-series-segments) + * [Transactions Performance](#transactions-performance) + * [Common-Queries Performance](#common-queries-performance) + * [Time Series Entries](#time-series-entries) + * [Timestamps](#timestamps) + * [Values](#values) + * [Tags](#tags) ## Overview @@ -94,7 +94,7 @@ Notable time series features include - * **Highly-Efficient Storage Management** Time series data is [compressed](../../document-extensions/timeseries/design.mdx#compression) - and [segmented](../../document-extensions/timeseries/overview.mdx#time-series-segments) to minimize storage usage and transmission time. + and [segmented](#time-series-segments) to minimize storage usage and transmission time. * **A Thorough Set of API Methods** The [time series API](../../document-extensions/timeseries/client-api/overview.mdx) includes a variety of `session methods` and `store operations`. * **Full GUI Support** @@ -102,7 +102,7 @@ Notable time series features include - * **Time Series Indexing** Time series can be [indexed](../../document-extensions/timeseries/indexing.mdx). * **Time Series Querying and Aggregation** - * [High-performance common queries](../../document-extensions/timeseries/overview.mdx#common-queries-performance) + * [High-performance common queries](#common-queries-performance) The results of a set of common queries are prepared in advance in time series segments' headers, so the response to querying for a series minimum value, for example, is returned nearly instantly. * [LINQ and raw RQL queries](../../document-extensions/timeseries/querying/overview-and-syntax.mdx) @@ -125,10 +125,10 @@ Notable time series features include - ## Time Series Data Time series **names** are kept in their parent documents' metadata, while their -**data** is kept [separately](../../document-extensions/timeseries/overview.mdx#separate-name-and-data-storage). +**data** is kept [separately](#separate-name-and-data-storage). Time series data is **compressed** and composed of consecutive -[segments](../../document-extensions/timeseries/overview.mdx#time-series-segments) and -[entries](../../document-extensions/timeseries/overview.mdx#time-series-entries). +[segments](#time-series-segments) and +[entries](#time-series-entries). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx index bf0e24a5b8..4fb1ea586a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx @@ -12,16 +12,16 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Group by dynamic criteria](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#group-by-dynamic-criteria) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) - * [Syntax](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#syntax) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Group by dynamic criteria](#group-by-dynamic-criteria) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) + * [Syntax](#syntax) ## Grouping and aggregation options diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx index fcfeddad06..6b4cb727d2 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) ## Grouping and aggregation options diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx index c685a79942..99456fec1d 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; such as an hour or a week. * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) ## Grouping and aggregation options diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx index db1a0ce715..caff435b91 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx index a8646ada3d..634a82341c 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx index a91e80170b..6b27c8b1c4 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx @@ -9,12 +9,12 @@ import CodeBlock from '@theme/CodeBlock'; such as those collected in the last 7 days. * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx index ab5d0bf799..fd54d0e3da 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-csharp.mdx index 2cb42b54a6..1a00c3c2fb 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx index 3834e2d6ae..5456c0cf5a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-php.mdx index 000c2f9ed5..6f373aadbe 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-php.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; you can filter the time series entries by their **values**, **tag**, or by the contents of a **document referenced in the tag**. * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-python.mdx index 0ff2cb3a8a..97593a4a9a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_filtering-python.mdx @@ -9,9 +9,9 @@ In addition to limiting time series query results by specifying the [range of en you can filter the time series entries by their **values**, **tag**, or by the contents of a **document referenced in the tag**. * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx index aa202e76f8..cc9952cff1 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-java.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-java.mdx index 6f74171f6b..a624a042f4 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-java.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx index df0f6d1715..b357fcb810 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx index b37c528c10..8028c6e40e 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -141,8 +141,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx index 893875f73b..691ff6964f 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -166,8 +166,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx index 73d4f006b9..1e8ae6324a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -140,8 +140,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx index 5591e031c8..0dbb82d692 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -141,8 +141,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx index 3fc119b2ee..7f3379035a 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; 2. Stream time series query results. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx index 1f249c966b..17a1cf6c06 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; 2. Stream time series query results. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx index d6cf333203..0d8529bdbc 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx @@ -24,17 +24,17 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) - * [Syntax](../../../../document-extensions/timeseries/querying/using-indexes.mdx#syntax) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) + * [Syntax](#syntax) ## Sample Index @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx index a051729e29..4c6d93a2f7 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx @@ -24,16 +24,16 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) ## Sample Index @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will in the shape of the defined index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-php.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-php.mdx index 553e1a5486..286530ec41 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-php.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-php.mdx @@ -24,16 +24,16 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) ## Sample Index @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-python.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-python.mdx index 2e2f099736..301efd2ac6 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-python.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/content/_using-indexes-python.mdx @@ -28,13 +28,13 @@ import CodeBlock from '@theme/CodeBlock'; The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) - * [Syntax](../../../../document-extensions/timeseries/querying/using-indexes.mdx#syntax) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) + * [Syntax](#syntax) ## Sample Index @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/statistics.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/statistics.mdx index 359a7b9dc9..ad2ef968ca 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/statistics.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/statistics.mdx @@ -22,8 +22,8 @@ one measure for the first values in each entry, another measure for the second values in each entry, and so on. * In this page: - * [Syntax](../../../document-extensions/timeseries/querying/statistics.mdx#syntax) - * [Examples](../../../document-extensions/timeseries/querying/statistics.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax @@ -47,7 +47,7 @@ series or range of time series entries. It takes one `double` value that is grea 0 and less than or equal to 100. This represents the percent of the time series values that should be smaller than the result. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Slope * RQL method: `slope()` @@ -63,7 +63,7 @@ the time series, grouping the entries into whole numbers of time units. The difference in time is measured in milliseconds. Use [scaling](../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) to adjust the results to your preferred units. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Standard Deviation * RQL method: `stddev()` @@ -72,7 +72,7 @@ See examples [below](../../../document-extensions/timeseries/querying/statistics These methods return the [standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) of time series values. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Result Format Queries with these methods return results with the following format: diff --git a/versioned_docs/version-6.2/indexes/additional-assemblies.mdx b/versioned_docs/version-6.2/indexes/additional-assemblies.mdx index 03aa2ef81a..22646c594e 100644 --- a/versioned_docs/version-6.2/indexes/additional-assemblies.mdx +++ b/versioned_docs/version-6.2/indexes/additional-assemblies.mdx @@ -30,11 +30,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; all of the index's Additional Assemblies. * In this page: - * [Syntax](../indexes/additional-assemblies.mdx#syntax) - * [Examples](../indexes/additional-assemblies.mdx#examples) - * [Basic Example](../indexes/additional-assemblies.mdx#basic-example) - * [Complex Example](../indexes/additional-assemblies.mdx#complex-example) - * [Pre-Release Packages](../indexes/additional-assemblies.mdx#pre-release-packages) + * [Syntax](#syntax) + * [Examples](#examples) + * [Basic Example](#basic-example) + * [Complex Example](#complex-example) + * [Pre-Release Packages](#pre-release-packages) ## Syntax diff --git a/versioned_docs/version-6.2/indexes/content/_boosting-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_boosting-csharp.mdx index bc754e4316..b3c3da96d0 100644 --- a/versioned_docs/version-6.2/indexes/content/_boosting-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_boosting-csharp.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -284,7 +284,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** * When using **Corax** as the underlying indexing engine, a boost factor can only be assigned - to the [index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + to the [index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an _index-field_ is Not supported. * When using **Lucene**, a boost factor can be assigned to both the index-field and the whole index-entry. diff --git a/versioned_docs/version-6.2/indexes/content/_boosting-java.mdx b/versioned_docs/version-6.2/indexes/content/_boosting-java.mdx index 95e8765ded..5f9a1b97a9 100644 --- a/versioned_docs/version-6.2/indexes/content/_boosting-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_boosting-java.mdx @@ -8,7 +8,7 @@ a basic score is calculated for each document in the results by the underlying e Providing a **boost value** to some fields allows you to prioritize the resulting documents. The boost value is integrated with the basic score, making the document rank higher. -Automatic ordering of the results by the score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +Automatic ordering of the results by the score is [configurable](#automatic-score-based-ordering). From the index perspective we can associate to an index entry a boosting factor. The higher value it has, the more relevant term will be. To do this, we must use the `Boost` method. diff --git a/versioned_docs/version-6.2/indexes/content/_boosting-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_boosting-nodejs.mdx index efc4f24547..8bf72e6c8b 100644 --- a/versioned_docs/version-6.2/indexes/content/_boosting-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_boosting-nodejs.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -160,7 +160,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** - * When using **Corax** as the underlying indexing engine, you can only [assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + * When using **Corax** as the underlying indexing engine, you can only [assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an index-field is Not supported. * When using **Lucene**, you can assign a boost factor to both the index-field and the whole index-entry. diff --git a/versioned_docs/version-6.2/indexes/content/_boosting-php.mdx b/versioned_docs/version-6.2/indexes/content/_boosting-php.mdx index 5a96af9b0b..db0514d9f5 100644 --- a/versioned_docs/version-6.2/indexes/content/_boosting-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_boosting-php.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -294,7 +294,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** * When using **Corax** as the underlying indexing engine, a boost factor can only be assigned - to the [index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + to the [index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an _index-field_ is Not supported. * When using **Lucene**, a boost factor can be assigned to both the index-field and the whole index-entry. diff --git a/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-csharp.mdx index 6856468b70..8046059128 100644 --- a/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-csharp.mdx @@ -9,25 +9,25 @@ import CodeBlock from '@theme/CodeBlock'; For a general overview of indexes, see [What are indexes](../../indexes/what-are-indexes.mdx). * You can either: - * [create a Static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or - * let the RavenDB server [create an Auto-index](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) for you based on query patterns. + * [create a Static-index](#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or + * let the RavenDB server [create an Auto-index](#creating-auto-indexes) for you based on query patterns. * Static-indexes can be created: * using the Client API, as outlined in this article, or * from the [Indexes list view](../../studio/database/indexes/indexes-list-view.mdx) in the Studio. * In this page: - * [Static-indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Define a static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) - * [Deploy a static-index](../../indexes/creating-and-deploying.mdx#deploy-a-static-index) - * [Deploy single index](../../indexes/creating-and-deploying.mdx#deploy-single-index) - * [Deploy multiple indexes](../../indexes/creating-and-deploying.mdx#deploy-multiple-indexes) - * [Deploy syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) - * [Deployment behavior](../../indexes/creating-and-deploying.mdx#deployment-behavior) - * [Creating a static-index - Example](../../indexes/creating-and-deploying.mdx#create-a-static-index---example) - * [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Creating auto-indexes](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) - * [Disabling auto-indexes](../../indexes/creating-and-deploying.mdx#disabling-auto-indexes) + * [Static-indexes](#static-indexes) + * [Define a static-index](#define-a-static-index) + * [Deploy a static-index](#deploy-a-static-index) + * [Deploy single index](#deploy-single-index) + * [Deploy multiple indexes](#deploy-multiple-indexes) + * [Deploy syntax](#deploy-syntax) + * [Deployment behavior](#deployment-behavior) + * [Creating a static-index - Example](#create-a-static-index---example) + * [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation) + * [Auto-indexes](#auto-indexes) + * [Creating auto-indexes](#creating-auto-indexes) + * [Disabling auto-indexes](#disabling-auto-indexes) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; ##### Define a static-index using a custom class * To define a static-index using a custom class inherit from `AbstractIndexCreationTask`. -* This method is recommended over the [Creating an index using an operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) method +* This method is recommended over the [Creating an index using an operation](#create-a-static-index---using-an-operation) method for its simplicity and the following advantages: * **Strongly-typed syntax**: Provides strong typing when defining the index, making it easier to work with. @@ -65,7 +65,7 @@ public class Orders_ByTotal : AbstractIndexCreationTask `} -* A complete example of creating a static-index is provided [below](../../indexes/creating-and-deploying.mdx#create-a-static-index---example). +* A complete example of creating a static-index is provided [below](#create-a-static-index---example). @@ -105,13 +105,13 @@ public class Orders_ByTotal : AbstractIndexCreationTask * To begin indexing data, the index must be deployed to the server. * This section provides options for deploying indexes that inherit from `AbstractIndexCreationTask`. * To create and deploy an index using the `IndexDefinition` class via `PutIndexesOperation`, - see [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation). + see [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation). ##### Deploy single index * Use `Execute()` or `ExecuteIndex()` to deploy a single index. * The following examples deploy index `Ordes/ByTotal` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -156,7 +156,7 @@ await store.ExecuteIndexAsync(new Orders_ByTotal()); If it fails, it will repeat the execution by calling the `Execute` method for each index, one by one, in separate requests. * The following examples deploy indexes `Ordes/ByTotal` and `Employees/ByLastName` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -401,7 +401,7 @@ public static void Main(string[] args) * When using this operation: - * Unlike the [naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) used with indexes inheriting from `AbstractIndexCreationTask`, + * Unlike the [naming convention](#naming-convention) used with indexes inheriting from `AbstractIndexCreationTask`, you can choose any string-based name for the index. However, when querying, you must use that string-based name rather than the index class type. diff --git a/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-java.mdx b/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-java.mdx index 1c1717746a..157f5545f2 100644 --- a/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-java.mdx @@ -26,40 +26,40 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes created by issuing a query are called `dynamic` or `Auto` indexes. * They can be easily identified. Their name starts with the `Auto/` prefix. - * If no [Auto-Index](../../indexes/creating-and-deploying.mdx#auto-indexes) exists to satisfy a query, + * If no [Auto-Index](#auto-indexes) exists to satisfy a query, a new Auto-Index will be created and maintained automatically. * Indexes created explicitly by the user are called `static`. * [To use a Static Index in a query](../../indexes/querying/query-index.mdx), **you must specify the index in the query definition**. If you don't specify the index, RavenDB will look for an auto-index and potentially create a new one. * Static Indexes can be defined to do calculations, conversions, and various other processes behind the scenes, to prevent - doing these costly processes at query time (see [Using AbstractIndexCreationTask](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask), + doing these costly processes at query time (see [Using AbstractIndexCreationTask](#using-abstractindexcreationtask), our [map-indexes](../../indexes/map-indexes.mdx) article, [indexing multiple collections](../../indexes/multi-map-indexes.mdx), and [map-reduce indexing](../../indexes/map-reduce-indexes.mdx)). * In this page: - * [Static indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Using AbstractIndexCreationTask](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask) - * [Naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) - * [Sending to server](../../indexes/creating-and-deploying.mdx#sending-to-server) - * [Creating an index with custom configuration](../../indexes/creating-and-deploying.mdx#creating-an-index-with-custom-configuration) - * [Using assembly scanner](../../indexes/creating-and-deploying.mdx#using-assembly-scanner) - * [Example](../../indexes/creating-and-deploying.mdx#example) - * [Using maintenance operations](../../indexes/creating-and-deploying.mdx#using-maintenance-operations) - * [IndexDefinitionBuilder](../../indexes/creating-and-deploying.mdx#indexdefinitionbuilder) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Naming convention](../../indexes/creating-and-deploying.mdx#naming-convention-1) - * [Auto indexes and indexing state](../../indexes/creating-and-deploying.mdx#auto-indexes-and-indexing-state) - * [If indexes exhaust system resources](../../indexes/creating-and-deploying.mdx#if-indexes-exhaust-system-resources) + * [Static indexes](#static-indexes) + * [Using AbstractIndexCreationTask](#using-abstractindexcreationtask) + * [Naming convention](#naming-convention) + * [Sending to server](#sending-to-server) + * [Creating an index with custom configuration](#creating-an-index-with-custom-configuration) + * [Using assembly scanner](#using-assembly-scanner) + * [Example](#example) + * [Using maintenance operations](#using-maintenance-operations) + * [IndexDefinitionBuilder](#indexdefinitionbuilder) + * [Auto-indexes](#auto-indexes) + * [Naming convention](#naming-convention-1) + * [Auto indexes and indexing state](#auto-indexes-and-indexing-state) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) ## Static indexes -There are a couple of ways to create a `static index` and send it to the server. We can use [maintenance operations](../../indexes/creating-and-deploying.mdx#using-maintenance-operations) or create a [custom class](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask). +There are a couple of ways to create a `static index` and send it to the server. We can use [maintenance operations](#using-maintenance-operations) or create a [custom class](#using-abstractindexcreationtask). --- diff --git a/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-nodejs.mdx index 115ae0d962..de899f305b 100644 --- a/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_creating-and-deploying-nodejs.mdx @@ -9,25 +9,25 @@ import CodeBlock from '@theme/CodeBlock'; For a general overview of indexes, see [What are indexes](../../indexes/what-are-indexes.mdx). * You can either: - * [create a Static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or - * let the RavenDB server [create an Auto-index](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) for you based on query patterns. + * [create a Static-index](#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or + * let the RavenDB server [create an Auto-index](#creating-auto-indexes) for you based on query patterns. * Static-indexes can be created: * using the Client API, as outlined in this article, or * from the [Indexes list view](../../studio/database/indexes/indexes-list-view.mdx) in the Studio. * In this page: - * [Static-indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Define a static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) - * [Deploy a static-index](../../indexes/creating-and-deploying.mdx#deploy-a-static-index) - * [Deploy single index](../../indexes/creating-and-deploying.mdx#deploy-single-index) - * [Deploy multiple indexes](../../indexes/creating-and-deploying.mdx#deploy-multiple-indexes) - * [Deploy syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) - * [Deployment behavior](../../indexes/creating-and-deploying.mdx#deployment-behavior) - * [Creating a static-index - Example](../../indexes/creating-and-deploying.mdx#create-a-static-index---example) - * [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Creating auto-indexes](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) - * [Disabling auto-indexes](../../indexes/creating-and-deploying.mdx#disabling-auto-indexes) + * [Static-indexes](#static-indexes) + * [Define a static-index](#define-a-static-index) + * [Deploy a static-index](#deploy-a-static-index) + * [Deploy single index](#deploy-single-index) + * [Deploy multiple indexes](#deploy-multiple-indexes) + * [Deploy syntax](#deploy-syntax) + * [Deployment behavior](#deployment-behavior) + * [Creating a static-index - Example](#create-a-static-index---example) + * [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation) + * [Auto-indexes](#auto-indexes) + * [Creating auto-indexes](#creating-auto-indexes) + * [Disabling auto-indexes](#disabling-auto-indexes) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; ##### Define a static-index using a custom class * To define a static-index using a custom class, extend the `AbstractJavaScriptIndexCreationTask` class. -* This method is recommended over the [Creating an index using an operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) method +* This method is recommended over the [Creating an index using an operation](#create-a-static-index---using-an-operation) method for its simplified index definition, offering a straightforward way to define the index. @@ -58,7 +58,7 @@ import CodeBlock from '@theme/CodeBlock'; `} -* A complete example of creating a static-index is provided [below](../../indexes/creating-and-deploying.mdx#create-a-static-index---example). +* A complete example of creating a static-index is provided [below](#create-a-static-index---example). @@ -100,13 +100,13 @@ import CodeBlock from '@theme/CodeBlock'; * To begin indexing data, the index must be deployed to the server. * This section provides options for deploying indexes that inherit from `AbstractJavaScriptIndexCreationTask`. * To create and deploy an index using the `IndexDefinition` class via `PutIndexesOperation`, - see [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation). + see [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation). ##### Deploy single index * Use `execute()` or `executeIndex()` to deploy a single index. * The following examples deploy index `Ordes/ByTotal` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -132,7 +132,7 @@ await documentStore.executeIndex(new Orders_ByTotal()); If it fails, it will repeat the execution by calling the `execute` method for each index, one by one, in separate requests. * The following examples deploy indexes `Ordes/ByTotal` and `Employees/ByLastName` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -275,7 +275,7 @@ async function main() \{ * When using this operation: - * Unlike the [naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) used with indexes inheriting from `AbstractJavaScriptIndexCreationTask`, + * Unlike the [naming convention](#naming-convention) used with indexes inheriting from `AbstractJavaScriptIndexCreationTask`, you can choose any string-based name for the index. However, when querying, you must use that string-based name rather than the index class type. diff --git a/versioned_docs/version-6.2/indexes/content/_extending-indexes-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_extending-indexes-csharp.mdx index 510e0ac2c6..cf6757e2e2 100644 --- a/versioned_docs/version-6.2/indexes/content/_extending-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_extending-indexes-csharp.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/versioned_docs/version-6.2/indexes/content/_extending-indexes-java.mdx b/versioned_docs/version-6.2/indexes/content/_extending-indexes-java.mdx index 46bf6b4534..13f21647e0 100644 --- a/versioned_docs/version-6.2/indexes/content/_extending-indexes-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_extending-indexes-java.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/versioned_docs/version-6.2/indexes/content/_extending-indexes-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_extending-indexes-nodejs.mdx index f72a842b7a..58d2e5a594 100644 --- a/versioned_docs/version-6.2/indexes/content/_extending-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_extending-indexes-nodejs.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-csharp.mdx index e1c801d29b..a08469c73e 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; as when documents are modified in the indexed collection(s). * In this page: - * [Syntax](../../indexes/indexing-compare-exchange-values.mdx#syntax) - * [Examples](../../indexes/indexing-compare-exchange-values.mdx#examples) - * [Querying the Index](../../indexes/indexing-compare-exchange-values.mdx#querying-the-index) + * [Syntax](#syntax) + * [Examples](#examples) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-java.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-java.mdx index 252143a7e6..d250ebcb06 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-java.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; as when documents are modified in the indexed collection(s). * In this page: - * [How to use](../../indexes/indexing-compare-exchange-values.mdx#how-to-use) - * [Examples](../../indexes/indexing-compare-exchange-values.mdx#examples) - * [Querying the Index](../../indexes/indexing-compare-exchange-values.mdx#querying-the-index) + * [How to use](#how-to-use) + * [Examples](#examples) + * [Querying the Index](#querying-the-index) ## How to use diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-nodejs.mdx index 93cd377af3..68d3e7d4f5 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-compare-exchange-values-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; as when documents are modified in the indexed collection(s). * In this page: - * [Syntax](../../indexes/indexing-compare-exchange-values.mdx#syntax) - * [Examples](../../indexes/indexing-compare-exchange-values.mdx#examples) - * [Querying the Index](../../indexes/indexing-compare-exchange-values.mdx#querying-the-index) + * [Syntax](#syntax) + * [Examples](#examples) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-csharp.mdx index 7bb5c596c8..9fe58fe3e8 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-csharp.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -90,7 +90,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-nodejs.mdx index 29893dc8d0..a769b7a1fb 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-nodejs.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -92,7 +92,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-php.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-php.mdx index f1ac73dacc..78293f5e57 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-php.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -168,7 +168,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-python.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-python.mdx index 34eb3e4d9b..689d9d45c0 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-hierarchical-data-python.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -89,7 +89,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-csharp.mdx index 4d78c1f828..a63f170e74 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-csharp.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-java.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-java.mdx index 3c7b5249bc..802ac05b8b 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-java.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-nodejs.mdx index d6a5965164..e4569f17b0 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-linq-extensions-nodejs.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-csharp.mdx index b63e7dbe06..873cb84a78 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-csharp.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-java.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-java.mdx index 946a3c9263..db8bc915db 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-java.mdx @@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) + * [Indexing metadata properties](#indexing-metadata-properties) ## Indexing metadata properties diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-nodejs.mdx index d72e4b75fd..cd760971e6 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-nodejs.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-php.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-php.mdx index ae14788be5..947ab3ac0b 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-python.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-python.mdx index d4bce9739d..31cd3e9b40 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-metadata-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-metadata-python.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-csharp.mdx index 56437d0503..f97d6ca1c2 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-csharp.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -563,7 +563,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), then in this case, the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-nodejs.mdx index 10772d86bc..9f46265224 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-nodejs.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -383,7 +383,7 @@ where color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `totalResults` property (available when calling the query `statistics()` method) diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-php.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-php.mdx index 3f7c90b372..11c53af6bf 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-php.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -608,7 +608,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-python.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-python.mdx index 7fc420551c..d54540ea9f 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-nested-data-python.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -428,7 +428,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-csharp.mdx index 0280110a61..faff7cb5fa 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-csharp.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-java.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-java.mdx index e54be18a3b..527426f2f0 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-java.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-nodejs.mdx index 753137ec91..e188d14d83 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-nodejs.mdx @@ -9,11 +9,11 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this page: - * [The challenge](../../indexes/indexing-polymorphic-data.mdx#the-challenge) - * [Possible solutions:](../../indexes/indexing-polymorphic-data.mdx#possible-solutions) - * [Multi-map index](../../indexes/indexing-polymorphic-data.mdx#multi-map-index) - * [Polymorphic index](../../indexes/indexing-polymorphic-data.mdx#polymorphic-index) - * [Customize collection](../../indexes/indexing-polymorphic-data.mdx#customize-collection) + * [The challenge](#the-challenge) + * [Possible solutions:](#possible-solutions) + * [Multi-map index](#multi-map-index) + * [Polymorphic index](#polymorphic-index) + * [Customize collection](#customize-collection) ## The challenge diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-php.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-php.mdx index e22dc153cc..cd0023b362 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-php.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-python.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-python.mdx index e0f1998866..4491fae79c 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-polymorphic-data-python.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-csharp.mdx index ab2058099f..023a878f57 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-csharp.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -269,7 +269,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -287,7 +287,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-nodejs.mdx index 052b1d118d..9175bf2fa2 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-nodejs.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) + * [What are related documents](#what-are-related-documents) - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). **The index**: @@ -239,7 +239,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -258,7 +258,7 @@ where BookNames = "The Witcher" * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). **The index**: diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-php.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-php.mdx index 7394b7dac6..ebd813f063 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-php.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -316,7 +316,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -334,7 +334,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-python.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-python.mdx index 9bdfd27308..f55338cd99 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-related-documents-python.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -224,7 +224,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -242,7 +242,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-csharp.mdx index 3ad6863a19..7e022201d4 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -148,7 +148,7 @@ object CreateSpatialField(string shapeWkt); // Shape in WKT string form Use the `Spatial` method from `AbstractIndexCreationTask` to modify this setting. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-nodejs.mdx index acc0daf4a5..4fe664b269 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -141,7 +141,7 @@ createSpatialField(wkt); Use the `spatial` method to modify this setting. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-php.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-php.mdx index 04a653cd18..64b421636c 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -205,7 +205,7 @@ object CreateSpatialField(string shapeWkt); // Shape in WKT string form * **By default**, the `geohashPrefixTreeIndex` strategy is used with `geohashLevel` set to **9**. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-python.mdx b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-python.mdx index a0d9ff8898..f3e28750ce 100644 --- a/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_indexing-spatial-data-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -134,7 +134,7 @@ class WktField(DynamicSpatialField): # Shape in WKT string format * **By default**, the `geohash_prefix_tree_index` strategy is used with `geohash_level` set to **9**. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-6.2/indexes/content/_javascript-indexes-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_javascript-indexes-csharp.mdx index b276615b98..929d536785 100644 --- a/versioned_docs/version-6.2/indexes/content/_javascript-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_javascript-indexes-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; In addition, RavenDB provides a set of predefined JavaScript functions that can be used in JavaScript indexes and in other features such as subscriptions, ETL scripts, set-based patching, and more. See the full list in [Predefined JavaScript functions](../../server/kb/javascript-engine.mdx#predefined-javascript-functions). * In this article: - * [Creating and deploying a JavaScript index](../../indexes/javascript-indexes.mdx#creating-and-deploying-a-javascript-index) - * [Map index](../../indexes/javascript-indexes.mdx#map-index) - * [Map index - basic](../../indexes/javascript-indexes.mdx#example-i---map-index---basic) - * [Map index - with additional sources](../../indexes/javascript-indexes.mdx#example-ii---map-index---with-additional-sources) - * [Map index - with inline string compilation](../../indexes/javascript-indexes.mdx#example-iii---map-index---with-inline-string-compilation) - * [Multi-Map index](../../indexes/javascript-indexes.mdx#multi-map-index) - * [Map-Reduce index](../../indexes/javascript-indexes.mdx#map-reduce-index) + * [Creating and deploying a JavaScript index](#creating-and-deploying-a-javascript-index) + * [Map index](#map-index) + * [Map index - basic](#example-i---map-index---basic) + * [Map index - with additional sources](#example-ii---map-index---with-additional-sources) + * [Map index - with inline string compilation](#example-iii---map-index---with-inline-string-compilation) + * [Multi-Map index](#multi-map-index) + * [Map-Reduce index](#map-reduce-index) @@ -70,7 +70,7 @@ public class Documents_ByName_JS : AbstractJavaScriptIndexCreationTask ## Map index * A map index contains a single `map` function. - To define an index that uses multiple map functions, see the section on [Multi-Map indexes](../../indexes/javascript-indexes.mdx#multi-map-index) below. + To define an index that uses multiple map functions, see the section on [Multi-Map indexes](#multi-map-index) below. * The `map` function is written as a string and specifies what content from the documents will be indexed. diff --git a/versioned_docs/version-6.2/indexes/content/_map-indexes-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_map-indexes-csharp.mdx index 43b6efc8c0..96a59636e1 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-indexes-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; JavaScript indexes); they can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-6.2/indexes/content/_map-indexes-java.mdx b/versioned_docs/version-6.2/indexes/content/_map-indexes-java.mdx index 49f70a23b2..3c38d3df98 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-indexes-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-indexes-java.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; JavaScript indexes); they can be considered the **core** of indexes. * In this page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Indexing nested data](#indexing-nested-data) diff --git a/versioned_docs/version-6.2/indexes/content/_map-indexes-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_map-indexes-nodejs.mdx index 56817bb2f8..816fc04135 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-indexes-nodejs.mdx @@ -11,11 +11,11 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions are **LINQ-based functions**; they can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-6.2/indexes/content/_map-indexes-php.mdx b/versioned_docs/version-6.2/indexes/content/_map-indexes-php.mdx index 4ab5f8f10a..afcf76a878 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-indexes-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-indexes-php.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-6.2/indexes/content/_map-indexes-python.mdx b/versioned_docs/version-6.2/indexes/content/_map-indexes-python.mdx index e11a28be60..39c0de982a 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-indexes-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-indexes-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-csharp.mdx index 39d782797b..7ac6e2db7b 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-csharp.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -515,7 +515,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -527,7 +527,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -547,7 +547,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -803,7 +803,7 @@ public class OutputReduceToCollectionReference #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-java.mdx b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-java.mdx index 1338f6b9cf..684670df54 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-java.mdx @@ -23,9 +23,9 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Important Comments](../../indexes/map-reduce-indexes.mdx#important-comments) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Important Comments](#important-comments) @@ -396,7 +396,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -408,7 +408,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -428,7 +428,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -578,7 +578,7 @@ May 6th 1998. ## Important Comments ## Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. ## Recursive indexing loop diff --git a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-nodejs.mdx index 1a9f9832cf..4ba013bf8c 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-nodejs.mdx @@ -23,9 +23,9 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Important Comments](../../indexes/map-reduce-indexes.mdx#important-comments) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Important Comments](#important-comments) @@ -227,7 +227,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -317,7 +317,7 @@ const patternForOutputReduceToCollectionReferences = indexDefinition.patternForO ## Important Comments ## Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. ## Recursive indexing loop diff --git a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-php.mdx b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-php.mdx index 9bad365dde..cf50c110ad 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-php.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -700,7 +700,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in the [example](../../indexes/map-reduce-indexes.mdx#example) below may generate +The index in the [example](#example) below may generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -720,7 +720,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in this [example](../../indexes/map-reduce-indexes.mdx#example) has this pattern for +The index in this [example](#example) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -928,7 +928,7 @@ May 6th 1998. #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-python.mdx b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-python.mdx index 5da418f54e..17648710bb 100644 --- a/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_map-reduce-indexes-python.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -454,7 +454,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -466,7 +466,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -486,7 +486,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -644,7 +644,7 @@ May 6th 1998. #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-csharp.mdx index fe7f2e02ba..0e3dcbae4a 100644 --- a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [AddMap & AddMapForAll](../../indexes/multi-map-indexes.mdx#addmap--addmapforall) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [AddMap & AddMapForAll](#addmap--addmapforall) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-java.mdx b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-java.mdx index e9a0b53af3..68bccd953a 100644 --- a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-java.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [AddMap](../../indexes/multi-map-indexes.mdx#addmap) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [AddMap](#addmap) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-nodejs.mdx index cb74caae01..af01a97b2a 100644 --- a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [Indexing multiple collections](../../indexes/multi-map-indexes.mdx#indexing-multiple-collections) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [Indexing multiple collections](#indexing-multiple-collections) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-php.mdx b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-php.mdx index 943a2e8d7b..75ce89be26 100644 --- a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [`addMap`](../../indexes/multi-map-indexes.mdx#addmap) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [`addMap`](#addmap) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-python.mdx b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-python.mdx index c00cb5324f..605f74fc21 100644 --- a/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_multi-map-indexes-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [`_add_map`](../../indexes/multi-map-indexes.mdx#_add_map) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [`_add_map`](#_add_map) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-6.2/indexes/content/_number-type-conversion-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_number-type-conversion-csharp.mdx index 9b20c88b9a..e9a5ae4383 100644 --- a/versioned_docs/version-6.2/indexes/content/_number-type-conversion-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_number-type-conversion-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more about how numbers are stored in RavenDB [here](../../server/kb/numbers-in-ravendb.mdx). * In this page: - * [Syntax](../number-type-conversion.mdx#syntax) - * [Examples](../number-type-conversion.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-csharp.mdx index 22f78f07ae..cb4bf076c2 100644 --- a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; This behavior can be configured at the query level. See [Projection behavior with a static-index](../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) for details. * In this article: - * [What content is stored in the index](../../indexes/storing-data-in-index.mdx#what-content-is-stored-in-the-index) - * [When and why to store data in an index](../../indexes/storing-data-in-index.mdx#when-and-why-to-store-data-in-an-index) - * [Storing data in index - from the Client API](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-client-api) - * [Storing data in index - from the Studio](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-studio) + * [What content is stored in the index](#what-content-is-stored-in-the-index) + * [When and why to store data in an index](#when-and-why-to-store-data-in-an-index) + * [Storing data in index - from the Client API](#storing-data-in-index---from-the-client-api) + * [Storing data in index - from the Studio](#storing-data-in-index---from-the-studio) ## What content is stored in the index @@ -382,7 +382,7 @@ To configure index-fields from the Studio, open the _Edit Index_ view: ![The index](../assets/store-field-in-index-1.png) -1. This is the index from the [example above](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-client-api). +1. This is the index from the [example above](#storing-data-in-index---from-the-client-api). 2. These are the index-fields defined in the index map function. Scroll down to configure each index-field: @@ -398,7 +398,7 @@ you can choose to display the stored index fields in the Results view: ![Display the stored fields](../assets/store-field-in-index-3.png) -1. This is the query from the [example above](../../indexes/storing-data-in-index.mdx#query-the-index). +1. This is the query from the [example above](#query-the-index). 2. Open the _Settings_ options. 3. Toggle ON _Show stored index fields only_. 4. When executing the query, diff --git a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-java.mdx b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-java.mdx index 004928e64b..a3690ad3dc 100644 --- a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-java.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-nodejs.mdx index 54bc8c893c..d763b44a2c 100644 --- a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-nodejs.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-php.mdx b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-php.mdx index ba55ebff8b..243e64603a 100644 --- a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-php.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-python.mdx b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-python.mdx index 08c35b8d49..7a92cab527 100644 --- a/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_storing-data-in-index-python.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-6.2/indexes/content/_using-analyzers-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_using-analyzers-csharp.mdx index be8e7bd1f7..93fd91f43b 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-analyzers-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-analyzers-csharp.mdx @@ -23,26 +23,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; giving you full flexibility in configuring your indexes. * In this article: - * [Understanding the role of analyzers](../../indexes/using-analyzers.mdx#understanding-the-role-of-analyzers) - * [Analyzers in the index definition](../../indexes/using-analyzers.mdx#analyzers-in-the-index-definition) - * [Analyzers at indexing time](../../indexes/using-analyzers.mdx#analyzers-at-indexing-time) - * [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) - * [Full-text search](../../indexes/using-analyzers.mdx#full-text-search) - * [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb) - * [Analyzers that remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) - * [Analyzers that do not remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words) - * [Analyzers that tokenize according to the defined number of characters](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) - * [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field) - * [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendbs-default-analyzers) - * [Using the Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) - * [Using the Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer) - * [Using the Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) - * [Disabling indexing for index-field](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field) - * [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers) - * [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - * [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - * [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) - * [Viewing the indexed terms](../../indexes/using-analyzers.mdx#viewing-the-indexed-terms) + * [Understanding the role of analyzers](#understanding-the-role-of-analyzers) + * [Analyzers in the index definition](#analyzers-in-the-index-definition) + * [Analyzers at indexing time](#analyzers-at-indexing-time) + * [Analyzers at query time](#analyzers-at-query-time) + * [Full-text search](#full-text-search) + * [Analyzers available in RavenDB](#analyzers-available-in-ravendb) + * [Analyzers that remove common stop words](#analyzers-that-remove-common-stop-words) + * [Analyzers that do not remove common stop words](#analyzers-that-do-not-remove-common-stop-words) + * [Analyzers that tokenize according to the defined number of characters](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) + * [Setting analyzer for index-field](#setting-analyzer-for-index-field) + * [RavenDB's default analyzers](#ravendbs-default-analyzers) + * [Using the Default Search Analyzer](#using-the-default-search-analyzer) + * [Using the Default Exact Analyzer](#using-the-default-exact-analyzer) + * [Using the Default Analyzer](#using-the-default-analyzer) + * [Disabling indexing for index-field](#disabling-indexing-for-index-field) + * [Creating custom analyzers](#creating-custom-analyzers) + * [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + * [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + * [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) + * [Viewing the indexed terms](#viewing-the-indexed-terms) @@ -77,7 +77,7 @@ enabling [Full-text search](../../indexes/querying/searching.mdx). ### Analyzers at query time When running a [Full-text search with a dynamic query](../../client-api/session/querying/text-search/full-text-search.mdx), -the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). +the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](#using-the-default-search-analyzer). When running a [Full-text search on a static-index](../../indexes/querying/query-index.mdx), the **same analyzer** used to tokenize field content at indexing time is typically applied @@ -85,10 +85,10 @@ to process the terms provided in the full-text search query before they are sent There are two exceptions to this rule: - 1. When setting the [NGramAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, + 1. When setting the [NGramAnalyzer](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, it tokenizes the index field at indexing time. However, at query time, when performing a full-text search on that field, - the default [RavenStandardAnalyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. + the default [RavenStandardAnalyzer](#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. Currently, for query time, you cannot specify a different analyzer than the one defined in the index definition, so to address this issue, you have two options: @@ -103,8 +103,8 @@ There are two exceptions to this rule: ### Full-text search -In most cases, Lucene's [StandardAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. -For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +In most cases, Lucene's [StandardAnalyzer](#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. +For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](#creating-custom-analyzers). It is straightforward and may already be available as a contrib package for Lucene. You can also configure a specific collation for an index field to sort based on culture specific rules. @@ -126,13 +126,13 @@ Learn more in [Sorting and Collation](../../indexes/sorting-and-collation.mdx#co * **KeywordAnalyzer** * **NGramAnalyzer** -* If needed, you can create your own [Customized Analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +* If needed, you can create your own [Customized Analyzers](#creating-custom-analyzers). * To assign the analyzer of your choice to a specific index-field, - see: [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). + see: [Setting analyzer for index-field](#setting-analyzer-for-index-field). * When no analyzer is explicitly assigned to an index-field in the index definition, - RavenDB will use its [Default Analyzers](../../indexes/using-analyzers.mdx#ravendb) to process and tokenize the content of a field. + RavenDB will use its [Default Analyzers](#ravendb) to process and tokenize the content of a field. All examples below use the following text: @@ -177,7 +177,7 @@ All examples below use the following text: be aware that analyzers removing common stop words may treat IT as a stop word and exclude it from the resulting terms. This can also affect acronyms such as WHO (World Health Organization) or names such as "The Who" or "The IT Crowd". * To avoid excluding acronyms, you can either spell out the full title instead of abbreviating it - or use an [Analyzer that doesn't remove stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words). + or use an [Analyzer that doesn't remove stop words](#analyzers-that-do-not-remove-common-stop-words). @@ -272,7 +272,7 @@ All examples below use the following text: In RavenDB, the analyzer configured in the index definition is typically used both at indexing time and query time (the same analyzer). However, the `NGramAnalyzer` is an exception to this rule. - Refer to section [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) to learn about the different behaviors. + Refer to section [Analyzers at query time](#analyzers-at-query-time) to learn about the different behaviors. @@ -284,10 +284,10 @@ All examples below use the following text: use the `Analyzers.Add()` method within the index definition for that field. * Either: - * Specify an analyzer from the [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb), - * Or specify your own custom analyzer (see [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers)). + * Specify an analyzer from the [Analyzers available in RavenDB](#analyzers-available-in-ravendb), + * Or specify your own custom analyzer (see [Creating custom analyzers](#creating-custom-analyzers)). -* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendb). +* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](#ravendb). * An analyzer may also be set from the Edit Index view in the Studio, see [Index field options](../../studio/database/indexes/create-map-index.mdx#index-field-options). @@ -356,14 +356,14 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); depending on the specified Indexing Behavior. * The **Default Analyzers** are: - * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). - * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer). - * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer). + * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](#using-the-default-search-analyzer). + * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](#using-the-default-exact-analyzer). + * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](#using-the-default-analyzer). * The available **Indexing Behavior** values are: * `FieldIndexing.Exact` * `FieldIndexing.Search` - * `FieldIndexing.No` - This behavior [disables field indexing](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field). + * `FieldIndexing.No` - This behavior [disables field indexing](#disabling-indexing-for-index-field). * See the detailed explanation for each scenario below: @@ -548,9 +548,9 @@ public class BlogPosts_ByTitle : AbstractIndexCreationTask * **Ways to create**: There are three ways to create a custom analyzer and add it to your server: - 1. [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - 2. [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - 3. [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) + 1. [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + 2. [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + 3. [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) diff --git a/versioned_docs/version-6.2/indexes/content/_using-analyzers-java.mdx b/versioned_docs/version-6.2/indexes/content/_using-analyzers-java.mdx index 3ca36275b8..5efc4be21e 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-analyzers-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-analyzers-java.mdx @@ -16,13 +16,13 @@ The **Tokenization** process uses an object called an Analyzer underneath. The indexing process and its results can be controlled by various field options and Analyzers. * In this article: - * [Understanding Analyzers](../../indexes/using-analyzers.mdx#understanding-analyzers) - * [RavenDB Default Analyzer](../../indexes/using-analyzers.mdx#ravendb-default-analyzer) - * [Full-Text Search](../../indexes/using-analyzers.mdx#full-text-search) - * [Using Non-Default Analyzer](../../indexes/using-analyzers.mdx#using-non-default-analyzer) - * [Creating Own Analyzer](../../indexes/using-analyzers.mdx#creating-own-analyzer) - * [Manipulating Field Indexing Behavior](../../indexes/using-analyzers.mdx#manipulating-field-indexing-behavior) - * [Ordering When Field is Searchable](../../indexes/using-analyzers.mdx#ordering-when-field-is-searchable) + * [Understanding Analyzers](#understanding-analyzers) + * [RavenDB Default Analyzer](#ravendb-default-analyzer) + * [Full-Text Search](#full-text-search) + * [Using Non-Default Analyzer](#using-non-default-analyzer) + * [Creating Own Analyzer](#creating-own-analyzer) + * [Manipulating Field Indexing Behavior](#manipulating-field-indexing-behavior) + * [Ordering When Field is Searchable](#ordering-when-field-is-searchable) diff --git a/versioned_docs/version-6.2/indexes/content/_using-analyzers-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_using-analyzers-nodejs.mdx index d07293d2c1..053c2c8ea0 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-analyzers-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-analyzers-nodejs.mdx @@ -23,26 +23,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; giving you full flexibility in configuring your indexes. * In this article: - * [Understanding the role of analyzers](../../indexes/using-analyzers.mdx#understanding-the-role-of-analyzers) - * [Analyzers in the index definition](../../indexes/using-analyzers.mdx#analyzers-in-the-index-definition) - * [Analyzers at indexing time](../../indexes/using-analyzers.mdx#analyzers-at-indexing-time) - * [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) - * [Full-text search](../../indexes/using-analyzers.mdx#full-text-search) - * [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb) - * [Analyzers that remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) - * [Analyzers that do not remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words) - * [Analyzers that tokenize according to the defined number of characters](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) - * [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field) - * [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendbs-default-analyzers) - * [Using the Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) - * [Using the Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer) - * [Using the Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) - * [Disabling indexing for index-field](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field) - * [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers) - * [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - * [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - * [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) - * [Viewing the indexed terms](../../indexes/using-analyzers.mdx#viewing-the-indexed-terms) + * [Understanding the role of analyzers](#understanding-the-role-of-analyzers) + * [Analyzers in the index definition](#analyzers-in-the-index-definition) + * [Analyzers at indexing time](#analyzers-at-indexing-time) + * [Analyzers at query time](#analyzers-at-query-time) + * [Full-text search](#full-text-search) + * [Analyzers available in RavenDB](#analyzers-available-in-ravendb) + * [Analyzers that remove common stop words](#analyzers-that-remove-common-stop-words) + * [Analyzers that do not remove common stop words](#analyzers-that-do-not-remove-common-stop-words) + * [Analyzers that tokenize according to the defined number of characters](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) + * [Setting analyzer for index-field](#setting-analyzer-for-index-field) + * [RavenDB's default analyzers](#ravendbs-default-analyzers) + * [Using the Default Search Analyzer](#using-the-default-search-analyzer) + * [Using the Default Exact Analyzer](#using-the-default-exact-analyzer) + * [Using the Default Analyzer](#using-the-default-analyzer) + * [Disabling indexing for index-field](#disabling-indexing-for-index-field) + * [Creating custom analyzers](#creating-custom-analyzers) + * [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + * [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + * [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) + * [Viewing the indexed terms](#viewing-the-indexed-terms) @@ -77,7 +77,7 @@ enabling [Full-text search](../../indexes/querying/searching.mdx). ### Analyzers at query time When running a [Full-text search with a dynamic query](../../client-api/session/querying/text-search/full-text-search.mdx), -the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). +the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](#using-the-default-search-analyzer). When running a [Full-text search on a static-index](../../indexes/querying/query-index.mdx), the **same analyzer** used to tokenize field content at indexing time is typically applied @@ -85,10 +85,10 @@ to process the terms provided in the full-text search query before they are sent There are two exceptions to this rule: -1. When setting the [NGramAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, +1. When setting the [NGramAnalyzer](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, it tokenizes the index field at indexing time. However, at query time, when performing a full-text search on that field, - the default [RavenStandardAnalyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. + the default [RavenStandardAnalyzer](#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. Currently, for query time, you cannot specify a different analyzer than the one defined in the index definition, so to address this issue, you have two options: @@ -103,8 +103,8 @@ There are two exceptions to this rule: ### Full-text search -In most cases, Lucene's [StandardAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. -For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +In most cases, Lucene's [StandardAnalyzer](#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. +For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](#creating-custom-analyzers). It is straightforward and may already be available as a contrib package for Lucene. You can also configure a specific collation for an index field to sort based on culture specific rules. @@ -126,13 +126,13 @@ Learn more in [Sorting and Collation](../../indexes/sorting-and-collation.mdx#co * **KeywordAnalyzer** * **NGramAnalyzer** -* If needed, you can create your own [Customized Analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +* If needed, you can create your own [Customized Analyzers](#creating-custom-analyzers). * To assign the analyzer of your choice to a specific index-field, - see: [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). + see: [Setting analyzer for index-field](#setting-analyzer-for-index-field). * When no analyzer is explicitly assigned to an index-field in the index definition, - RavenDB will use its [Default Analyzers](../../indexes/using-analyzers.mdx#ravendb) to process and tokenize the content of a field. + RavenDB will use its [Default Analyzers](#ravendb) to process and tokenize the content of a field. All examples below use the following text: @@ -177,7 +177,7 @@ All examples below use the following text: be aware that analyzers removing common stop words may treat IT as a stop word and exclude it from the resulting terms. This can also affect acronyms such as WHO (World Health Organization) or names such as "The Who" or "The IT Crowd". * To avoid excluding acronyms, you can either spell out the full title instead of abbreviating it - or use an [Analyzer that doesn't remove stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words). + or use an [Analyzer that doesn't remove stop words](#analyzers-that-do-not-remove-common-stop-words). @@ -272,7 +272,7 @@ All examples below use the following text: In RavenDB, the analyzer configured in the index definition is typically used both at indexing time and query time (the same analyzer). However, the `NGramAnalyzer` is an exception to this rule. - Refer to section [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) to learn about the different behaviors. + Refer to section [Analyzers at query time](#analyzers-at-query-time) to learn about the different behaviors. @@ -284,10 +284,10 @@ All examples below use the following text: set the `analyze()` method within the index definition for that field. * Either: - * Specify an analyzer from the [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb), - * Or specify your own custom analyzer (see [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers)). + * Specify an analyzer from the [Analyzers available in RavenDB](#analyzers-available-in-ravendb), + * Or specify your own custom analyzer (see [Creating custom analyzers](#creating-custom-analyzers)). -* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendb). +* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](#ravendb). * An analyzer may also be set from the Edit Index view in the Studio, see [Index field options](../../studio/database/indexes/create-map-index.mdx#index-field-options). @@ -340,14 +340,14 @@ await store.maintenance depending on the specified Indexing Behavior. * The **Default Analyzers** are: - * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). - * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer). - * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer). + * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](#using-the-default-search-analyzer). + * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](#using-the-default-exact-analyzer). + * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](#using-the-default-analyzer). * The available **Indexing Behavior** values are: * `Exact` * `Search` - * `No` - This behavior [disables field indexing](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field). + * `No` - This behavior [disables field indexing](#disabling-indexing-for-index-field). * See the detailed explanation for each scenario below: @@ -522,9 +522,9 @@ class BlogPosts_ByTitle extends AbstractIndexCreationTask { * **Ways to create**: There are three ways to create a custom analyzer and add it to your server: - 1. [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - 2. [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - 3. [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) + 1. [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + 2. [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + 3. [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) diff --git a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-csharp.mdx index 5bf052d482..228f125616 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-csharp.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -282,7 +282,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -539,7 +539,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `AllFields` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `AllFields` has an analyzer configuration, RavenDB uses it as a fallback. @@ -558,7 +558,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -935,7 +935,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-java.mdx b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-java.mdx index d54ef6bea8..56e198d91a 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-java.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -276,7 +276,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -523,7 +523,7 @@ or `FieldIndexing.Search` in the `CreateFieldOptions` (`AbstractIndexCreationTas At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -542,7 +542,7 @@ or `FieldIndexing.Search` in the `CreateFieldOptions` (`AbstractIndexCreationTas The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -910,7 +910,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-nodejs.mdx index c14184c2b5..3e315a05a8 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-nodejs.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`createField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`createField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -247,7 +247,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -459,7 +459,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -478,7 +478,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -722,7 +722,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-php.mdx b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-php.mdx index 6992310715..4853440cda 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-php.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -293,7 +293,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -569,7 +569,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -588,7 +588,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -981,7 +981,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-python.mdx b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-python.mdx index 6862d18067..4b11f90065 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-dynamic-fields-python.mdx @@ -19,17 +19,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -277,7 +277,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -520,7 +520,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -539,7 +539,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -897,7 +897,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-6.2/indexes/content/_using-term-vectors-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_using-term-vectors-csharp.mdx index bd120be8c4..4774ed598c 100644 --- a/versioned_docs/version-6.2/indexes/content/_using-term-vectors-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_using-term-vectors-csharp.mdx @@ -16,9 +16,9 @@ import CodeBlock from '@theme/CodeBlock'; stored term vectors to accomplish their goals. * In this page: - * [Creating an index and enabling Term Vectors on a field](../../indexes/using-term-vectors.mdx#creating-an-index-and-enabling-term-vectors-on-a-field) - * [Using the API](../../indexes/using-term-vectors.mdx#using-the-api) - * [Using Studio](../../indexes/using-term-vectors.mdx#using-studio) + * [Creating an index and enabling Term Vectors on a field](#creating-an-index-and-enabling-term-vectors-on-a-field) + * [Using the API](#using-the-api) + * [Using Studio](#using-studio) ## Creating an index and enabling Term Vectors on a field diff --git a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-csharp.mdx b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-csharp.mdx index 4302871174..6155f8b424 100644 --- a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-csharp.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-java.mdx b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-java.mdx index f75c4d64c9..f2b0722750 100644 --- a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-java.mdx +++ b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-java.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-nodejs.mdx b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-nodejs.mdx index b5fb8e4674..3f60575411 100644 --- a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-nodejs.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-php.mdx b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-php.mdx index 281f5f750f..389bc83730 100644 --- a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-php.mdx +++ b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-php.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-python.mdx b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-python.mdx index 139570d9d3..2a81ed73aa 100644 --- a/versioned_docs/version-6.2/indexes/content/_what-are-indexes-python.mdx +++ b/versioned_docs/version-6.2/indexes/content/_what-are-indexes-python.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-6.2/indexes/index-administration.mdx b/versioned_docs/version-6.2/indexes/index-administration.mdx index 14d18bebd4..4e07cd421b 100644 --- a/versioned_docs/version-6.2/indexes/index-administration.mdx +++ b/versioned_docs/version-6.2/indexes/index-administration.mdx @@ -18,17 +18,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; or via [Maintenance operations](../client-api/operations/what-are-operations.mdx#maintenance-operations) in the Client API. * In this article: - * [Index management operations](../indexes/index-administration.mdx#index-management-operations) - * [Pause & resume index](../indexes/index-administration.mdx#pause--resume-index) - * [Pause & resume indexing](../indexes/index-administration.mdx#pause--resume-indexing) - * [Disable & enable index](../indexes/index-administration.mdx#disable--enable-index) - * [Disable & enable indexing](../indexes/index-administration.mdx#disable--enable-indexing) - * [Reset index](../indexes/index-administration.mdx#reset-index) - * [Delete index](../indexes/index-administration.mdx#delete-index) - * [Set index lock mode](../indexes/index-administration.mdx#set-index-lock-mode) - * [Set index priority](../indexes/index-administration.mdx#set-index-priority) - * [Index states](../indexes/index-administration.mdx#index-states) - * [Customize indexing configuration](../indexes/index-administration.mdx#customize-indexing-configuration) + * [Index management operations](#index-management-operations) + * [Pause & resume index](#pause--resume-index) + * [Pause & resume indexing](#pause--resume-indexing) + * [Disable & enable index](#disable--enable-index) + * [Disable & enable indexing](#disable--enable-indexing) + * [Reset index](#reset-index) + * [Delete index](#delete-index) + * [Set index lock mode](#set-index-lock-mode) + * [Set index priority](#set-index-priority) + * [Index states](#index-states) + * [Customize indexing configuration](#customize-indexing-configuration) ## Index management operations diff --git a/versioned_docs/version-6.2/indexes/index-throttling.mdx b/versioned_docs/version-6.2/indexes/index-throttling.mdx index 777132e7d5..621c07e5a7 100644 --- a/versioned_docs/version-6.2/indexes/index-throttling.mdx +++ b/versioned_docs/version-6.2/indexes/index-throttling.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Indexing is triggered normally when items are added or modified, but RavenDB suspends index procession by the set interval. * The gaps in indexing activity and the procession of - [larger batches](../indexes/index-throttling.mdx#throttling-and-batches) + [larger batches](#throttling-and-batches) can reduce overall indexing CPU utilization. * Indexing can be throttled server-wide, per-database, and per-index. * Index throttling applies to the procession of **existing** indexes. @@ -26,11 +26,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * [Why Use Index Throttling?](../indexes/index-throttling.mdx#why-use-index-throttling?) - * [Index Throttling and Batches](../indexes/index-throttling.mdx#throttling-and-batches) - * [Setting Index Throttling](../indexes/index-throttling.mdx#setting-index-throttling) - * [Server-Wide](../indexes/index-throttling.mdx#server-wide-index-throttling) - * [Per-Database](../indexes/index-throttling.mdx#index-throttling-per-database) - * [Per-Index](../indexes/index-throttling.mdx#index-throttling-in-an-index-definition) + * [Index Throttling and Batches](#throttling-and-batches) + * [Setting Index Throttling](#setting-index-throttling) + * [Server-Wide](#server-wide-index-throttling) + * [Per-Database](#index-throttling-per-database) + * [Per-Index](#index-throttling-in-an-index-definition) ## Why Use Index Throttling? @@ -80,7 +80,7 @@ In special cases, throttled indexes' batches are processed without delay. Enable or disable index throttling for a specific database using the designated database configuration key. Setting this property overrides the -[Server-Wide](../indexes/index-throttling.mdx#server-wide-index-throttling) default. +[Server-Wide](#server-wide-index-throttling) default. * **From Studio**: @@ -106,8 +106,8 @@ Setting this property overrides the ### Index Throttling in an Index Definition -Setting throttling in an index definition overrides [server-wide](../indexes/index-throttling.mdx#server-wide-index-throttling) -and [database](../indexes/index-throttling.mdx#index-throttling-per-database) settings configuration. +Setting throttling in an index definition overrides [server-wide](#server-wide-index-throttling) +and [database](#index-throttling-per-database) settings configuration. * **From Code**: diff --git a/versioned_docs/version-6.2/indexes/querying/content/_distinct-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_distinct-csharp.mdx index 0836aaa25c..675c8af830 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_distinct-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_distinct-csharp.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with Distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with Distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with Distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and alternative approaches](../../../indexes/querying/distinct.mdx#performance-cost-and-alternative-approaches) + * [Sample query with Distinct](#sample-query-with-distinct) + * [Paging with Distinct](#paging-with-distinct) + * [Count with Distinct](#count-with-distinct) + * [Performance cost and alternative approaches](#performance-cost-and-alternative-approaches) ## Sample query with Distinct diff --git a/versioned_docs/version-6.2/indexes/querying/content/_distinct-java.mdx b/versioned_docs/version-6.2/indexes/querying/content/_distinct-java.mdx index e94fc97813..ee344b2092 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_distinct-java.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_distinct-java.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and an alternative approach](../../../indexes/querying/distinct.mdx#performance-cost-and-an-alternative-approach) + * [Sample query with distinct](#sample-query-with-distinct) + * [Paging with distinct](#paging-with-distinct) + * [Count with distinct](#count-with-distinct) + * [Performance cost and an alternative approach](#performance-cost-and-an-alternative-approach) ## Sample query with Distinct diff --git a/versioned_docs/version-6.2/indexes/querying/content/_distinct-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_distinct-nodejs.mdx index 90dcd69923..edd0e1f1b0 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_distinct-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_distinct-nodejs.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and an alternative approach](../../../indexes/querying/distinct.mdx#performance-cost-and-an-alternative-approach) + * [Sample query with distinct](#sample-query-with-distinct) + * [Paging with distinct](#paging-with-distinct) + * [Count with distinct](#count-with-distinct) + * [Performance cost and an alternative approach](#performance-cost-and-an-alternative-approach) ## Sample query with distinct diff --git a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-csharp.mdx index 3540761ad1..9113fa7fa2 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-csharp.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. @@ -28,19 +28,19 @@ import CodeBlock from '@theme/CodeBlock'; * **Limit** the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) diff --git a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-nodejs.mdx index e475ad8931..59b29d75e1 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-nodejs.mdx @@ -24,20 +24,20 @@ import CodeBlock from '@theme/CodeBlock'; * **Limit** the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) + * [Syntax](#syntax) ## `filter` @@ -51,7 +51,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../indexes/querying/filtering.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-php.mdx index fffb35f884..b735eae17a 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-php.mdx @@ -16,30 +16,30 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. We recommend that you - - * [Limit](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + * [Limit](#limit-the-query-and-prefer--for-recurring-queries) the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) @@ -52,7 +52,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../indexes/querying/filtering.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-python.mdx index 227bcf8d34..4dd203b1a9 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_exploration-queries-python.mdx @@ -16,30 +16,30 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. We recommend that you - - * [Limit](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + * [Limit](#limit-the-query-and-prefer--for-recurring-queries) the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) @@ -52,7 +52,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../indexes/querying/filtering.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-csharp.mdx index 89fe73faae..25f47739eb 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-nodejs.mdx index ece8bbc9d4..c5b4e2de9d 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-php.mdx index 2e7f0723b8..780a25b773 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-php.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-python.mdx index dd57baf923..fe86eb7505 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_faceted-search-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_filtering-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_filtering-csharp.mdx index 0c1d75e840..7270b63d24 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_filtering-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_filtering-csharp.mdx @@ -15,18 +15,18 @@ import CodeBlock from '@theme/CodeBlock'; * The examples in this page demonstrate how filtering is applied by each of the above querying methods. * In this page: - * [Where](../../../indexes/querying/filtering.mdx#where) - * [Where - Numeric Property](../../../indexes/querying/filtering.mdx#where---numeric-property) - * [Where - Nested Property](../../../indexes/querying/filtering.mdx#where---nested-property) + * [Where](#where) + * [Where - Numeric Property](#where---numeric-property) + * [Where - Nested Property](#where---nested-property) * [Where + Any](../../../indexes/querying/filtering.mdx#where-+-any) * [Where + In](../../../indexes/querying/filtering.mdx#where-+-in) * [Where + ContainsAny](../../../indexes/querying/filtering.mdx#where-+-containsany) * [Where + ContainsAll](../../../indexes/querying/filtering.mdx#where-+-containsall) - * [Where - StartsWith](../../../indexes/querying/filtering.mdx#where---startswith) - * [Where - EndsWith](../../../indexes/querying/filtering.mdx#where---endswith) - * [Where - Identifier Property](../../../indexes/querying/filtering.mdx#where---identifier-property) - * [Where - Exists](../../../indexes/querying/filtering.mdx#where---exists) - * [Remarks](../../../indexes/querying/filtering.mdx#remarks) + * [Where - StartsWith](#where---startswith) + * [Where - EndsWith](#where---endswith) + * [Where - Identifier Property](#where---identifier-property) + * [Where - Exists](#where---exists) + * [Remarks](#remarks) diff --git a/versioned_docs/version-6.2/indexes/querying/content/_filtering-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_filtering-nodejs.mdx index 100569c868..dc6fc29cb1 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_filtering-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_filtering-nodejs.mdx @@ -8,17 +8,17 @@ import CodeBlock from '@theme/CodeBlock'; * One of the most basic functionalities of querying is the ability to filter out data and return records that match a given condition. * The following examples demonstrate how to add simple conditions to a query: - * [Where - equals](../../../indexes/querying/filtering.mdx#where---equals) - * [Where - numeric property](../../../indexes/querying/filtering.mdx#where---numeric-property) - * [Where - nested property](../../../indexes/querying/filtering.mdx#where---nested-property) - * [Where - multiple values](../../../indexes/querying/filtering.mdx#where---multiple-values) - * [Where - in](../../../indexes/querying/filtering.mdx#where---in) - * [Where - containsAny](../../../indexes/querying/filtering.mdx#where---containsany) - * [Where - containsAll](../../../indexes/querying/filtering.mdx#where---containsall) - * [Where - startsWith](../../../indexes/querying/filtering.mdx#where---startswith) - * [Where - endsWith](../../../indexes/querying/filtering.mdx#where---endswith) - * [Where - exists](../../../indexes/querying/filtering.mdx#where---exists) - * [Where - filter by ID](../../../indexes/querying/filtering.mdx#where---filter-by-id) + * [Where - equals](#where---equals) + * [Where - numeric property](#where---numeric-property) + * [Where - nested property](#where---nested-property) + * [Where - multiple values](#where---multiple-values) + * [Where - in](#where---in) + * [Where - containsAny](#where---containsany) + * [Where - containsAll](#where---containsall) + * [Where - startsWith](#where---startswith) + * [Where - endsWith](#where---endswith) + * [Where - exists](#where---exists) + * [Where - filter by ID](#where---filter-by-id) ## Where - equals diff --git a/versioned_docs/version-6.2/indexes/querying/content/_filtering-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_filtering-php.mdx index 1b7b22e04d..dbed925d14 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_filtering-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_filtering-php.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * The examples in this page demonstrate how filtering is applied by each of these methods. * In this page: - * [`whereEquals` - Where equals](../../../indexes/querying/filtering.mdx#whereequals---where-equals) - * [`whereGreaterThan` - Numeric property](../../../indexes/querying/filtering.mdx#wheregreaterthan---numeric-property) - * [`whereGreaterThan` - Nested property](../../../indexes/querying/filtering.mdx#wheregreaterthan---nested-property) - * [`whereIn` - Single -vs- Multiple values](../../../indexes/querying/filtering.mdx#wherein---single--vs--multiple-values) - * [`containsAny` - Any value from specified collection](../../../indexes/querying/filtering.mdx#containsany---any-value-from-specified-collection) - * [`containsAll` - All values from specified collection](../../../indexes/querying/filtering.mdx#containsall---all-values-from-specified-collection) - * [`whereStartsWith` - All records with given prefix](../../../indexes/querying/filtering.mdx#wherestartswith---all-records-with-given-prefix) - * [`whereEndsWith` - All records with given suffix](../../../indexes/querying/filtering.mdx#whereendswith---all-records-with-given-suffix) - * [Where - Identifier Property](../../../indexes/querying/filtering.mdx#where---identifier-property) - * [`whereExists` - Where exists or doesn't exist](../../../indexes/querying/filtering.mdx#whereexists---where-exists-or-doesn) + * [`whereEquals` - Where equals](#whereequals---where-equals) + * [`whereGreaterThan` - Numeric property](#wheregreaterthan---numeric-property) + * [`whereGreaterThan` - Nested property](#wheregreaterthan---nested-property) + * [`whereIn` - Single -vs- Multiple values](#wherein---single--vs--multiple-values) + * [`containsAny` - Any value from specified collection](#containsany---any-value-from-specified-collection) + * [`containsAll` - All values from specified collection](#containsall---all-values-from-specified-collection) + * [`whereStartsWith` - All records with given prefix](#wherestartswith---all-records-with-given-prefix) + * [`whereEndsWith` - All records with given suffix](#whereendswith---all-records-with-given-suffix) + * [Where - Identifier Property](#where---identifier-property) + * [`whereExists` - Where exists or doesn't exist](#whereexists---where-exists-or-doesn) diff --git a/versioned_docs/version-6.2/indexes/querying/content/_filtering-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_filtering-python.mdx index 87fb276553..789d074875 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_filtering-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_filtering-python.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * The examples in this page demonstrate how filtering is applied by each of these methods. * In this page: - * [`where_equals` - Where equals](../../../indexes/querying/filtering.mdx#where_equals---where-equals) - * [`where_greater_than` - Numeric property](../../../indexes/querying/filtering.mdx#where_greater_than---numeric-property) - * [`where_greater_than` - Nested property](../../../indexes/querying/filtering.mdx#where_greater_than---nested-property) - * [`where_in` - Single -vs- Multiple values](../../../indexes/querying/filtering.mdx#where_in---single--vs--multiple-values) - * [`contains_any` - Any value from specified collection](../../../indexes/querying/filtering.mdx#contains_any---any-value-from-specified-collection) - * [`contains_all` - All values from specified collection](../../../indexes/querying/filtering.mdx#contains_all---all-values-from-specified-collection) - * [`where_starts_with` - All records with given prefix](../../../indexes/querying/filtering.mdx#where_starts_with---all-records-with-given-prefix) - * [`where_ends_with` - All records with given suffix](../../../indexes/querying/filtering.mdx#where_ends_with---all-records-with-given-suffix) - * [Where - Identifier Property](../../../indexes/querying/filtering.mdx#where---identifier-property) - * [`where_exists` - Where exists or doesn't exist](../../../indexes/querying/filtering.mdx#where_exists---where-exists-or-doesn) + * [`where_equals` - Where equals](#where_equals---where-equals) + * [`where_greater_than` - Numeric property](#where_greater_than---numeric-property) + * [`where_greater_than` - Nested property](#where_greater_than---nested-property) + * [`where_in` - Single -vs- Multiple values](#where_in---single--vs--multiple-values) + * [`contains_any` - Any value from specified collection](#contains_any---any-value-from-specified-collection) + * [`contains_all` - All values from specified collection](#contains_all---all-values-from-specified-collection) + * [`where_starts_with` - All records with given prefix](#where_starts_with---all-records-with-given-prefix) + * [`where_ends_with` - All records with given suffix](#where_ends_with---all-records-with-given-suffix) + * [Where - Identifier Property](#where---identifier-property) + * [`where_exists` - Where exists or doesn't exist](#where_exists---where-exists-or-doesn) diff --git a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-csharp.mdx index 15085cc628..27f4f5c2a5 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-nodejs.mdx index 6d8abe3ba6..3157af960e 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-php.mdx index 2fe7124c18..d86dbd47bd 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-python.mdx index 543a4c0b07..134d5578cd 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_highlighting-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_highlighting-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-csharp.mdx index d8d84b9af2..dd06e172b1 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations when querying Map index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-index) - * [Include explanations when querying Map-Reduce index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-reduce-index) - * [Syntax](../../../indexes/querying/include-explanations.mdx#syntax) + * [Include explanations when querying Map index](#include-explanations-when-querying-map-index) + * [Include explanations when querying Map-Reduce index](#include-explanations-when-querying-map-reduce-index) + * [Syntax](#syntax) ## Include explanations when querying Map index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-nodejs.mdx index b843b7cc79..df30ef33c8 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_include-explanations-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations when querying Map index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-index) - * [Include explanations when querying Map-Reduce index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-reduce-index) - * [Syntax](../../../indexes/querying/include-explanations.mdx#syntax) + * [Include explanations when querying Map index](#include-explanations-when-querying-map-index) + * [Include explanations when querying Map-Reduce index](#include-explanations-when-querying-map-reduce-index) + * [Syntax](#syntax) ## Include explanations when querying Map index diff --git a/versioned_docs/version-6.2/indexes/querying/content/_intersection-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_intersection-csharp.mdx index 0651af1f31..a0a51e7673 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_intersection-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_intersection-csharp.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-6.2/indexes/querying/content/_intersection-java.mdx b/versioned_docs/version-6.2/indexes/querying/content/_intersection-java.mdx index 199fb9551a..f2bfb578c3 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_intersection-java.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_intersection-java.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-6.2/indexes/querying/content/_intersection-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_intersection-nodejs.mdx index 78a9d6f52e..4884310716 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_intersection-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_intersection-nodejs.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-6.2/indexes/querying/content/_intersection-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_intersection-php.mdx index 60746172df..2e01c264f2 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_intersection-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_intersection-php.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-6.2/indexes/querying/content/_intersection-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_intersection-python.mdx index 331c25bb18..8911d37bfa 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_intersection-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_intersection-python.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-csharp.mdx index a92a5c5880..022c7c44a7 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-java.mdx b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-java.mdx index 6470ebb953..ece0a855c1 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-java.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-nodejs.mdx index dea48c1f54..7dc0a3767e 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-php.mdx index 7007d3db07..b33c51237a 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-php.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-python.mdx index 88b86d0cba..73889e607f 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_morelikethis-python.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-6.2/indexes/querying/content/_paging-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_paging-csharp.mdx index ab3f9cd8cc..22a19fb41f 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_paging-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_paging-csharp.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-6.2/indexes/querying/content/_paging-java.mdx b/versioned_docs/version-6.2/indexes/querying/content/_paging-java.mdx index 2bf012245d..f8e9850253 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_paging-java.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_paging-java.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-6.2/indexes/querying/content/_paging-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_paging-nodejs.mdx index 5e44b5c140..5eb1b316ae 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_paging-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_paging-nodejs.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-6.2/indexes/querying/content/_paging-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_paging-php.mdx index ad5542405a..a6c5d97e3d 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_paging-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_paging-php.mdx @@ -24,14 +24,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no-paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no-paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-6.2/indexes/querying/content/_paging-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_paging-python.mdx index 0603b5f4ea..1347bf7760 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_paging-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_paging-python.mdx @@ -24,14 +24,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-6.2/indexes/querying/content/_projections-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_projections-csharp.mdx index fe7109c1a6..2339da2862 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_projections-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_projections-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about Projections and for dynamic-queries examples. * In this page: - * [Projection Methods](../../../indexes/querying/projections.mdx#select): - * [Select](../../../indexes/querying/projections.mdx#select) - * [ProjectInto](../../../indexes/querying/projections.mdx#projectinto) - * [SelectFields](../../../indexes/querying/projections.mdx#selectfields) - * [Projection behavior with a static-index](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) - * [OfType](../../../indexes/querying/projections.mdx#oftype) + * [Projection Methods](#select): + * [Select](#select) + * [ProjectInto](#projectinto) + * [SelectFields](#selectfields) + * [Projection behavior with a static-index](#projection-behavior-with-a-static-index) + * [OfType](#oftype) ## Select @@ -109,14 +109,14 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * In the above example, the fields to return by the projection that are specified in the `Select` method (`x.FirstName` & `x.LastName`) are recognized by the compiler as fields of the `IndexEntry` class. - * If you wish to specify fields from the original 'Employee' class type then follow [this example](../../../indexes/querying/projections.mdx#oftype) that uses `OfType`. + * If you wish to specify fields from the original 'Employee' class type then follow [this example](#oftype) that uses `OfType`. * **Source of projection fields**: * Since the index-fields in this example are not [Stored in the index](../../../indexes/storing-data-in-index.mdx), and no projection behavior was defined, resulting values for `FirstName` & `LastName` will be retrieved from the matching Employee document in the storage. - * This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. + * This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. @@ -196,7 +196,7 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * In this example, the projected fields (`FirstName` and `LastName`) are stored in the index, so by default, the resulting values will come directly from the index and Not from the Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_projections-java.mdx b/versioned_docs/version-6.2/indexes/querying/content/_projections-java.mdx index 4642c7bbb6..f9f6420f82 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_projections-java.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_projections-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; There are couple of ways to perform projections in RavenDB: -- projections using [SelectFields](../../../indexes/querying/projections.mdx#selectfields) -- using [OfType](../../../indexes/querying/projections.mdx#oftype) +- projections using [SelectFields](#selectfields) +- using [OfType](#oftype) ## What are Projections and When to Use Them diff --git a/versioned_docs/version-6.2/indexes/querying/content/_projections-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_projections-nodejs.mdx index 23eebdd1ee..7335bf9b8b 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_projections-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_projections-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about Projections and for dynamic-queries examples. * In this page: - * [SelectFields](../../../indexes/querying/projections.mdx#selectfields) - * [Projection behavior with a static-index](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) - * [ofType](../../../indexes/querying/projections.mdx#oftype) + * [SelectFields](#selectfields) + * [Projection behavior with a static-index](#projection-behavior-with-a-static-index) + * [ofType](#oftype) ## SelectFields @@ -77,7 +77,7 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * Since the index-fields in this example are not [Stored in the index](../../../indexes/storing-data-in-index.mdx), and no projection behavior was defined, resulting values for `FirstName` & `LastName` will be retrieved from the matching Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. @@ -131,7 +131,7 @@ select FirstName, LastName * In this example, the projected fields (`FirstName` and `LastName`) are stored in the index, so by default, the resulting values will come directly from the index and not from the Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_projections-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_projections-php.mdx index 21ed25851e..5797fc2db8 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_projections-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_projections-php.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are Projections and When to Use Them](../../../indexes/querying/projections.mdx#what-are-projections-and-when-to-use-them) - * [`selectFields`](../../../indexes/querying/projections.mdx#selectfields) - * [Examples](../../../indexes/querying/projections.mdx#examples) - * [Projection Behavior](../../../indexes/querying/projections.mdx#projection-behavior) - * [Projections and the Session](../../../indexes/querying/projections.mdx#projections-and-the-session) + * [What are Projections and When to Use Them](#what-are-projections-and-when-to-use-them) + * [`selectFields`](#selectfields) + * [Examples](#examples) + * [Projection Behavior](#projection-behavior) + * [Projections and the Session](#projections-and-the-session) ## What are Projections and When to Use Them diff --git a/versioned_docs/version-6.2/indexes/querying/content/_projections-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_projections-python.mdx index a72ff66f70..7ecba701fd 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_projections-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_projections-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are Projections and When to Use Them](../../../indexes/querying/projections.mdx#what-are-projections-and-when-to-use-them) - * [`select_fields`](../../../indexes/querying/projections.mdx#select_fields) - * [Examples](../../../indexes/querying/projections.mdx#examples) - * [Projection Behavior](../../../indexes/querying/projections.mdx#projection-behavior) - * [Projections and the Session](../../../indexes/querying/projections.mdx#projections-and-the-session) - * [Syntax](../../../indexes/querying/projections.mdx#syntax) + * [What are Projections and When to Use Them](#what-are-projections-and-when-to-use-them) + * [`select_fields`](#select_fields) + * [Examples](#examples) + * [Projection Behavior](#projection-behavior) + * [Projections and the Session](#projections-and-the-session) + * [Syntax](#syntax) ## What are Projections and When to Use Them diff --git a/versioned_docs/version-6.2/indexes/querying/content/_query-index-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_query-index-csharp.mdx index 2943798454..4392286243 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_query-index-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_query-index-csharp.mdx @@ -16,9 +16,9 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../client-api/session/querying/what-is-rql.mdx). * In this page: - * [Query an index by `Query`](../../../indexes/querying/query-index.mdx#query-an-index-by-query) (using LINQ) - * [Query an index by `DocumentQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-documentquery) (low-level API) - * [Query an index by `RawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) (using RQL) + * [Query an index by `Query`](#query-an-index-by-query) (using LINQ) + * [Query an index by `DocumentQuery`](#query-an-index-by-documentquery) (low-level API) + * [Query an index by `RawQuery`](#query-an-index-by-rawquery) (using RQL) ## Query an index by `Query` @@ -462,8 +462,8 @@ where LastName == "King" ## Query an index by `RawQuery` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_query-index-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_query-index-nodejs.mdx index 06a415c7ed..eb278d2233 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_query-index-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_query-index-nodejs.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../client-api/session/querying/what-is-rql.mdx). * In this page: - * [Query an index by `Query`](../../../indexes/querying/query-index.mdx#query-an-index-by-query) (using API) - * [Query an index by `RawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) (using RQL) + * [Query an index by `Query`](#query-an-index-by-query) (using API) + * [Query an index by `RawQuery`](#query-an-index-by-rawquery) (using RQL) ## Query an index by `Query` @@ -273,7 +273,7 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `RawQuery` -* Queries defined with [query](../../../indexes/querying/query-index.mdx#sessionquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. +* Queries defined with [query](#sessionquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_query-index-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_query-index-php.mdx index 0d50cc1961..7852f1c2ad 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_query-index-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_query-index-php.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; * Querying can be enhanced using these [extension methods](../../../client-api/session/querying/how-to-query.mdx#custom-methods). * In this page: - * [Query index - no filtering](../../../indexes/querying/query-index.mdx#query-index---no-filtering) - * [Query index - with filtering](../../../indexes/querying/query-index.mdx#query-index---with-filtering) - * [Query index - with paging](../../../indexes/querying/query-index.mdx#query-index---with-paging) - * [Query an index by `documentQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-documentquery) - * [Query an index by `rawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) + * [Query index - no filtering](#query-index---no-filtering) + * [Query index - with filtering](#query-index---with-filtering) + * [Query index - with paging](#query-index---with-paging) + * [Query an index by `documentQuery`](#query-an-index-by-documentquery) + * [Query an index by `rawQuery`](#query-an-index-by-rawquery) ## Query index - no filtering @@ -442,8 +442,8 @@ where LastName == "King" ## Query an index by `rawQuery` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_query-index-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_query-index-python.mdx index cd0465ebf0..84a02ce41e 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_query-index-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_query-index-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../client-api/session/querying/what-is-rql.mdx). * In this page: - * [Query an index by `query_index_type` and `query_index`](../../../indexes/querying/query-index.mdx#query-an-index-by-query_index_type-and-query_index) - * [Query an index by `raw_query`](../../../indexes/querying/query-index.mdx#query-an-index-by-raw_query) (using RQL) + * [Query an index by `query_index_type` and `query_index`](#query-an-index-by-query_index_type-and-query_index) + * [Query an index by `raw_query`](#query-an-index-by-raw_query) (using RQL) ## Query an index by `query_index_type` and `query_index` @@ -247,8 +247,8 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `raw_query` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_searching-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_searching-csharp.mdx index f0be0e6ffd..f481fa95c4 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_searching-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_searching-csharp.mdx @@ -19,15 +19,15 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) - * [Searching with wildcards](../../../indexes/querying/searching.mdx#searching-with-wildcards) - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) + * [Searching with wildcards](#searching-with-wildcards) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) @@ -409,9 +409,9 @@ where search(AllValues, "tofu") [analyzer](../../../indexes/using-analyzers.mdx) used in the index. * Note the different behavior in the following cases, as described below: - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) * When using [Corax](../../../indexes/search-engine/corax.mdx) as the search engine, this behavior will only apply to indexes that are newly created or have been reset. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_searching-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_searching-nodejs.mdx index cb73bfd7c0..2f85678a0f 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_searching-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_searching-nodejs.mdx @@ -20,15 +20,15 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) - * [Searching with wildcards](../../../indexes/querying/searching.mdx#searching-with-wildcards) - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) + * [Searching with wildcards](#searching-with-wildcards) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) @@ -262,9 +262,9 @@ where search(AllValues, "tofu") [analyzer](../../../indexes/using-analyzers.mdx) used in the index. * Note the different behavior in the following cases, as described below: - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) * When using [Corax](../../../indexes/search-engine/corax.mdx) as the search engine, this behavior will only apply to indexes that are newly created or have been reset. diff --git a/versioned_docs/version-6.2/indexes/querying/content/_searching-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_searching-php.mdx index 510a6f8752..3409ce29a8 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_searching-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_searching-php.mdx @@ -20,11 +20,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) diff --git a/versioned_docs/version-6.2/indexes/querying/content/_searching-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_searching-python.mdx index 88c6aa452f..77adcfe80e 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_searching-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_searching-python.mdx @@ -20,11 +20,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) diff --git a/versioned_docs/version-6.2/indexes/querying/content/_sorting-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_sorting-csharp.mdx index f643a3eeae..d276994187 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_sorting-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_sorting-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-6.2/indexes/querying/content/_sorting-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_sorting-nodejs.mdx index f6b313e17d..6fd9f1fa23 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_sorting-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_sorting-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-6.2/indexes/querying/content/_sorting-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_sorting-php.mdx index 189f8a52cd..bba203db6d 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_sorting-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_sorting-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-6.2/indexes/querying/content/_sorting-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_sorting-python.mdx index 4e2ad4dbd0..3fe92c388e 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_sorting-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_sorting-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-6.2/indexes/querying/content/_spatial-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_spatial-csharp.mdx index af1341ff81..9d948500cc 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_spatial-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_spatial-csharp.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-6.2/indexes/querying/content/_spatial-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_spatial-nodejs.mdx index 066a9fdc5e..cf4a055849 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_spatial-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_spatial-nodejs.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-6.2/indexes/querying/content/_spatial-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_spatial-php.mdx index 9a183fb5f4..f01f2bf755 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_spatial-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_spatial-php.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-6.2/indexes/querying/content/_spatial-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_spatial-python.mdx index 40b3108c0d..ec83d3c919 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_spatial-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_spatial-python.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-csharp.mdx b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-csharp.mdx index 2b0a8bfa50..d482d02803 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-csharp.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-nodejs.mdx b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-nodejs.mdx index ac05e8c401..b0b1f7b335 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-nodejs.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-php.mdx b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-php.mdx index 96373c2477..067caf9f40 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-php.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-php.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-python.mdx b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-python.mdx index 3943dfab03..36d78c20a9 100644 --- a/versioned_docs/version-6.2/indexes/querying/content/_suggestions-python.mdx +++ b/versioned_docs/version-6.2/indexes/querying/content/_suggestions-python.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx b/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx index 695ac33ae6..1c1fb62b3c 100644 --- a/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx +++ b/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx @@ -23,14 +23,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Why Rolling Index Deployment](../indexes/rolling-index-deployment.mdx#why-rolling-index-deployment) - * [How Does It Work](../indexes/rolling-index-deployment.mdx#how-does-it-work) - * [The Rolling Procedure](../indexes/rolling-index-deployment.mdx#the-rolling-procedure) - * [Deployment Concurrency and Order](../indexes/rolling-index-deployment.mdx#deployment-concurrency-and-order) - * [Setting Indexing Deployment Mode](../indexes/rolling-index-deployment.mdx#setting-indexing-deployment-mode) - * [Server-Wide Deployment Mode](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) - * [Database Deployment Mode](../indexes/rolling-index-deployment.mdx#database-deployment-mode) - * [Deployment Mode in an Index Definition](../indexes/rolling-index-deployment.mdx#deployment-mode-in-an-index-definition) + * [Why Rolling Index Deployment](#why-rolling-index-deployment) + * [How Does It Work](#how-does-it-work) + * [The Rolling Procedure](#the-rolling-procedure) + * [Deployment Concurrency and Order](#deployment-concurrency-and-order) + * [Setting Indexing Deployment Mode](#setting-indexing-deployment-mode) + * [Server-Wide Deployment Mode](#server-wide-deployment-mode) + * [Database Deployment Mode](#database-deployment-mode) + * [Deployment Mode in an Index Definition](#deployment-mode-in-an-index-definition) ## Why Rolling Index Deployment @@ -104,7 +104,7 @@ Nodes are assigned with the indexing of each database in a linear order, one nod Enable or disable rolling for a specific database using database configuration keys. Setting these properties overrides the -[Server-Wide](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) default. +[Server-Wide](#server-wide-deployment-mode) default. * From Studio: @@ -132,8 +132,8 @@ Setting these properties overrides the ### Deployment Mode in an Index Definition Enable or disable rolling for a specific index using the index-definition `DeploymentMode` property. -Setting this property overrides [server-wide](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) -and [database](../indexes/rolling-index-deployment.mdx#database-deployment-mode) settings configuration. +Setting this property overrides [server-wide](#server-wide-deployment-mode) +and [database](#database-deployment-mode) settings configuration. * `DeploymentMode = IndexDeploymentMode.Rolling` * `DeploymentMode = IndexDeploymentMode.Parallel` diff --git a/versioned_docs/version-6.2/indexes/search-engine/corax.mdx b/versioned_docs/version-6.2/indexes/search-engine/corax.mdx index 965d3e8e00..c4ff3fdc60 100644 --- a/versioned_docs/version-6.2/indexes/search-engine/corax.mdx +++ b/versioned_docs/version-6.2/indexes/search-engine/corax.mdx @@ -36,21 +36,21 @@ import Panel from '@site/src/components/Panel'; * _Community_, _Developer_, and servers without a license default to **Corax**. * All other license types, such as _Professional_ and _Enterprise_, default to **Lucene**. - Explicitly [selecting the search engine](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) overrides this license-based default. + Explicitly [selecting the search engine](#selecting-the-search-engine) overrides this license-based default. --- * In this article: - * [Selecting the search engine](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) - * [Server wide](../../indexes/search-engine/corax.mdx#select-search-engine-server-wide) - * [Per database](../../indexes/search-engine/corax.mdx#select-search-engine-per-database) - * [Per static index](../../indexes/search-engine/corax.mdx#select-search-engine-per-static-index) - * [Unsupported features](../../indexes/search-engine/corax.mdx#unsupported-features) - * [Handling complex JSON objects](../../indexes/search-engine/corax.mdx#handling-complex-json-objects) - * [Compound fields](../../indexes/search-engine/corax.mdx#compound-fields) - * [Limits](../../indexes/search-engine/corax.mdx#limits) - * [Index training: Compression dictionaries](../../indexes/search-engine/corax.mdx#index-training-compression-dictionaries) - * [Configuration options](../../indexes/search-engine/corax.mdx#configuration-options) + * [Selecting the search engine](#selecting-the-search-engine) + * [Server wide](#select-search-engine-server-wide) + * [Per database](#select-search-engine-per-database) + * [Per static index](#select-search-engine-per-static-index) + * [Unsupported features](#unsupported-features) + * [Handling complex JSON objects](#handling-complex-json-objects) + * [Compound fields](#compound-fields) + * [Limits](#limits) + * [Index training: Compression dictionaries](#index-training-compression-dictionaries) + * [Configuration options](#configuration-options) @@ -58,11 +58,11 @@ import Panel from '@site/src/components/Panel'; You can select the search engine at the following scopes: - * [Server-wide](../../indexes/search-engine/corax.mdx#select-search-engine-server-wide), + * [Server-wide](#select-search-engine-server-wide), for all databases hosted by the server. - * [Per database](../../indexes/search-engine/corax.mdx#select-search-engine-per-database), + * [Per database](#select-search-engine-per-database), overriding the server-wide setting for a specific database. - * [Per static index](../../indexes/search-engine/corax.mdx#select-search-engine-per-static-index), + * [Per static index](#select-search-engine-per-static-index), overriding the server-wide and database-level settings for a specific static index. Per-index search engine selection is available only for **static** indexes. @@ -74,7 +74,7 @@ Use these configuration options to select the search engine: * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) Selects either `Lucene` or `Corax` for **static indexes**. This option can be set **server-wide**, **per database**, or **per index**. - * For additional Corax configuration options, see [Configuration options](../../indexes/search-engine/corax.mdx#configuration-options). + * For additional Corax configuration options, see [Configuration options](#configuration-options). --- @@ -212,7 +212,7 @@ The following Corax limitations currently apply. #### Complex JSON properties: Complex JSON properties cannot currently be indexed and searched by Corax. -Read more about this in [Handling complex JSON objects](../../indexes/search-engine/corax.mdx#handling-complex-json-objects) below. +Read more about this in [Handling complex JSON objects](#handling-complex-json-objects) below. #### Unsupported `where` methods: @@ -277,14 +277,14 @@ but `Location` itself is not a simple searchable value. * **Corax** does not support indexing the whole complex JSON object as a single text value, because indexing an entire object as text is usually not useful for search. The exact behavior depends on whether the index is an auto-index or a static index; - see [How Corax handles complex fields while indexing](../../indexes/search-engine/corax.mdx#how-corax-handles-complex-fields-while-indexing) below. + see [How Corax handles complex fields while indexing](#how-corax-handles-complex-fields-while-indexing) below. To work with complex objects, use one of the following approaches: - 1. [Index simple properties from the object](../../indexes/search-engine/corax.mdx#1-index-simple-properties-from-the-object) - 2. [Store the complex field for projection only](../../indexes/search-engine/corax.mdx#2-store-the-complex-field-for-projection-only) - 3. [Serialize the complex object explicitly](../../indexes/search-engine/corax.mdx#3-serialize-the-complex-object-explicitly) - 4. [Use Lucene to index the whole object as JSON text](../../indexes/search-engine/corax.mdx#4-use-lucene-to-index-the-whole-object-as-json-text) + 1. [Index simple properties from the object](#1-index-simple-properties-from-the-object) + 2. [Store the complex field for projection only](#2-store-the-complex-field-for-projection-only) + 3. [Serialize the complex object explicitly](#3-serialize-the-complex-object-explicitly) + 4. [Use Lucene to index the whole object as JSON text](#4-use-lucene-to-index-the-whole-object-as-json-text) --- @@ -661,7 +661,7 @@ The index-fields and their terms are visible in the "Terms view": * Compound fields have additional constraints, including exactly **2 fields** per compound field and a **255-byte limit** per participating field value. - Learn more in [Compound fields: Constraints and value limits](../../indexes/search-engine/corax.mdx#constraints-and-value-limits). + Learn more in [Compound fields: Constraints and value limits](#constraints-and-value-limits). diff --git a/versioned_docs/version-6.2/integrations/akka.net-persistence/events-and-snapshots.mdx b/versioned_docs/version-6.2/integrations/akka.net-persistence/events-and-snapshots.mdx index 3b9f377d96..6ad999dfce 100644 --- a/versioned_docs/version-6.2/integrations/akka.net-persistence/events-and-snapshots.mdx +++ b/versioned_docs/version-6.2/integrations/akka.net-persistence/events-and-snapshots.mdx @@ -29,11 +29,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; see [Integrating with Akka.NET persistence](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx). * In this page: - * [Storing events](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-events) - * [Storing snapshots](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-snapshots) - * [Storing guidelines](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-guidelines) - * [Global consistency](../../integrations/akka.net-persistence/events-and-snapshots.mdx#global-consistency) - * [Sample application](../../integrations/akka.net-persistence/events-and-snapshots.mdx#sample-application) + * [Storing events](#storing-events) + * [Storing snapshots](#storing-snapshots) + * [Storing guidelines](#storing-guidelines) + * [Global consistency](#global-consistency) + * [Sample application](#sample-application) ## Storing events diff --git a/versioned_docs/version-6.2/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx b/versioned_docs/version-6.2/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx index d608302ebc..0afe429438 100644 --- a/versioned_docs/version-6.2/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx +++ b/versioned_docs/version-6.2/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This article provides guidance on integrating RavenDB with Akka.Persistence. * In this page: - * [Overview](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#overview) - * [Akka.Persistence.RavenDB](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#akkapersistenceravendb) - * [Installing the RavenDB persistence plugin](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#installing-the-ravendb-persistence-plugin) - * [Configuring the RavenDB persistence plugin with HOCON](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuring-the-ravendb-persistence-plugin-with-hocon) - * [Configuration keys](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuration-keys) - * [Configuring the RavenDB persistence plugin with Hosting](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuring-the-ravendb-persistence-plugin-with-hosting) - * [Syntax](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#syntax) + * [Overview](#overview) + * [Akka.Persistence.RavenDB](#akkapersistenceravendb) + * [Installing the RavenDB persistence plugin](#installing-the-ravendb-persistence-plugin) + * [Configuring the RavenDB persistence plugin with HOCON](#configuring-the-ravendb-persistence-plugin-with-hocon) + * [Configuration keys](#configuration-keys) + * [Configuring the RavenDB persistence plugin with Hosting](#configuring-the-ravendb-persistence-plugin-with-hosting) + * [Syntax](#syntax) ## Overview @@ -118,7 +118,7 @@ the configuration provided via Hosting takes precedence and will override the co Provide different values for each store as needed. * The following is a sample HOCON configuration under the `` section. - See the full description of each configuration key [below](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuration-keys). + See the full description of each configuration key [below](#configuration-keys). @@ -254,7 +254,7 @@ Default: `false` * Using Hosting, you can easily set up the RavenDB plugin during your application's startup. * Use method `WithRavenDbPersistence` to configure all relevant parameters. - See the available parameters and method overloads in the syntax section [below](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#syntax). + See the available parameters and method overloads in the syntax section [below](#syntax). * The following example shows a basic configuration using Hosting: diff --git a/versioned_docs/version-6.2/integrations/akka.net-persistence/queries.mdx b/versioned_docs/version-6.2/integrations/akka.net-persistence/queries.mdx index dc6826a5ae..3f67cf9af3 100644 --- a/versioned_docs/version-6.2/integrations/akka.net-persistence/queries.mdx +++ b/versioned_docs/version-6.2/integrations/akka.net-persistence/queries.mdx @@ -22,13 +22,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; Just include `Akka.Persistence.RavenDb.Query` in your application. * In this page: - * [Interface types](../../integrations/akka.net-persistence/queries.mdx#interface-types) - * [Supported interfaces](../../integrations/akka.net-persistence/queries.mdx#supported-interfaces) - * [IPersistenceIdsQuery & ICurrentPersistenceIdsQuery](../../integrations/akka.net-persistence/queries.mdx#ipersistenceidsquery--icurrentpersistenceidsquery) - * [IEventsByPersistenceIdQuery & ICurrentEventsByPersistenceIdQuery](../../integrations/akka.net-persistence/queries.mdx#ieventsbypersistenceidquery--icurrenteventsbypersistenceidquery) - * [IEventsByTagQuery & ICurrentEventsByTagQuery](../../integrations/akka.net-persistence/queries.mdx#ieventsbytagquery--icurrenteventsbytagquery) - * [IAllEventsQuery & ICurrentAllEventsQuery](../../integrations/akka.net-persistence/queries.mdx#ialleventsquery--icurrentalleventsquery) - * [Inner implementation details](../../integrations/akka.net-persistence/queries.mdx#inner-implementation-details) + * [Interface types](#interface-types) + * [Supported interfaces](#supported-interfaces) + * [IPersistenceIdsQuery & ICurrentPersistenceIdsQuery](#ipersistenceidsquery--icurrentpersistenceidsquery) + * [IEventsByPersistenceIdQuery & ICurrentEventsByPersistenceIdQuery](#ieventsbypersistenceidquery--icurrenteventsbypersistenceidquery) + * [IEventsByTagQuery & ICurrentEventsByTagQuery](#ieventsbytagquery--icurrenteventsbytagquery) + * [IAllEventsQuery & ICurrentAllEventsQuery](#ialleventsquery--icurrentalleventsquery) + * [Inner implementation details](#inner-implementation-details) ## Interface types diff --git a/versioned_docs/version-6.2/integrations/postgresql-protocol/overview.mdx b/versioned_docs/version-6.2/integrations/postgresql-protocol/overview.mdx index 35c8f00c7b..f4b2b26a73 100644 --- a/versioned_docs/version-6.2/integrations/postgresql-protocol/overview.mdx +++ b/versioned_docs/version-6.2/integrations/postgresql-protocol/overview.mdx @@ -27,11 +27,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Enabling PostgreSQL support](../../integrations/postgresql-protocol/overview.mdx#enabling-postgresql-support) - * [License](../../integrations/postgresql-protocol/overview.mdx#license) - * [Settings](../../integrations/postgresql-protocol/overview.mdx#settings) - * [PostgreSQL Port](../../integrations/postgresql-protocol/overview.mdx#postgresql-port) - * [Security](../../integrations/postgresql-protocol/overview.mdx#security) + * [Enabling PostgreSQL support](#enabling-postgresql-support) + * [License](#license) + * [Settings](#settings) + * [PostgreSQL Port](#postgresql-port) + * [Security](#security) ## Enabling PostgreSQL support diff --git a/versioned_docs/version-6.2/integrations/postgresql-protocol/power-bi.mdx b/versioned_docs/version-6.2/integrations/postgresql-protocol/power-bi.mdx index 2ff17bd572..8663471d67 100644 --- a/versioned_docs/version-6.2/integrations/postgresql-protocol/power-bi.mdx +++ b/versioned_docs/version-6.2/integrations/postgresql-protocol/power-bi.mdx @@ -25,10 +25,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; must explicitly enable **Power BI** Support. * In this page: - * [Using RavenDB From Power BI Desktop](../../integrations/postgresql-protocol/power-bi.mdx#using-ravendb-from-power-bi-desktop) - * [Connect to RavenDB](../../integrations/postgresql-protocol/power-bi.mdx#connect-to-ravendb) - * [Retrieve Collections Data](../../integrations/postgresql-protocol/power-bi.mdx#retrieve-collections-data) - * [Query RavenDB Using RQL](../../integrations/postgresql-protocol/power-bi.mdx#query-ravendb-using-rql) + * [Using RavenDB From Power BI Desktop](#using-ravendb-from-power-bi-desktop) + * [Connect to RavenDB](#connect-to-ravendb) + * [Retrieve Collections Data](#retrieve-collections-data) + * [Query RavenDB Using RQL](#query-ravendb-using-rql) ## Using RavenDB From Power BI Desktop diff --git a/versioned_docs/version-6.2/integrations/terraform.mdx b/versioned_docs/version-6.2/integrations/terraform.mdx index 12bee81d1f..0842bc389c 100644 --- a/versioned_docs/version-6.2/integrations/terraform.mdx +++ b/versioned_docs/version-6.2/integrations/terraform.mdx @@ -29,13 +29,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; and concisely and can always be used to review and easily modify it. * In this page: - * [Prerequisites](../integrations/terraform.mdx#prerequisites) - * [Prepare Terraform Configuration](../integrations/terraform.mdx#prepare-terraform-configuration) - * [Provider](../integrations/terraform.mdx#provider) - * [Terraform Local Parameters](../integrations/terraform.mdx#terraform-local-parameters) - * [RavenDB Resource](../integrations/terraform.mdx#ravendb-resource) - * [Terraform Output Values](../integrations/terraform.mdx#terraform-output-values) - * [Apply Terraform Configuration](../integrations/terraform.mdx#apply-terraform-configuration) + * [Prerequisites](#prerequisites) + * [Prepare Terraform Configuration](#prepare-terraform-configuration) + * [Provider](#provider) + * [Terraform Local Parameters](#terraform-local-parameters) + * [RavenDB Resource](#ravendb-resource) + * [Terraform Output Values](#terraform-output-values) + * [Apply Terraform Configuration](#apply-terraform-configuration) ## Prerequisites @@ -45,7 +45,7 @@ To deploy RavenDB using Terraform, you need: * Find [here](https://ravendb.net/buy) what features are supported by each RavenDB license, and acquire the product that suits your needs. * The license you acquire will be provided to RavenDB via the - [Terraform configuration file](../integrations/terraform.mdx#prepare-terraform-configuration) + [Terraform configuration file](#prepare-terraform-configuration) to validate your product and determine which of its features would be enabled. * **Hosts** @@ -58,7 +58,7 @@ To deploy RavenDB using Terraform, you need: * **Terraform Configuration File** * Learn [here](https://www.terraform.io/docs/language/index.html) the basics of Terraform's configuration language. - * Read [below](../integrations/terraform.mdx#prepare-terraform-configuration) + * Read [below](#prepare-terraform-configuration) how to set the configuration file to provision RavenDB. * **Terraform Application** @@ -92,7 +92,7 @@ Use the `provider` object to **set RavenDB as the provider**. Note that the **version number** relates to the RavenDB Terraform Provider version, **not** to the RavenDB Product version (that is -defined in the [resource](../integrations/terraform.mdx#ravendb-resource) +defined in the [resource](#ravendb-resource) block's **package** field). diff --git a/versioned_docs/version-6.2/migration/client-api/client-breaking-changes.mdx b/versioned_docs/version-6.2/migration/client-api/client-breaking-changes.mdx index 80f571c212..56a89c5670 100644 --- a/versioned_docs/version-6.2/migration/client-api/client-breaking-changes.mdx +++ b/versioned_docs/version-6.2/migration/client-api/client-breaking-changes.mdx @@ -18,12 +18,12 @@ In RavenDB `6.2.x`, they are either unavailable or their behavior is inconsisten with their behavior in previous versions. * In this page: - * [`CounterBatchOperation` default increment Delta is 1](../../migration/client-api/client-breaking-changes.mdx#counterbatchoperation-default-increment-delta-is-1) - * [CmpXchg item can only be created with an index of 0](../../migration/client-api/client-breaking-changes.mdx#cmpxchg-item-can-only-be-created-with-an-index-of-0) + * [`CounterBatchOperation` default increment Delta is 1](#counterbatchoperation-default-increment-delta-is-1) + * [CmpXchg item can only be created with an index of 0](#cmpxchg-item-can-only-be-created-with-an-index-of-0) * [Dynamic Linq query cannot apply `.Any` with logical AND (`&&`)](../../migration/client-api/client-breaking-changes.mdx#dynamic-linq-query-cannot-apply-any-with-logical-and-()) - * [`LoadDocument` must be provided with a collection name string](../../migration/client-api/client-breaking-changes.mdx#loaddocument-must-be-provided-with-a-collection-name-string) - * [Tracking operations using the Changes API now requires Node Tag](../../migration/client-api/client-breaking-changes.mdx#tracking-operations-using-the-changes-api-now-requires-node-tag) - * [Consistency in `null` handling](../../migration/client-api/client-breaking-changes.mdx#consistency-in-null-handling) + * [`LoadDocument` must be provided with a collection name string](#loaddocument-must-be-provided-with-a-collection-name-string) + * [Tracking operations using the Changes API now requires Node Tag](#tracking-operations-using-the-changes-api-now-requires-node-tag) + * [Consistency in `null` handling](#consistency-in-null-handling) diff --git a/versioned_docs/version-6.2/migration/embedded/testdriver-breaking-changes.mdx b/versioned_docs/version-6.2/migration/embedded/testdriver-breaking-changes.mdx index fabb1442ea..392917fa2e 100644 --- a/versioned_docs/version-6.2/migration/embedded/testdriver-breaking-changes.mdx +++ b/versioned_docs/version-6.2/migration/embedded/testdriver-breaking-changes.mdx @@ -18,7 +18,7 @@ In RavenDB `6.2.x`, they are either unavailable or their behavior is inconsisten with their behavior in previous versions. * In this page: - * [Unlicensed TestDriver throws an exception](../../migration/embedded/testdriver-breaking-changes.mdx#unlicensed-testdriver-throws-an-exception) + * [Unlicensed TestDriver throws an exception](#unlicensed-testdriver-throws-an-exception) ## Unlicensed TestDriver throws an exception diff --git a/versioned_docs/version-6.2/migration/server/data-migration.mdx b/versioned_docs/version-6.2/migration/server/data-migration.mdx index bddc925fc5..f4c0073af3 100644 --- a/versioned_docs/version-6.2/migration/server/data-migration.mdx +++ b/versioned_docs/version-6.2/migration/server/data-migration.mdx @@ -15,10 +15,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Migration from RavenDB 5.x to 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-5x-to-6x) - * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-4x-to-ravendb-5x-and-6x) - * [Migration from RavenDB 3.x](../../migration/server/data-migration.mdx#migration-from-ravendb-3x) - * [Migrating data into a sharded database](../../migration/server/data-migration.mdx#migrating-data-into-a-sharded-database) + * [Migration from RavenDB 5.x to 6.x](#migration-from-ravendb-5x-to-6x) + * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](#migration-from-ravendb-4x-to-ravendb-5x-and-6x) + * [Migration from RavenDB 3.x](#migration-from-ravendb-3x) + * [Migrating data into a sharded database](#migrating-data-into-a-sharded-database) ## Migration from RavenDB 5.x to 6.x diff --git a/versioned_docs/version-6.2/migration/server/docker.mdx b/versioned_docs/version-6.2/migration/server/docker.mdx index aa318f8bb2..b1755540e5 100644 --- a/versioned_docs/version-6.2/migration/server/docker.mdx +++ b/versioned_docs/version-6.2/migration/server/docker.mdx @@ -23,11 +23,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Read [here](../../start/containers/image-usage.mdx) more about running a RavenDB Docker image. * In this article: - * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-6-0-and-up) - * [Migrating To RavenDB `6.0` And Up](../../migration/server/docker.mdx#migrating-to-ravendb-6-0-and-up) - * [Permit the `ravendb` user to access the mounted data directory](../../migration/server/docker.mdx#permit-the-ravendb-user-to-access-the-mounted-data-directory) - * [Customize the UID/GID of the RavenDB data directory owner](../../migration/server/docker.mdx#customize-the-uidgid-of-the-ravendb-data-directory-owner) - * [Migrate files and data](../../migration/server/docker.mdx#migrate-files-and-data) + * [Changes Made In RavenDB `6.0` And Up](#changes-made-in-ravendb-6-0-and-up) + * [Migrating To RavenDB `6.0` And Up](#migrating-to-ravendb-6-0-and-up) + * [Permit the `ravendb` user to access the mounted data directory](#permit-the-ravendb-user-to-access-the-mounted-data-directory) + * [Customize the UID/GID of the RavenDB data directory owner](#customize-the-uidgid-of-the-ravendb-data-directory-owner) + * [Migrate files and data](#migrate-files-and-data) diff --git a/versioned_docs/version-6.2/migration/server/server-breaking-changes.mdx b/versioned_docs/version-6.2/migration/server/server-breaking-changes.mdx index 13656c0e75..a7c97968f4 100644 --- a/versioned_docs/version-6.2/migration/server/server-breaking-changes.mdx +++ b/versioned_docs/version-6.2/migration/server/server-breaking-changes.mdx @@ -18,9 +18,9 @@ In RavenDB `6.2.x`, they are either unavailable or their behavior is inconsisten with their behavior in previous versions. * In this page: - * [MSSQL connection string requires an Encrypt property](../../migration/server/server-breaking-changes.mdx#mssql-connection-string-requires-an-encrypt-property) - * [Corax handling of complex JSON objects in static indexes is configurable](../../migration/server/server-breaking-changes.mdx#corax-handling-of-complex-json-objects-in-static-indexes-is-configurable) - * [Customizable identifier parts separator](../../migration/server/server-breaking-changes.mdx#customizable-identifier-parts-separator) + * [MSSQL connection string requires an Encrypt property](#mssql-connection-string-requires-an-encrypt-property) + * [Corax handling of complex JSON objects in static indexes is configurable](#corax-handling-of-complex-json-objects-in-static-indexes-is-configurable) + * [Customizable identifier parts separator](#customizable-identifier-parts-separator) diff --git a/versioned_docs/version-6.2/server/administration/monitoring/mib-generation.mdx b/versioned_docs/version-6.2/server/administration/monitoring/mib-generation.mdx index aba1f4aaf7..753777aa7f 100644 --- a/versioned_docs/version-6.2/server/administration/monitoring/mib-generation.mdx +++ b/versioned_docs/version-6.2/server/administration/monitoring/mib-generation.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The created MIB can be used by monitoring tools to extract RavenDB metrics via SNMP. * In this page: - * [Generating a MIB](../../../server/administration/monitoring/mib-generation.mdx#generating-a-mib) - * [MIB generation endpoint](../../../server/administration/monitoring/mib-generation.mdx#mib-generation-endpoint) - * [Fine-tune the OIDs list](../../../server/administration/monitoring/mib-generation.mdx#fine-tune-the-oids-list) + * [Generating a MIB](#generating-a-mib) + * [MIB generation endpoint](#mib-generation-endpoint) + * [Fine-tune the OIDs list](#fine-tune-the-oids-list) ## Generating a MIB diff --git a/versioned_docs/version-6.2/server/administration/monitoring/open-telemetry.mdx b/versioned_docs/version-6.2/server/administration/monitoring/open-telemetry.mdx index 6388725524..f58161f4ad 100644 --- a/versioned_docs/version-6.2/server/administration/monitoring/open-telemetry.mdx +++ b/versioned_docs/version-6.2/server/administration/monitoring/open-telemetry.mdx @@ -22,22 +22,22 @@ import LanguageContent from "@site/src/components/LanguageContent"; allowing seamless data collection and analysis by an OpenTelemetry retriever. * In addition, an OpenTelemetry collector can retrieve data from RavenDB's [Prometheus](../../../server/administration/monitoring/prometheus.mdx) endpoint. - Learn more [below](../../../server/administration/monitoring/open-telemetry.mdx#retrieve-data-from-prometheus). + Learn more [below](#retrieve-data-from-prometheus). * OpenTelemetry support is provided for RavenDB instances both on-premises and in the cloud. * In this article: - * [Enabling OpenTelemetry in RavenDB](../../../server/administration/monitoring/open-telemetry.mdx#enabling-opentelemetry-in-ravendb) - * [RavenDB OpenTelemetry meters](../../../server/administration/monitoring/open-telemetry.mdx#ravendb-opentelemetry-meters) - * [Server identification in metrics](../../../server/administration/monitoring/open-telemetry.mdx#server-identification-in-metrics) - * [Service name and namespace](../../../server/administration/monitoring/open-telemetry.mdx#service-name-and-namespace) - * [The metric instruments](../../../server/administration/monitoring/open-telemetry.mdx#the-metric-instruments) - * [Metrics export options](../../../server/administration/monitoring/open-telemetry.mdx#metrics-export-options) - * [Console](../../../server/administration/monitoring/open-telemetry.mdx#console) - * [OpenTelemetry Protocol](../../../server/administration/monitoring/open-telemetry.mdx#opentelemetry-protocol) - * [Configuring the OpenTelemetry Collector](../../../server/administration/monitoring/open-telemetry.mdx#configuring-the-opentelemetry-collector) - * [Receive data via OLTP ](../../../server/administration/monitoring/open-telemetry.mdx#receive-data-via-otlp) - * [Retrieve data from Prometheus](../../../server/administration/monitoring/open-telemetry.mdx#retrieve-data-from-prometheus) + * [Enabling OpenTelemetry in RavenDB](#enabling-opentelemetry-in-ravendb) + * [RavenDB OpenTelemetry meters](#ravendb-opentelemetry-meters) + * [Server identification in metrics](#server-identification-in-metrics) + * [Service name and namespace](#service-name-and-namespace) + * [The metric instruments](#the-metric-instruments) + * [Metrics export options](#metrics-export-options) + * [Console](#console) + * [OpenTelemetry Protocol](#opentelemetry-protocol) + * [Configuring the OpenTelemetry Collector](#configuring-the-opentelemetry-collector) + * [Receive data via OLTP ](#receive-data-via-otlp) + * [Retrieve data from Prometheus](#retrieve-data-from-prometheus) @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## RavenDB OpenTelemetry meters -Each meter listed below groups similar or related [metric instruments](../../../server/administration/monitoring/open-telemetry.mdx#the-metric-instruments). +Each meter listed below groups similar or related [metric instruments](#the-metric-instruments). Each metric instrument observes some metric value. Only the most commonly used meters are enabled by default. @@ -304,7 +304,7 @@ RavenDB offers two options for exporting metrics: | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.ExportProcessorType](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolexportprocessortype) | Export processor type | Simple / Batch | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Headers](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolheaders) | Custom headers | string | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Protocol](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolprotocol) | Defines the transport protocol that OpenTelemetry Protocol should use to send data. | gRPC / HttpProtobuf | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](../../../server/administration/monitoring/open-telemetry.mdx#configure-endpoint). | string | +| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](#configure-endpoint). | string | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) | Timeout | int | @@ -312,7 +312,7 @@ RavenDB offers two options for exporting metrics: __Configuring the OpenTelemetry Protocol endpoint__: -The defined endpoint must correspond to the endpoint [configured on the collector](../../../server/administration/monitoring/open-telemetry.mdx#configuring-the-opentelemetry-collector) for receiving metrics data. +The defined endpoint must correspond to the endpoint [configured on the collector](#configuring-the-opentelemetry-collector) for receiving metrics data. The endpoint format should match the transport protocol you are using:
diff --git a/versioned_docs/version-6.2/server/administration/monitoring/prometheus.mdx b/versioned_docs/version-6.2/server/administration/monitoring/prometheus.mdx index eb588d2e37..f24ea1beda 100644 --- a/versioned_docs/version-6.2/server/administration/monitoring/prometheus.mdx +++ b/versioned_docs/version-6.2/server/administration/monitoring/prometheus.mdx @@ -23,12 +23,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A Prometheus endpoint is provided by RavenDB instances both on-premise and on the cloud. * In this page: - * [Prometheus](../../../server/administration/monitoring/prometheus.mdx#prometheus) - * [RavenDB Prometheus Endpoint](../../../server/administration/monitoring/prometheus.mdx#ravendb-prometheus-endpoint) - * [Omit or Include Selected Metrics](../../../server/administration/monitoring/prometheus.mdx#omit-or-include-selected-metrics) - * [Metrics Provided by the Prometheus Endpoint](../../../server/administration/monitoring/prometheus.mdx#metrics-provided-by-the-prometheus-endpoint) - * [Using the RavenDB Endpoint by a Prometheus Server](../../../server/administration/monitoring/prometheus.mdx#using-the-ravendb-endpoint-by-a-prometheus-server) - * [Fetching Additional RavenDB Information](../../../server/administration/monitoring/prometheus.mdx#fetching-additional-ravendb-information) + * [Prometheus](#prometheus) + * [RavenDB Prometheus Endpoint](#ravendb-prometheus-endpoint) + * [Omit or Include Selected Metrics](#omit-or-include-selected-metrics) + * [Metrics Provided by the Prometheus Endpoint](#metrics-provided-by-the-prometheus-endpoint) + * [Using the RavenDB Endpoint by a Prometheus Server](#using-the-ravendb-endpoint-by-a-prometheus-server) + * [Fetching Additional RavenDB Information](#fetching-additional-ravendb-information) ## Prometheus @@ -50,7 +50,7 @@ E.g. [http://live-test.ravendb.net/admin/monitoring/v1/prometheus](http://live-t * As prometheus handles only numeric values, the endpoint outputs all values as numbers, providing legends that explain what the numbers mean. - Metrics values are also explained in the [table below](../../../server/administration/monitoring/prometheus.mdx#metrics-provided-by-the-prometheus-endpoint). + Metrics values are also explained in the [table below](#metrics-provided-by-the-prometheus-endpoint). ## Omit or Include Selected Metrics diff --git a/versioned_docs/version-6.2/server/administration/monitoring/telegraf.mdx b/versioned_docs/version-6.2/server/administration/monitoring/telegraf.mdx index aa685e1bf0..b63c759aae 100644 --- a/versioned_docs/version-6.2/server/administration/monitoring/telegraf.mdx +++ b/versioned_docs/version-6.2/server/administration/monitoring/telegraf.mdx @@ -22,9 +22,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and displayed as live graphs using [Grafana](https://grafana.com/). * In this page: - * [Telegraf](../../../server/administration/monitoring/telegraf.mdx#telegraf) - * [Monitoring Endpoints](../../../server/administration/monitoring/telegraf.mdx#monitoring-endpoints) - * [JSON Fields Returned by the Endpoints](../../../server/administration/monitoring/telegraf.mdx#json-fields-returned-by-the-endpoints) + * [Telegraf](#telegraf) + * [Monitoring Endpoints](#monitoring-endpoints) + * [JSON Fields Returned by the Endpoints](#json-fields-returned-by-the-endpoints) ## Telegraf diff --git a/versioned_docs/version-6.2/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-6.2/server/administration/snmp/setup-zabbix.mdx index ab9d93f565..9175413df2 100644 --- a/versioned_docs/version-6.2/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-6.2/server/administration/snmp/setup-zabbix.mdx @@ -38,16 +38,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; see [Set up Zabbix monitoring for RavenDB Cloud](https://docs.ravendb.net/guides/zabbix-setup-guide). * In this article: - * [Prerequisites](./setup-zabbix.mdx#prerequisites) - * [Importing the template](./setup-zabbix.mdx#importing-the-template) - * [Creating a host](./setup-zabbix.mdx#creating-a-host) - * [Configuring the SNMP interface](./setup-zabbix.mdx#configuring-the-snmp-interface) - * [Overriding the memory threshold macros](./setup-zabbix.mdx#overriding-the-memory-threshold-macros) - * [Confirming Zabbix is collecting values](./setup-zabbix.mdx#confirming-zabbix-is-collecting-values) - * [Triggers](./setup-zabbix.mdx#triggers) - * [Triggers included with the template](./setup-zabbix.mdx#triggers-included-with-the-template) - * [Adding a custom trigger](./setup-zabbix.mdx#adding-a-custom-trigger) - * [Setting up notifications](./setup-zabbix.mdx#setting-up-notifications) + * [Prerequisites](#prerequisites) + * [Importing the template](#importing-the-template) + * [Creating a host](#creating-a-host) + * [Configuring the SNMP interface](#configuring-the-snmp-interface) + * [Overriding the memory threshold macros](#overriding-the-memory-threshold-macros) + * [Confirming Zabbix is collecting values](#confirming-zabbix-is-collecting-values) + * [Triggers](#triggers) + * [Triggers included with the template](#triggers-included-with-the-template) + * [Adding a custom trigger](#adding-a-custom-trigger) + * [Setting up notifications](#setting-up-notifications) diff --git a/versioned_docs/version-6.2/server/administration/snmp/snmp-overview.mdx b/versioned_docs/version-6.2/server/administration/snmp/snmp-overview.mdx index 1076304d3b..67e96d639e 100644 --- a/versioned_docs/version-6.2/server/administration/snmp/snmp-overview.mdx +++ b/versioned_docs/version-6.2/server/administration/snmp/snmp-overview.mdx @@ -23,14 +23,14 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov * This page explains how to use SNMP to monitor RavenDB and what metrics can be accessed. * In this page: - * [Overview](../../../server/administration/snmp/snmp-overview.mdx#overview) - * [Enabling SNMP in RavenDB](../../../server/administration/snmp/snmp-overview.mdx#enabling-snmp-in-ravendb) - * [SNMP Configuration options](../../../server/administration/snmp/snmp-overview.mdx#snmp-configuration-options) - * [The Metrics](../../../server/administration/snmp/snmp-overview.mdx#the-metrics) - * [Access metrics via monitoring tools](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-monitoring-tools) - * [Access metrics via SNMP agents](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-snmp-agents) - * [Access metrics via HTTP](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-http) - * [List of OIDs](../../../server/administration/snmp/snmp-overview.mdx#list-of-oids) + * [Overview](#overview) + * [Enabling SNMP in RavenDB](#enabling-snmp-in-ravendb) + * [SNMP Configuration options](#snmp-configuration-options) + * [The Metrics](#the-metrics) + * [Access metrics via monitoring tools](#access-metrics-via-monitoring-tools) + * [Access metrics via SNMP agents](#access-metrics-via-snmp-agents) + * [Access metrics via HTTP](#access-metrics-via-http) + * [List of OIDs](#list-of-oids) ## Overview @@ -43,7 +43,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov * In RavenDB we have support for SNMP which allows monitoring tools like [Zabbix](https://www.zabbix.com), [PRTG](https://www.paessler.com/prtg), and [Datadog](https://www.datadoghq.com/) direct access to the - internal details of RavenDB. We expose a long [list of metrics](../../../server/administration/snmp/snmp-overview.mdx#list-of-oids): CPU and memory usage, server total requests, + internal details of RavenDB. We expose a long [list of metrics](#list-of-oids): CPU and memory usage, server total requests, the loaded databases, and database-specific metrics like the number of indexed items per second, document writes per second, storage space each database takes, and more. @@ -142,7 +142,7 @@ There are several configurable SNMP properties in RavenDB: Each metric has a unique object identifier (OID) and can be accessed individually. * The most basic SNMP commands are `snmpget`, `snmpset` and `snmpwalk`. - For example, you can execute the following _snmpget_ commands to retrieve the server's [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13). + For example, you can execute the following _snmpget_ commands to retrieve the server's [up-time metric](#13). ##### For SNMPv2c: @@ -186,7 +186,7 @@ iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73 * An individual OID value can be retrieved via HTTP `GET` endpoint: `/monitoring/snmp?oid=` -* For example, a cURL request for the server [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13): +* For example, a cURL request for the server [up-time metric](#13): @@ -203,7 +203,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 * Multiple OID values can be retrieved by making either a `GET` or a `POST` request to the following HTTP endpoint: `/monitoring/snmp/bulk` -* For example, cURL requests for the server [managed memory](../../../server/administration/snmp/snmp-overview.mdx#167) and [unmanaged memory](../../../server/administration/snmp/snmp-overview.mdx#168) metrics: +* For example, cURL requests for the server [managed memory](#167) and [unmanaged memory](#168) metrics: @@ -309,7 +309,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 | 1.6.11.`X`.14 | GC info for `X`.
Gets the total available memory (in MB) for the garbage collector to use when the last garbage collection occurred. | | 1.6.11.`X`.15 | GC info for `X`.
Gets the total committed MB of the managed heap. | | 1.6.11.`X`.16.3 | GC info for `X`.
Gets the large object heap size (in MB) after the last garbage collection of given kind occurred. | -| 1.6.12.{0} | Monitor [/proc/meminfo/](https://man7.org/linux/man-pages/man5/proc.5.html) metrics (unix/linux).
The description of each metric is available via endpoint `/monitoring/snmp/oids`.
See [Get all OIDs](../../../server/administration/snmp/snmp-overview.mdx#getalloids). | +| 1.6.12.{0} | Monitor [/proc/meminfo/](https://man7.org/linux/man-pages/man5/proc.5.html) metrics (unix/linux).
The description of each metric is available via endpoint `/monitoring/snmp/oids`.
See [Get all OIDs](#getalloids). | | 1.6.13 | Available memory for processing (in MB) | | 1.7.1 | Number of concurrent requests | | 1.7.2 | Total number of requests since server startup | diff --git a/versioned_docs/version-6.2/server/clustering/cluster-api.mdx b/versioned_docs/version-6.2/server/clustering/cluster-api.mdx index 4136070c86..5b45948293 100644 --- a/versioned_docs/version-6.2/server/clustering/cluster-api.mdx +++ b/versioned_docs/version-6.2/server/clustering/cluster-api.mdx @@ -19,13 +19,13 @@ All cluster operations are available through the GUI. However, sometimes you'd w In this section we will demonstrate of how to perform certain cluster operations programmatically using the REST API. In the first example we will show how to make a secure call using PowerShell, cURL and the RavenDB C# Client. The rest of the examples are cURL only. -- [Add node to the cluster](../../server/clustering/cluster-api.mdx#add-node-to-the-cluster) -- [Delete node from the cluster](../../server/clustering/cluster-api.mdx#delete-node-from-the-cluster) -- [Promote a watcher node](../../server/clustering/cluster-api.mdx#promote-a-node) -- [Demote a watcher node](../../server/clustering/cluster-api.mdx#demote-a-node) -- [Force elections](../../server/clustering/cluster-api.mdx#force-elections) -- [Force timeout](../../server/clustering/cluster-api.mdx#force-timeout) -- [Bootstrap the cluster](../../server/clustering/cluster-api.mdx#bootstrap-cluster) +- [Add node to the cluster](#add-node-to-the-cluster) +- [Delete node from the cluster](#delete-node-from-the-cluster) +- [Promote a watcher node](#promote-a-node) +- [Demote a watcher node](#demote-a-node) +- [Force elections](#force-elections) +- [Force timeout](#force-timeout) +- [Bootstrap the cluster](#bootstrap-cluster) If authentication is turned on, a client certificate with either `Cluster Admin` or `Operator` [Security Clearance](../../server/security/authorization/security-clearance-and-permissions.mdx) must be supplied, depending on the endpoint. diff --git a/versioned_docs/version-6.2/server/clustering/cluster-best-practice-and-configuration.mdx b/versioned_docs/version-6.2/server/clustering/cluster-best-practice-and-configuration.mdx index dac986e47b..5322a402d4 100644 --- a/versioned_docs/version-6.2/server/clustering/cluster-best-practice-and-configuration.mdx +++ b/versioned_docs/version-6.2/server/clustering/cluster-best-practice-and-configuration.mdx @@ -15,8 +15,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Clusters should have an odd number of at least 3 nodes](../../server/clustering/cluster-best-practice-and-configuration.mdx#clusters-should-have-an-odd-number-of-at-least-3-nodes) - * [Avoid different cluster configurations among the cluster's nodes](../../server/clustering/cluster-best-practice-and-configuration.mdx#avoid-different-cluster-configurations-among-the-clusters-nodes) + * [Clusters should have an odd number of at least 3 nodes](#clusters-should-have-an-odd-number-of-at-least-3-nodes) + * [Avoid different cluster configurations among the cluster's nodes](#avoid-different-cluster-configurations-among-the-clusters-nodes) diff --git a/versioned_docs/version-6.2/server/clustering/cluster-transactions.mdx b/versioned_docs/version-6.2/server/clustering/cluster-transactions.mdx index 5f0b1dd75f..bee5424cbd 100644 --- a/versioned_docs/version-6.2/server/clustering/cluster-transactions.mdx +++ b/versioned_docs/version-6.2/server/clustering/cluster-transactions.mdx @@ -19,12 +19,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Code examples and client API can be found [here](../../client-api/session/saving-changes.mdx#transaction-mode---cluster-wide). * In this page: - * [Why Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#why-cluster-wide-transactions) - * [How Cluster Transactions Work](../../server/clustering/cluster-transactions.mdx#how-cluster-transactions-work) described by the flow of a cluster transaction request example. - * [Cluster Transactions Properties](../../server/clustering/cluster-transactions.mdx#cluster-transactions-properties) - * [Concurrent Cluster-Wide and Single-Node Transactions](../../server/clustering/cluster-transactions.mdx#concurrent-cluster-wide-and-single-node-transactions) - * [Failure Modes in Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#failure-modes-in-cluster-wide-transactions) - * [Debug Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#debug-cluster-wide-transactions) + * [Why Cluster-Wide Transactions](#why-cluster-wide-transactions) + * [How Cluster Transactions Work](#how-cluster-transactions-work) described by the flow of a cluster transaction request example. + * [Cluster Transactions Properties](#cluster-transactions-properties) + * [Concurrent Cluster-Wide and Single-Node Transactions](#concurrent-cluster-wide-and-single-node-transactions) + * [Failure Modes in Cluster-Wide Transactions](#failure-modes-in-cluster-wide-transactions) + * [Debug Cluster-Wide Transactions](#debug-cluster-wide-transactions) ## Why Cluster-Wide Transactions @@ -94,7 +94,7 @@ After having a quorum for the cluster transaction request by raft and a successf of the compare exchange values, the transaction is guaranteed to be executed. Failure during the quorum or the concurrency check will roll back the entire session transaction, while failure during the commit of the documents will halt any further cluster transactions execution on the database -until that failure is remedied (failure mode for the documents commits are described later [here](../../server/clustering/cluster-transactions.mdx#failure-modes-in-cluster-wide-transactions)). +until that failure is remedied (failure mode for the documents commits are described later [here](#failure-modes-in-cluster-wide-transactions)). **Consistency** Consistency is guaranteed on the requested node. The node will complete the request only when the transaction is completed diff --git a/versioned_docs/version-6.2/server/clustering/distribution/cluster-observer.mdx b/versioned_docs/version-6.2/server/clustering/distribution/cluster-observer.mdx index 1856067658..d23ac4d583 100644 --- a/versioned_docs/version-6.2/server/clustering/distribution/cluster-observer.mdx +++ b/versioned_docs/version-6.2/server/clustering/distribution/cluster-observer.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This observer is always running on the [Leader](../../../server/clustering/rachis/cluster-topology.mdx#leader) node. * In this page: - * [Operation flow](../../../server/clustering/distribution/cluster-observer.mdx#operation-flow) - * [Interacting with the Cluster Observer](../../../server/clustering/distribution/cluster-observer.mdx#interacting-with-the-cluster-observer) + * [Operation flow](#operation-flow) + * [Interacting with the Cluster Observer](#interacting-with-the-cluster-observer) ## Operation flow diff --git a/versioned_docs/version-6.2/server/clustering/distribution/distributed-database.mdx b/versioned_docs/version-6.2/server/clustering/distribution/distributed-database.mdx index 903275f53f..acc36acec5 100644 --- a/versioned_docs/version-6.2/server/clustering/distribution/distributed-database.mdx +++ b/versioned_docs/version-6.2/server/clustering/distribution/distributed-database.mdx @@ -14,21 +14,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Distributed Database -* In RavenDB, a database can be replicated across multiple nodes, depending on its [Replication Factor](../../../server/clustering/distribution/distributed-database.mdx#replication-factor). +* In RavenDB, a database can be replicated across multiple nodes, depending on its [Replication Factor](#replication-factor). * A node where a database resides is referred to as a `Database Node`. The group of _Database Nodes_ that assemble the distributed database, is called a [Database Group](../../../studio/database/settings/manage-database-group.mdx). -* Unless [Sharding](../../../server/clustering/distribution/distributed-database.mdx#sharding) is employed, +* Unless [Sharding](#sharding) is employed, each Database Node has a **full copy** of the database, containing **all** the database documents, and indexes them **locally**. This greatly simplifies executing query requests, as there is no need to aggregate data from multiple nodes. * In this page: - * [The Database Record](../../../server/clustering/distribution/distributed-database.mdx#the-database-record) - * [Replication Factor](../../../server/clustering/distribution/distributed-database.mdx#replication-factor) - * [Database Topology](../../../server/clustering/distribution/distributed-database.mdx#database-topology) - * [Dynamic Database Distribution](../../../server/clustering/distribution/distributed-database.mdx#dynamic-database-distribution) - * [Sharding](../../../server/clustering/distribution/distributed-database.mdx#sharding) + * [The Database Record](#the-database-record) + * [Replication Factor](#replication-factor) + * [Database Topology](#database-topology) + * [Dynamic Database Distribution](#dynamic-database-distribution) + * [Sharding](#sharding) ## The Database Record diff --git a/versioned_docs/version-6.2/server/clustering/distribution/highly-available-tasks.mdx b/versioned_docs/version-6.2/server/clustering/distribution/highly-available-tasks.mdx index ceb1ad8c1f..f69017a554 100644 --- a/versioned_docs/version-6.2/server/clustering/distribution/highly-available-tasks.mdx +++ b/versioned_docs/version-6.2/server/clustering/distribution/highly-available-tasks.mdx @@ -20,17 +20,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Updating a `Rehab` or a `Promotable` [Database Node](../../../server/clustering/distribution/distributed-database.mdx#database-topology) * There is no single coordinator handing out tasks to a specific node. - Instaed, each node decides on its own if it is the [Reponsible Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) of the task. + Instaed, each node decides on its own if it is the [Reponsible Node](#responsible-node) of the task. * Each node will re-evaluate its responsibilities with every change made to the [Database Record](../../../client-api/operations/server-wide/create-database.mdx), such as defining a new _index_, configuring or modifying an _Ongoing Task_, any _Database Topology_ change, etc. * In this page: - * [License](../../../server/clustering/distribution/highly-available-tasks.mdx#license) - * [Constraints](../../../server/clustering/distribution/highly-available-tasks.mdx#constraints) - * [Responsible Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) - * [Tasks Relocation](../../../server/clustering/distribution/highly-available-tasks.mdx#tasks-relocation) - * [Pinning a Task](../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) + * [License](#license) + * [Constraints](#constraints) + * [Responsible Node](#responsible-node) + * [Tasks Relocation](#tasks-relocation) + * [Pinning a Task](#pinning-a-task) ## License @@ -49,7 +49,7 @@ to verify whether the Highly Available Tasks feature is activated in your databa * If your license does **not** provide highly available tasks, the responsibilites of a failed node will be resumed when the node returns online. -* Scenarios [below](../../../server/clustering/distribution/highly-available-tasks.mdx#tasks-relocation) +* Scenarios [below](#tasks-relocation) are meant to demonstrate the behavior of a system licensed for highly available tasks. diff --git a/versioned_docs/version-6.2/server/clustering/rachis/cluster-topology.mdx b/versioned_docs/version-6.2/server/clustering/rachis/cluster-topology.mdx index 789d3001bd..c4fac32713 100644 --- a/versioned_docs/version-6.2/server/clustering/rachis/cluster-topology.mdx +++ b/versioned_docs/version-6.2/server/clustering/rachis/cluster-topology.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Clusters are typically composed of any odd number of nodes equal or greater than 3, see [Clusters Best Practice](../../../server/clustering/cluster-best-practice-and-configuration.mdx). * In this page: - * [Fetching the topology](../../../server/clustering/rachis/cluster-topology.mdx#fetching-the-topology) - * [Modifying the topology](../../../server/clustering/rachis/cluster-topology.mdx#modifying-the-topology) - * [Nodes states and types](../../../server/clustering/rachis/cluster-topology.mdx#nodes-states-and-types) - * [Changing node type](../../../server/clustering/rachis/cluster-topology.mdx#changing-node-type) + * [Fetching the topology](#fetching-the-topology) + * [Modifying the topology](#modifying-the-topology) + * [Nodes states and types](#nodes-states-and-types) + * [Changing node type](#changing-node-type) ## Fetching the topology @@ -52,14 +52,14 @@ Optional parameters (for the Add Node endpoint): | Name | Value type | Description | |------------------|--------------|--------------------------------------------------------------------------------------------------------------| | tag | `string` | The node tag. 1-4 uppercase unicode letters.
Default: 'A' - 'Z' assigned by order of addition. | -| watcher | `bool` | Add the node as a [Watcher](../../../server/clustering/rachis/cluster-topology.mdx#watcher).
Default: `false` | +| watcher | `bool` | Add the node as a [Watcher](#watcher).
Default: `false` | | maxUtilizedCores | `uint` | Maximum number of cores that can be assigned to this node.
Default: number of processors. | See the [Cluster API page](../../../server/clustering/cluster-api.mdx) for usage examples. ## Nodes states and types -In Rachis every cluster node has a [state](../../../server/clustering/rachis/cluster-topology.mdx#state) and a [type](../../../server/clustering/rachis/cluster-topology.mdx#type). +In Rachis every cluster node has a [state](#state) and a [type](#type). @@ -72,7 +72,7 @@ and **elect** a new leader when needed. |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Member** | A fully functional voting node in the cluster. | | **Promotable** | A non-voting node.
This is an intermediate stage until node is promoted by the Leader to a Member. | -| **Watcher** | A non-voting node that is still fully managed by the cluster.
Can be assigned with databases and tasks. See more [below](../../../server/clustering/rachis/cluster-topology.mdx#watcher). | +| **Watcher** | A non-voting node that is still fully managed by the cluster.
Can be assigned with databases and tasks. See more [below](#watcher). | @@ -88,7 +88,7 @@ The Rachis state defines the **current role** of the node in the cluster. | **Candidate** | Has no Leader and tries to get elected for leadership. | | **Follower** | Has a Leader and operates normally. | | **Leader-Elect** | Just elected for leadership, but will take office and become the leader only after the dummy `noop` raft command was successfully applied in the cluster. | -| **Leader** | Leader of the cluster. See more [below](../../../server/clustering/rachis/cluster-topology.mdx#leader). | +| **Leader** | Leader of the cluster. See more [below](#leader). | diff --git a/versioned_docs/version-6.2/server/clustering/rachis/consensus-operations.mdx b/versioned_docs/version-6.2/server/clustering/rachis/consensus-operations.mdx index b906754cd4..e9fb539f30 100644 --- a/versioned_docs/version-6.2/server/clustering/rachis/consensus-operations.mdx +++ b/versioned_docs/version-6.2/server/clustering/rachis/consensus-operations.mdx @@ -22,9 +22,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Only after the cluster's approval (majority of nodes ), it will _eventually_ be executed on all cluster nodes. * In this page: - * [Operations that require Consensus](../../../server/clustering/rachis/consensus-operations.mdx#operations-that-require-consensus) - * [Operations that do not require Consensus](../../../server/clustering/rachis/consensus-operations.mdx#operations-that-do-not-require-consensus) - * [Raft Commands Implementation Details](../../../server/clustering/rachis/consensus-operations.mdx#raft-commands-implementation-details) + * [Operations that require Consensus](#operations-that-require-consensus) + * [Operations that do not require Consensus](#operations-that-do-not-require-consensus) + * [Raft Commands Implementation Details](#raft-commands-implementation-details) ## Operations that require Consensus @@ -36,7 +36,7 @@ Since getting a consensus is an expensive operation, it is limited to the follow * Creating / Deleting Indexes (static and auto indexes) * Configuring the [Ongoing Tasks](../../../studio/database/tasks/ongoing-tasks/general-info.mdx) -See [Implementation Details](../../../server/clustering/rachis/consensus-operations.mdx#implementation-details) below. +See [Implementation Details](#implementation-details) below. diff --git a/versioned_docs/version-6.2/server/clustering/replication/advanced-replication.mdx b/versioned_docs/version-6.2/server/clustering/replication/advanced-replication.mdx index b6b780d0ce..ab3effb019 100644 --- a/versioned_docs/version-6.2/server/clustering/replication/advanced-replication.mdx +++ b/versioned_docs/version-6.2/server/clustering/replication/advanced-replication.mdx @@ -22,7 +22,7 @@ Whenever the replication process between two databases is initiated it has to de 3. Once the _source_ gets the OK message it queries the _destination_ about the latest ETag it got from him. 4. The _destination_ sends back a heartbeat message with both the latest `ETag` he got from the _source_ and the current [Change Vector](../../../server/clustering/replication/change-vector.mdx) of the database. 5. The `ETag` is used as a starting point for the replication process but it is then been filtered by the _destination's_ current `change vector`, -meaning we will skip documents with higher `ETag` and lower `Change Vector`, this is done to prevent the [Ripple Effect](../../../server/clustering/replication/advanced-replication.mdx#preventing-the-ripple-effect). +meaning we will skip documents with higher `ETag` and lower `Change Vector`, this is done to prevent the [Ripple Effect](#preventing-the-ripple-effect). ## Preventing the Ripple Effect diff --git a/versioned_docs/version-6.2/server/clustering/replication/change-vector.mdx b/versioned_docs/version-6.2/server/clustering/replication/change-vector.mdx index 2135fa47d9..bba9fbeb35 100644 --- a/versioned_docs/version-6.2/server/clustering/replication/change-vector.mdx +++ b/versioned_docs/version-6.2/server/clustering/replication/change-vector.mdx @@ -17,17 +17,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Change vectors are the RavenDB implementation of the [Vector clock](https://en.wikipedia.org/wiki/Vector_clock) concept. They give us partial order over modifications of documents in a RavenDB cluster. -* Change vectors are updated every time a document is [modified](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors) +* Change vectors are updated every time a document is [modified](#concurrency-control--change-vectors) in any way. * In this page: - * [What are Change Vectors Constructed From?](../../../server/clustering/replication/change-vector.mdx#what-are-change-vectors-constructed-from) - * [How are Change Vectors used to Determine Order?](../../../server/clustering/replication/change-vector.mdx#how-are-change-vectors-used-to-determine-order) - * [Concurrency Control & Change Vectors](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors) - * [Change Vector Comparisons](../../../server/clustering/replication/change-vector.mdx#change-vector-comparisons) - * [Concurrency Control at the Cluster](../../../server/clustering/replication/change-vector.mdx#concurrency-control-at-the-cluster) - * [Database Global Change Vector](../../../server/clustering/replication/change-vector.mdx#database-global-change-vector) - * [After Restoring a Database from Backup](../../../server/clustering/replication/change-vector.mdx#after-restoring-a-database-from-backup) + * [What are Change Vectors Constructed From?](#what-are-change-vectors-constructed-from) + * [How are Change Vectors used to Determine Order?](#how-are-change-vectors-used-to-determine-order) + * [Concurrency Control & Change Vectors](#concurrency-control--change-vectors) + * [Change Vector Comparisons](#change-vector-comparisons) + * [Concurrency Control at the Cluster](#concurrency-control-at-the-cluster) + * [Database Global Change Vector](#database-global-change-vector) + * [After Restoring a Database from Backup](#after-restoring-a-database-from-backup) ## What are Change Vectors Constructed From? @@ -182,7 +182,7 @@ Note that if data is considered contained by a database it doesn't mean it is pr * [Snapshot backups](../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) save [change vector data](../../../server/ongoing-tasks/backup-overview.mdx#backup-contents). * [Logical backups](../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup) do not save change vector data. - Restoring a database from a logical backup will renew the document change vector's frequently [incrementing ETag](../../../server/clustering/replication/change-vector.mdx#what-are-change-vectors-constructed-from) + Restoring a database from a logical backup will renew the document change vector's frequently [incrementing ETag](#what-are-change-vectors-constructed-from) to its original value. diff --git a/versioned_docs/version-6.2/server/clustering/replication/replication-and-embedded-instance.mdx b/versioned_docs/version-6.2/server/clustering/replication/replication-and-embedded-instance.mdx index 9a216f3cc0..f63e169ea1 100644 --- a/versioned_docs/version-6.2/server/clustering/replication/replication-and-embedded-instance.mdx +++ b/versioned_docs/version-6.2/server/clustering/replication/replication-and-embedded-instance.mdx @@ -19,10 +19,10 @@ Essentially, Embedded RavenDB is the same as non-embedded, their only difference ## Configuring Replication between Embedded Instance and a Cluster ## Examples in this page - * [Configuring cluster membership of embedded instance through the Studio](../../../server/clustering/replication/replication-and-embedded-instance.mdx#configuring-cluster-membership-of-embedded-instance-through-the-studio) - * [Programmatically configuring cluster membership of embedded instance](../../../server/clustering/replication/replication-and-embedded-instance.mdx#programmatically-configuring-cluster-membership-of-embedded-instance) - * [Configuring embedded instance as External Replication destination through the Studio](../../../server/clustering/replication/replication-and-embedded-instance.mdx#configuring-embedded-instance-as-external-replication-destination-through-the-studio) - * [Programmatically embedded instance as External Replication destination](../../../server/clustering/replication/replication-and-embedded-instance.mdx#programmatically-embedded-instance-as-external-replication-destination) + * [Configuring cluster membership of embedded instance through the Studio](#configuring-cluster-membership-of-embedded-instance-through-the-studio) + * [Programmatically configuring cluster membership of embedded instance](#programmatically-configuring-cluster-membership-of-embedded-instance) + * [Configuring embedded instance as External Replication destination through the Studio](#configuring-embedded-instance-as-external-replication-destination-through-the-studio) + * [Programmatically embedded instance as External Replication destination](#programmatically-embedded-instance-as-external-replication-destination) diff --git a/versioned_docs/version-6.2/server/clustering/replication/replication-conflicts.mdx b/versioned_docs/version-6.2/server/clustering/replication/replication-conflicts.mdx index 4a1da72661..54d59be676 100644 --- a/versioned_docs/version-6.2/server/clustering/replication/replication-conflicts.mdx +++ b/versioned_docs/version-6.2/server/clustering/replication/replication-conflicts.mdx @@ -44,8 +44,8 @@ When there is a conflict between two or more document versions, RavenDB will try The identity check applies to [Tombstone](../../../glossary/tombstone.mdx) as well, and it will always resolve to the local one, since the tombstones are always considered equal. -3. Try to resolve the conflict by using a script, which is set up by configuring a [Conflict Resolver](../../../server/clustering/replication/replication-conflicts.mdx#conflict-resolution-script). -4. If all else fails, record conflicting document variants as "Conflicted Documents" which will have to be resolved [Manually](../../../server/clustering/replication/replication-conflicts.mdx#manually-resolving-conflicts). +3. Try to resolve the conflict by using a script, which is set up by configuring a [Conflict Resolver](#conflict-resolution-script). +4. If all else fails, record conflicting document variants as "Conflicted Documents" which will have to be resolved [Manually](#manually-resolving-conflicts). ## Conflict Resolution Script A resolution script is defined per collection and have the following input arguments: diff --git a/versioned_docs/version-6.2/server/clustering/replication/replication-overview.mdx b/versioned_docs/version-6.2/server/clustering/replication/replication-overview.mdx index 9e689cc32a..9ab2c384db 100644 --- a/versioned_docs/version-6.2/server/clustering/replication/replication-overview.mdx +++ b/versioned_docs/version-6.2/server/clustering/replication/replication-overview.mdx @@ -25,13 +25,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; are resolved according to the defined [conflict resolution](../../../server/clustering/replication/replication-conflicts.mdx) policy on the receiving end. * In this page: - * [Replication types](../../../server/clustering/replication/replication-overview.mdx#replication-types) - * [Internal replication](../../../server/clustering/replication/replication-overview.mdx#internal-replication) - * [External replication](../../../server/clustering/replication/replication-overview.mdx#external-replication) - * [Hub/Sink replication](../../../server/clustering/replication/replication-overview.mdx#hubsink-replication) - * [What is replicated](../../../server/clustering/replication/replication-overview.mdx#what-is-replicated) - * [How replication works](../../../server/clustering/replication/replication-overview.mdx#how-replication-works) - * [Replication & transaction boundary](../../../server/clustering/replication/replication-overview.mdx#replication--transaction-boundary) + * [Replication types](#replication-types) + * [Internal replication](#internal-replication) + * [External replication](#external-replication) + * [Hub/Sink replication](#hubsink-replication) + * [What is replicated](#what-is-replicated) + * [How replication works](#how-replication-works) + * [Replication & transaction boundary](#replication--transaction-boundary) ## Replication types @@ -162,7 +162,7 @@ __Replication & cluster-wide transactions__ is either persisted on all database group nodes or rolled back on all upon failure. * After a cluster consensus is reached, the Raft command to be executed is propagated to all nodes. - When the command is executed locally on a node, if the items that are persisted are of the [type that replicates](../../../server/clustering/replication/replication-overview.mdx#what-is-replicated), + When the command is executed locally on a node, if the items that are persisted are of the [type that replicates](#what-is-replicated), then the node will __replicate__ them to the other nodes via the replication process. * A node that receives such replication will accept this write, diff --git a/versioned_docs/version-6.2/server/configuration/backup-configuration.mdx b/versioned_docs/version-6.2/server/configuration/backup-configuration.mdx index 4a9d032b44..725bc0a0e7 100644 --- a/versioned_docs/version-6.2/server/configuration/backup-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/backup-configuration.mdx @@ -19,14 +19,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Another relevant server configuration option can be found [here](../../server/configuration/server-configuration.mdx#servercpucreditsexhaustionbackupdelayinmin). * In this page: - * [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backuptemppath) - * [Backup.LocalRootPath](../../server/configuration/backup-configuration.mdx#backuplocalrootpath) - * [Backup.AllowedDestinations](../../server/configuration/backup-configuration.mdx#backupalloweddestinations) - * [Backup.AllowedAwsRegions](../../server/configuration/backup-configuration.mdx#backupallowedawsregions) - * [Backup.MaxNumberOfConcurrentBackups](../../server/configuration/backup-configuration.mdx#backupmaxnumberofconcurrentbackups) - * [Backup.ConcurrentBackupsDelayInSec](../../server/configuration/backup-configuration.mdx#backupconcurrentbackupsdelayinsec) - * [Backup.LowMemoryBackupDelayInMin](../../server/configuration/backup-configuration.mdx#backuplowmemorybackupdelayinmin) - * [Backup.MoveToNewResponsibleNodeGracePeriodInMin](../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin) + * [Backup.TempPath](#backuptemppath) + * [Backup.LocalRootPath](#backuplocalrootpath) + * [Backup.AllowedDestinations](#backupalloweddestinations) + * [Backup.AllowedAwsRegions](#backupallowedawsregions) + * [Backup.MaxNumberOfConcurrentBackups](#backupmaxnumberofconcurrentbackups) + * [Backup.ConcurrentBackupsDelayInSec](#backupconcurrentbackupsdelayinsec) + * [Backup.LowMemoryBackupDelayInMin](#backuplowmemorybackupdelayinmin) + * [Backup.MoveToNewResponsibleNodeGracePeriodInMin](#backupmovetonewresponsiblenodegraceperiodinmin) ## Backup.TempPath diff --git a/versioned_docs/version-6.2/server/configuration/cluster-configuration.mdx b/versioned_docs/version-6.2/server/configuration/cluster-configuration.mdx index 00f4418e85..e4719125e2 100644 --- a/versioned_docs/version-6.2/server/configuration/cluster-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/cluster-configuration.mdx @@ -26,30 +26,30 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Server-wide scope: - [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../../server/configuration/cluster-configuration.mdx#clustercompareexchangeexpireddeletefrequencyinsec) - [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration.mdx#clustercompareexchangetombstonescleanupintervalinmin) - [Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clusterelectiontimeoutinms) - [Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration.mdx#clusterharddeleteonreplacement) - [Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration.mdx#clusterloghistorymaxentries) - [Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration.mdx#clustermaxchangevectordistance) - [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) - [Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration.mdx#clustermaxsizeofsingleraftcommandinmb) - [Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration.mdx#clustermaximalallowedclusterversion) - [Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration.mdx#clusteronerrordelaytimeinms) - [Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration.mdx#clusteroperationtimeoutinsec) - [Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clusterreceivefromworkertimeoutinms) - [Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration.mdx#clusterstatsstabilizationtimeinsec) - [Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#clustersupervisorsampleperiodinms) - [Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#clustertcpreceivebuffersizeinbytes) - [Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#clustertcpsendbuffersizeinbytes) - [Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clustertcptimeoutinms) - [Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) - [Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) - [Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforerotatingpreferrednodeinsec) - [Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#clusterworkersampleperiodinms) + [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](#clustercompareexchangeexpireddeletefrequencyinsec) + [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](#clustercompareexchangetombstonescleanupintervalinmin) + [Cluster.ElectionTimeoutInMs](#clusterelectiontimeoutinms) + [Cluster.HardDeleteOnReplacement](#clusterharddeleteonreplacement) + [Cluster.LogHistoryMaxEntries](#clusterloghistorymaxentries) + [Cluster.MaxChangeVectorDistance](#clustermaxchangevectordistance) + [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) + [Cluster.MaxSizeOfSingleRaftCommandInMb](#clustermaxsizeofsingleraftcommandinmb) + [Cluster.MaximalAllowedClusterVersion](#clustermaximalallowedclusterversion) + [Cluster.OnErrorDelayTimeInMs](#clusteronerrordelaytimeinms) + [Cluster.OperationTimeoutInSec](#clusteroperationtimeoutinsec) + [Cluster.ReceiveFromWorkerTimeoutInMs](#clusterreceivefromworkertimeoutinms) + [Cluster.StatsStabilizationTimeInSec](#clusterstatsstabilizationtimeinsec) + [Cluster.SupervisorSamplePeriodInMs](#clustersupervisorsampleperiodinms) + [Cluster.TcpReceiveBufferSizeInBytes](#clustertcpreceivebuffersizeinbytes) + [Cluster.TcpSendBufferSizeInBytes](#clustertcpsendbuffersizeinbytes) + [Cluster.TcpTimeoutInMs](#clustertcptimeoutinms) + [Cluster.TimeBeforeAddingReplicaInSec](#clustertimebeforeaddingreplicainsec) + [Cluster.TimeBeforeMovingToRehabInSec](#clustertimebeforemovingtorehabinsec) + [Cluster.TimeBeforeRotatingPreferredNodeInSec](#clustertimebeforerotatingpreferrednodeinsec) + [Cluster.WorkerSamplePeriodInMs](#clusterworkersampleperiodinms) * Server-wide, or database scope: - [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#clusterdisableatomicdocumentwrites) - [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactionbatchsize) + [Cluster.DisableAtomicDocumentWrites](#clusterdisableatomicdocumentwrites) + [Cluster.MaxClusterTransactionBatchSize](#clustermaxclustertransactionbatchsize) ## Cluster.CompareExchangeExpiredDeleteFrequencyInSec diff --git a/versioned_docs/version-6.2/server/configuration/configuration-options.mdx b/versioned_docs/version-6.2/server/configuration/configuration-options.mdx index d4e1983157..0b7e974072 100644 --- a/versioned_docs/version-6.2/server/configuration/configuration-options.mdx +++ b/versioned_docs/version-6.2/server/configuration/configuration-options.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; If needed, you can customize the default configuration to suit your specific needs. * Any **configuration key** can be modified by either of the following options: - * [Environment variables](../../server/configuration/configuration-options.mdx#environment-variables) - * [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) - * [Command line arguments](../../server/configuration/configuration-options.mdx#command-line-arguments) - * [Database settings view](../../server/configuration/configuration-options.mdx#database-settings-view) (database scope only) + * [Environment variables](#environment-variables) + * [settings.json](#settingsjson) + * [Command line arguments](#command-line-arguments) + * [Database settings view](#database-settings-view) (database scope only) @@ -54,7 +54,7 @@ $Env:RAVEN_Security_Certificate_Path=/config/raven-server.certificate.pfx _settings.json_ configuration values **override** their matching -[environment variables](../../server/configuration/configuration-options.mdx#environment-variables) values. +[environment variables](#environment-variables) values. * The `settings.json` file is created by RavenDB when running the server for the first time, @@ -102,8 +102,8 @@ for example, use: Command line arguments configuration values **override** their matching -[environment variables](../../server/configuration/configuration-options.mdx#environment-variables) -and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) values. +[environment variables](#environment-variables) +and [settings.json](#settingsjson) values. * The server can be configured using command line arguments that are passed to the console application diff --git a/versioned_docs/version-6.2/server/configuration/database-configuration.mdx b/versioned_docs/version-6.2/server/configuration/database-configuration.mdx index 7cf37d7d18..51e2754ea5 100644 --- a/versioned_docs/version-6.2/server/configuration/database-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/database-configuration.mdx @@ -18,21 +18,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Databases.Compression.CompressAllCollectionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault) - [Databases.Compression.CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) - [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesconcurrentloadtimeoutinsec) - [Databases.FrequencyToCheckForIdleInSec](../../server/configuration/database-configuration.mdx#databasesfrequencytocheckforidleinsec) - [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databasesmaxconcurrentloads) + [Databases.Compression.CompressAllCollectionsDefault](#databasescompressioncompressallcollectionsdefault) + [Databases.Compression.CompressRevisionsDefault](#databasescompressioncompressrevisionsdefault) + [Databases.ConcurrentLoadTimeoutInSec](#databasesconcurrentloadtimeoutinsec) + [Databases.FrequencyToCheckForIdleInSec](#databasesfrequencytocheckforidleinsec) + [Databases.MaxConcurrentLoads](#databasesmaxconcurrentloads) * Server-wide, or database scope: - [Databases.CollectionOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasescollectionoperationtimeoutinsec) - [Databases.DeepCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databasesdeepcleanupthresholdinmin) - [Databases.MaxIdleTimeInSec](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec) - [Databases.OperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesoperationtimeoutinsec) - [Databases.PulseReadTransactionLimitInMb](../../server/configuration/database-configuration.mdx#databasespulsereadtransactionlimitinmb) - [Databases.QueryOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) - [Databases.QueryTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) - [Databases.RegularCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databasesregularcleanupthresholdinmin) + [Databases.CollectionOperationTimeoutInSec](#databasescollectionoperationtimeoutinsec) + [Databases.DeepCleanupThresholdInMin](#databasesdeepcleanupthresholdinmin) + [Databases.MaxIdleTimeInSec](#databasesmaxidletimeinsec) + [Databases.OperationTimeoutInSec](#databasesoperationtimeoutinsec) + [Databases.PulseReadTransactionLimitInMb](#databasespulsereadtransactionlimitinmb) + [Databases.QueryOperationTimeoutInSec](#databasesqueryoperationtimeoutinsec) + [Databases.QueryTimeoutInSec](#databasesquerytimeoutinsec) + [Databases.RegularCleanupThresholdInMin](#databasesregularcleanupthresholdinmin) ## Databases.Compression.CompressAllCollectionsDefault @@ -64,7 +64,7 @@ The time (in seconds) that a database waits for a free loading slot before the load attempt times out. RavenDB limits the number of databases that load at the same time -(set by [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databasesmaxconcurrentloads)). +(set by [Databases.MaxConcurrentLoads](#databasesmaxconcurrentloads)). When this limit is reached, each additional database that needs to load waits for a slot to free up. This can happen when a burst of requests accesses many idle databases at once. @@ -95,7 +95,7 @@ The interval (in seconds) at which the system checks for idle databases. Specifies the maximum number of databases that can be loaded concurrently. If more databases need to load at the same time, each database waits for a free slot -for the period set by [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesconcurrentloadtimeoutinsec). +for the period set by [Databases.ConcurrentLoadTimeoutInSec](#databasesconcurrentloadtimeoutinsec). - **Type**: `int` - **Default**: `8` diff --git a/versioned_docs/version-6.2/server/configuration/etl-configuration.mdx b/versioned_docs/version-6.2/server/configuration/etl-configuration.mdx index cb80ca3fd1..191b412ae7 100644 --- a/versioned_docs/version-6.2/server/configuration/etl-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/etl-configuration.mdx @@ -17,17 +17,17 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [ETL.ExtractAndTransformTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlextractandtransformtimeoutinsec) - * [ETL.MaxBatchSizeInMb](../../server/configuration/etl-configuration.mdx#etlmaxbatchsizeinmb) - * [ETL.MaxFallbackTimeInSec](../../server/configuration/etl-configuration.mdx#etlmaxfallbacktimeinsec) - * [ETL.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteddocuments) - * [ETL.MaxNumberOfExtractedItems](../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteditems) - * [ETL.OLAP.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etlolapmaxnumberofextracteddocuments) - * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragetimetoliveinsec) - * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragevisibilitytimeoutinsec) - * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlqueuekafkainittransactionstimeoutinsec) - * [ETL.Raven.LoadRequestTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlravenloadrequesttimeoutinsec) - * [ETL.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) + * [ETL.ExtractAndTransformTimeoutInSec](#etlextractandtransformtimeoutinsec) + * [ETL.MaxBatchSizeInMb](#etlmaxbatchsizeinmb) + * [ETL.MaxFallbackTimeInSec](#etlmaxfallbacktimeinsec) + * [ETL.MaxNumberOfExtractedDocuments](#etlmaxnumberofextracteddocuments) + * [ETL.MaxNumberOfExtractedItems](#etlmaxnumberofextracteditems) + * [ETL.OLAP.MaxNumberOfExtractedDocuments](#etlolapmaxnumberofextracteddocuments) + * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](#etlqueueazurequeuestoragetimetoliveinsec) + * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](#etlqueueazurequeuestoragevisibilitytimeoutinsec) + * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](#etlqueuekafkainittransactionstimeoutinsec) + * [ETL.Raven.LoadRequestTimeoutInSec](#etlravenloadrequesttimeoutinsec) + * [ETL.SQL.CommandTimeoutInSec](#etlsqlcommandtimeoutinsec) diff --git a/versioned_docs/version-6.2/server/configuration/http-configuration.mdx b/versioned_docs/version-6.2/server/configuration/http-configuration.mdx index 5385bebfa5..6a7054660b 100644 --- a/versioned_docs/version-6.2/server/configuration/http-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/http-configuration.mdx @@ -19,28 +19,28 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can set Kestrel's properties via the following RavenDB configuration keys. * In this page: - * [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#httpmindataratebytespersec) - * [Http.MinDataRateGracePeriodInSec](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec) - * [Http.MaxRequestBufferSizeInKb](../../server/configuration/http-configuration.mdx#httpmaxrequestbuffersizeinkb) - * [Http.MaxRequestLineSizeInKb](../../server/configuration/http-configuration.mdx#httpmaxrequestlinesizeinkb) - * [Http.Http2.KeepAlivePingTimeoutInSec](../../server/configuration/http-configuration.mdx#httphttp2keepalivepingtimeoutinsec) - * [Http.Http2.KeepAlivePingDelayInSec](../../server/configuration/http-configuration.mdx#httphttp2keepalivepingdelayinsec) - * [Http.Http2.MaxStreamsPerConnection](../../server/configuration/http-configuration.mdx#httphttp2maxstreamsperconnection) - * [Http.UseResponseCompression](../../server/configuration/http-configuration.mdx#httpuseresponsecompression) - * [Http.AllowResponseCompressionOverHttps](../../server/configuration/http-configuration.mdx#httpallowresponsecompressionoverhttps) - * [Http.GzipResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpgzipresponsecompressionlevel) - * [Http.DeflateResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpdeflateresponsecompressionlevel) - * [Http.ZstdResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpzstdresponsecompressionlevel) - * [Http.StaticFilesResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpstaticfilesresponsecompressionlevel) - * [Http.Protocols](../../server/configuration/http-configuration.mdx#httpprotocols) - * [Http.AllowSynchronousIO](../../server/configuration/http-configuration.mdx#httpallowsynchronousio) + * [Http.MinDataRateBytesPerSec](#httpmindataratebytespersec) + * [Http.MinDataRateGracePeriodInSec](#httpmindatarategraceperiodinsec) + * [Http.MaxRequestBufferSizeInKb](#httpmaxrequestbuffersizeinkb) + * [Http.MaxRequestLineSizeInKb](#httpmaxrequestlinesizeinkb) + * [Http.Http2.KeepAlivePingTimeoutInSec](#httphttp2keepalivepingtimeoutinsec) + * [Http.Http2.KeepAlivePingDelayInSec](#httphttp2keepalivepingdelayinsec) + * [Http.Http2.MaxStreamsPerConnection](#httphttp2maxstreamsperconnection) + * [Http.UseResponseCompression](#httpuseresponsecompression) + * [Http.AllowResponseCompressionOverHttps](#httpallowresponsecompressionoverhttps) + * [Http.GzipResponseCompressionLevel](#httpgzipresponsecompressionlevel) + * [Http.DeflateResponseCompressionLevel](#httpdeflateresponsecompressionlevel) + * [Http.ZstdResponseCompressionLevel](#httpzstdresponsecompressionlevel) + * [Http.StaticFilesResponseCompressionLevel](#httpstaticfilesresponsecompressionlevel) + * [Http.Protocols](#httpprotocols) + * [Http.AllowSynchronousIO](#httpallowsynchronousio) ## Http.MinDataRateBytesPerSec * Set Kestrel's minimum required data rate in bytes per second. -* This option must be configured together with [Http.MinDataRateGracePeriod](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec). +* This option must be configured together with [Http.MinDataRateGracePeriod](#httpmindatarategraceperiodinsec). - **Type**: `int` - **Default**: `null` - **Scope**: Server-wide only @@ -53,7 +53,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Http.MinDataRateGracePeriodInSec * Set Kestrel's allowed request and response grace period in seconds. - This option must be configured together with [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#httpmindataratebytespersec) + This option must be configured together with [Http.MinDataRateBytesPerSec](#httpmindataratebytespersec) * Kestrel checks every second if data is coming in at the specified rate in bytes/second. If the rate drops below the minimum set by _MinResponseDataRate_, the connection is timed out. diff --git a/versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx b/versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx index e845bf3326..de38289a39 100644 --- a/versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx @@ -25,82 +25,82 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Indexing.CleanupIntervalInMin](../../server/configuration/indexing-configuration.mdx#indexingcleanupintervalinmin) - [Indexing.GlobalScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingglobalscratchspacelimitinmb) - [Indexing.MaxNumberOfConcurrentlyRunningIndexes](../../server/configuration/indexing-configuration.mdx#indexingmaxnumberofconcurrentlyrunningindexes) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) - [Indexing.NuGetAllowPreReleasePackages](../../server/configuration/indexing-configuration.mdx#indexingnugetallowprereleasepackages) - [Indexing.NuGetPackageSourceUrl](../../server/configuration/indexing-configuration.mdx#indexingnugetpackagesourceurl) - [Indexing.NuGetPackagesPath](../../server/configuration/indexing-configuration.mdx#indexingnugetpackagespath) - [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacheexpirationscanfrequencyinsec) - [Indexing.QueryClauseCache.RepeatedQueriesCount](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacherepeatedqueriescount) - [Indexing.QueryClauseCache.SizeInMb](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecachesizeinmb) + [Indexing.CleanupIntervalInMin](#indexingcleanupintervalinmin) + [Indexing.GlobalScratchSpaceLimitInMb](#indexingglobalscratchspacelimitinmb) + [Indexing.MaxNumberOfConcurrentlyRunningIndexes](#indexingmaxnumberofconcurrentlyrunningindexes) + [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](#indexingmaxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) + [Indexing.NuGetAllowPreReleasePackages](#indexingnugetallowprereleasepackages) + [Indexing.NuGetPackageSourceUrl](#indexingnugetpackagesourceurl) + [Indexing.NuGetPackagesPath](#indexingnugetpackagespath) + [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](#indexingqueryclausecacheexpirationscanfrequencyinsec) + [Indexing.QueryClauseCache.RepeatedQueriesCount](#indexingqueryclausecacherepeatedqueriescount) + [Indexing.QueryClauseCache.SizeInMb](#indexingqueryclausecachesizeinmb) * Server-wide, or database scope: - [Indexing.Auto.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) - [Indexing.Auto.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexingautodeploymentmode) - [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) - [Indexing.Disable](../../server/configuration/indexing-configuration.mdx#indexingdisable) - [Indexing.DisableQueryOptimizerGeneratedIndexes](../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) - [Indexing.ErrorIndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexingerrorindexstartupbehavior) - [Indexing.History.NumberOfRevisions](../../server/configuration/indexing-configuration.mdx#indexinghistorynumberofrevisions) - [Indexing.IndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexingindexstartupbehavior) - [Indexing.ResetMode](../../server/configuration/indexing-configuration.mdx#indexingresetmode) - [Indexing.RunInMemory](../../server/configuration/indexing-configuration.mdx#indexingruninmemory) - [Indexing.SkipDatabaseIdValidationOnIndexOpening](../../server/configuration/indexing-configuration.mdx#indexingskipdatabaseidvalidationonindexopening) - [Indexing.Static.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) - [Indexing.Static.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexingstaticdeploymentmode) - [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) - [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath) - [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](../../server/configuration/indexing-configuration.mdx#indexingtimebeforedeletionofsupersededautoindexinsec) - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin) + [Indexing.Auto.ArchivedDataProcessingBehavior](#indexingautoarchiveddataprocessingbehavior) + [Indexing.Auto.DeploymentMode](#indexingautodeploymentmode) + [Indexing.Auto.SearchEngineType](#indexingautosearchenginetype) + [Indexing.Disable](#indexingdisable) + [Indexing.DisableQueryOptimizerGeneratedIndexes](#indexingdisablequeryoptimizergeneratedindexes) + [Indexing.ErrorIndexStartupBehavior](#indexingerrorindexstartupbehavior) + [Indexing.History.NumberOfRevisions](#indexinghistorynumberofrevisions) + [Indexing.IndexStartupBehavior](#indexingindexstartupbehavior) + [Indexing.ResetMode](#indexingresetmode) + [Indexing.RunInMemory](#indexingruninmemory) + [Indexing.SkipDatabaseIdValidationOnIndexOpening](#indexingskipdatabaseidvalidationonindexopening) + [Indexing.Static.ArchivedDataProcessingBehavior](#indexingstaticarchiveddataprocessingbehavior) + [Indexing.Static.DeploymentMode](#indexingstaticdeploymentmode) + [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](#indexingstaticrequireadmintodeployjavascriptindexes) + [Indexing.TempPath](#indexingtemppath) + [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](#indexingtimebeforedeletionofsupersededautoindexinsec) + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) + [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](#indexingtimetowaitbeforemarkingautoindexasidleinmin) * Server-wide, or database, or per index: - [Indexing.AllowStringCompilation](../../server/configuration/indexing-configuration.mdx#indexingallowstringcompilation) - [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) - [Indexing.Analyzers.Exact.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) - [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) - [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) - [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) - [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) - [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) - [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxmemoizationsizeinmb) - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) - [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxunmanagedallocationsbatchsizelimitinmb) - [Indexing.Encrypted.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb) - [Indexing.IndexEmptyEntries](../../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) - [Indexing.IndexMissingFieldsAsNull](../../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) - [Indexing.Lucene.Analyzers.NGram.MaxGram](../../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) - [Indexing.Lucene.Analyzers.NGram.MinGram](../../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) - [Indexing.Lucene.IndexInputType](../../server/configuration/indexing-configuration.mdx#indexingluceneindexinputtype) - [Indexing.Lucene.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglucenelargesegmentsizetomergeinmb) - [Indexing.Lucene.MaximumSizePerSegmentInMb](../../server/configuration/indexing-configuration.mdx#indexinglucenemaximumsizepersegmentinmb) - [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](../../server/configuration/indexing-configuration.mdx#indexinglucenemaxtimeformergestokeeprunninginsec) - [Indexing.Lucene.MergeFactor](../../server/configuration/indexing-configuration.mdx#indexinglucenemergefactor) - [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexinglucenenumberoflargesegmentstomergeinsinglebatch) - [Indexing.Lucene.ReaderTermsIndexDivisor](../../server/configuration/indexing-configuration.mdx#indexinglucenereadertermsindexdivisor) - [Indexing.Lucene.UseCompoundFileInMerging](../../server/configuration/indexing-configuration.mdx#indexingluceneusecompoundfileinmerging) - [Indexing.ManagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingmanagedallocationsbatchsizelimitinmb) - [Indexing.MapBatchSize](../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) - [Indexing.MapTimeoutAfterEtagReachedInMin](../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutafteretagreachedinmin) - [Indexing.MapTimeoutInSec](../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) - [Indexing.MaxStepsForScript](../../server/configuration/indexing-configuration.mdx#indexingmaxstepsforscript) - [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimefordocumenttransactiontoremainopeninsec) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) - [Indexing.Metrics.Enabled](../../server/configuration/indexing-configuration.mdx#indexingmetricsenabled) - [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexingminnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) - [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](../../server/configuration/indexing-configuration.mdx#indexingminimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) - [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexingnumberofconcurrentstoppedbatchesifrunninglowonmemory) - [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexingnumberoflargesegmentstomergeinsinglebatch) - [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](../../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) - [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](../../server/configuration/indexing-configuration.mdx#indexingorderbyticksautomaticallywhendatesareinvolved) - [Indexing.QueryClauseCache.Disabled](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecachedisabled) - [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacherepeatedqueriestimeframeinsec) - [Indexing.Querying.UseSearchAnalyzerForDynamicFieldsIfNotSetExplicitlyInSearchQuery](../../server/configuration/indexing-configuration.mdx#indexingqueryingusesearchanalyzerfordynamicfieldsifnotsetexplicitlyinsearchquery) - [Indexing.ScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingscratchspacelimitinmb) - [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) - [Indexing.Throttling.TimeIntervalInMs](../../server/configuration/indexing-configuration.mdx#indexingthrottlingtimeintervalinms) - [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](../../server/configuration/indexing-configuration.mdx#indexingtimesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) - [Indexing.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingtransactionsizelimitinmb) + [Indexing.AllowStringCompilation](#indexingallowstringcompilation) + [Indexing.Analyzers.Default](#indexinganalyzersdefault) + [Indexing.Analyzers.Exact.Default](#indexinganalyzersexactdefault) + [Indexing.Analyzers.Search.Default](#indexinganalyzerssearchdefault) + [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](#indexingcoraxdocumentslimitforcompressiondictionarycreation) + [Indexing.Corax.IncludeDocumentScore](#indexingcoraxincludedocumentscore) + [Indexing.Corax.IncludeSpatialDistance](#indexingcoraxincludespatialdistance) + [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](#indexingcoraxmaxallocationsatdictionarytraininginmb) + [Indexing.Corax.MaxMemoizationSizeInMb](#indexingcoraxmaxmemoizationsizeinmb) + [Indexing.Corax.Static.ComplexFieldIndexingBehavior](#indexingcoraxstaticcomplexfieldindexingbehavior) + [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](#indexingcoraxunmanagedallocationsbatchsizelimitinmb) + [Indexing.Encrypted.TransactionSizeLimitInMb](#indexingencryptedtransactionsizelimitinmb) + [Indexing.IndexEmptyEntries](#indexingindexemptyentries) + [Indexing.IndexMissingFieldsAsNull](#indexingindexmissingfieldsasnull) + [Indexing.Lucene.Analyzers.NGram.MaxGram](#indexingluceneanalyzersngrammaxgram) + [Indexing.Lucene.Analyzers.NGram.MinGram](#indexingluceneanalyzersngrammingram) + [Indexing.Lucene.IndexInputType](#indexingluceneindexinputtype) + [Indexing.Lucene.LargeSegmentSizeToMergeInMb](#indexinglucenelargesegmentsizetomergeinmb) + [Indexing.Lucene.MaximumSizePerSegmentInMb](#indexinglucenemaximumsizepersegmentinmb) + [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](#indexinglucenemaxtimeformergestokeeprunninginsec) + [Indexing.Lucene.MergeFactor](#indexinglucenemergefactor) + [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](#indexinglucenenumberoflargesegmentstomergeinsinglebatch) + [Indexing.Lucene.ReaderTermsIndexDivisor](#indexinglucenereadertermsindexdivisor) + [Indexing.Lucene.UseCompoundFileInMerging](#indexingluceneusecompoundfileinmerging) + [Indexing.ManagedAllocationsBatchSizeLimitInMb](#indexingmanagedallocationsbatchsizelimitinmb) + [Indexing.MapBatchSize](#indexingmapbatchsize) + [Indexing.MapTimeoutAfterEtagReachedInMin](#indexingmaptimeoutafteretagreachedinmin) + [Indexing.MapTimeoutInSec](#indexingmaptimeoutinsec) + [Indexing.MaxStepsForScript](#indexingmaxstepsforscript) + [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](#indexingmaxtimefordocumenttransactiontoremainopeninsec) + [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](#indexingmaxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) + [Indexing.Metrics.Enabled](#indexingmetricsenabled) + [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](#indexingminnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) + [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](#indexingminimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) + [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](#indexingnumberofconcurrentstoppedbatchesifrunninglowonmemory) + [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](#indexingnumberoflargesegmentstomergeinsinglebatch) + [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](#indexingorderbyscoreautomaticallywhenboostingisinvolved) + [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](#indexingorderbyticksautomaticallywhendatesareinvolved) + [Indexing.QueryClauseCache.Disabled](#indexingqueryclausecachedisabled) + [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](#indexingqueryclausecacherepeatedqueriestimeframeinsec) + [Indexing.Querying.UseSearchAnalyzerForDynamicFieldsIfNotSetExplicitlyInSearchQuery](#indexingqueryingusesearchanalyzerfordynamicfieldsifnotsetexplicitlyinsearchquery) + [Indexing.ScratchSpaceLimitInMb](#indexingscratchspacelimitinmb) + [Indexing.Static.SearchEngineType](#indexingstaticsearchenginetype) + [Indexing.Throttling.TimeIntervalInMs](#indexingthrottlingtimeintervalinms) + [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](#indexingtimesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) + [Indexing.TransactionSizeLimitInMb](#indexingtransactionsizelimitinmb) ## Indexing.CleanupIntervalInMin @@ -631,7 +631,7 @@ EXPERT ONLY: * This configuration applies only to the Lucene indexing engine. * The definition of a large segment in MB. - We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexingnumberoflargesegmentstomergeinsinglebatch) in a single batch. + We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](#indexingnumberoflargesegmentstomergeinsinglebatch) in a single batch. * The default value, which is determined based on your platform details, is set by the constructor of class `IndexingConfiguration`. - **Type**: `int` @@ -694,7 +694,7 @@ EXPERT ONLY: * This configuration applies only to the Lucene indexing engine. -* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglargesegmentsizetomergeinmb) to merge in a single batch. +* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](#indexinglargesegmentsizetomergeinmb) to merge in a single batch. - **Type**: `int` - **Default**: `2` - **Scope**: Server-wide, or per database, or per index @@ -901,11 +901,11 @@ Queries that repeat within this time frame will be considered worth caching. * `false` (default): The [Default analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) is used to analyze the **query term**. - This analyzer can be configured via the [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. + This analyzer can be configured via the [Indexing.Analyzers.Default](#indexinganalyzersdefault) configuration key. * `true`: The [Default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to analyze the **query term**. - This analyzer can be configured via the [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. + This analyzer can be configured via the [Indexing.Analyzers.Search.Default](#indexinganalyzerssearchdefault) configuration key. * See the table in [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) for the complete analyzer-selection rules based on this configuration key and the analyzer configured for the dynamic index field. diff --git a/versioned_docs/version-6.2/server/configuration/license-configuration.mdx b/versioned_docs/version-6.2/server/configuration/license-configuration.mdx index 7dfaae1ac1..2bbca0e6a3 100644 --- a/versioned_docs/version-6.2/server/configuration/license-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/license-configuration.mdx @@ -116,8 +116,8 @@ EXPERT ONLY. Disable automatic updates of the license from the License Server (api.ravendb.net). Can still update the license by either: -* Setting the [License](../../server/configuration/license-configuration.mdx#license) configuration -* Setting the [License.Path](../../server/configuration/license-configuration.mdx#licensepath) configuration +* Setting the [License](#license) configuration +* Setting the [License.Path](#licensepath) configuration * Replacing the _license.json_ file on disk - **Type**: `bool` - **Default**: `false` diff --git a/versioned_docs/version-6.2/server/configuration/memory-configuration.mdx b/versioned_docs/version-6.2/server/configuration/memory-configuration.mdx index bb73de1b8c..d6dfd55e97 100644 --- a/versioned_docs/version-6.2/server/configuration/memory-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/memory-configuration.mdx @@ -20,12 +20,12 @@ Use the configuration keys listed below to control how your RavenDB server manag Learn how to apply these keys in the [Configuration Overview](../../server/configuration/configuration-options.mdx) article. * On this page: - * [Configuration keys](../../server/configuration/memory-configuration.mdx#configuration-keys) - * [Memory.LowMemoryLimitInMb](../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) - * [Memory.LowMemoryCommitLimitInMb](../../server/configuration/memory-configuration.mdx#memorylowmemorycommitlimitinmb) - * [Memory.MinimumFreeCommittedMemoryPercentage](../../server/configuration/memory-configuration.mdx#memoryminimumfreecommittedmemorypercentage) - * [Memory.MaxFreeCommittedMemoryToKeepInMb](../../server/configuration/memory-configuration.mdx#memorymaxfreecommittedmemorytokeepinmb) - * [Memory.GC.LargeObjectHeapCompactionThresholdPercentage](../../server/configuration/memory-configuration.mdx#memorygclargeobjectheapcompactionthresholdpercentage) + * [Configuration keys](#configuration-keys) + * [Memory.LowMemoryLimitInMb](#memorylowmemorylimitinmb) + * [Memory.LowMemoryCommitLimitInMb](#memorylowmemorycommitlimitinmb) + * [Memory.MinimumFreeCommittedMemoryPercentage](#memoryminimumfreecommittedmemorypercentage) + * [Memory.MaxFreeCommittedMemoryToKeepInMb](#memorymaxfreecommittedmemorytokeepinmb) + * [Memory.GC.LargeObjectHeapCompactionThresholdPercentage](#memorygclargeobjectheapcompactionthresholdpercentage) diff --git a/versioned_docs/version-6.2/server/configuration/monitoring-configuration.mdx b/versioned_docs/version-6.2/server/configuration/monitoring-configuration.mdx index cbbc989ece..75ca1cc91c 100644 --- a/versioned_docs/version-6.2/server/configuration/monitoring-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/monitoring-configuration.mdx @@ -15,47 +15,47 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * OpenTelemetry monitoring: - [Monitoring.OpenTelemetry.ConsoleExporter](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryconsoleexporter) - [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) - [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersaspnetcoreenabled) - [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersruntimeenabled) - [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservercpucreditsenabled) - [Monitoring.OpenTelemetry.Meters.Server.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverenabled) - [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergcenabled) - [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergeneralenabled) - [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverrequestsenabled) - [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverresourcesenabled) - [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverstorageenabled) - [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservertotaldatabasesenabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolenabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolexportprocessortype) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolheaders) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolprotocol) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) - [Monitoring.OpenTelemetry.ServiceInstanceId](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryserviceinstanceid) - [Monitoring.OpenTelemetry.ServiceName](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryservicename) - [Monitoring.OpenTelemetry.ServiceNamespace](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryservicenamespace) + [Monitoring.OpenTelemetry.ConsoleExporter](#monitoringopentelemetryconsoleexporter) + [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) + [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](#monitoringopentelemetrymetersaspnetcoreenabled) + [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](#monitoringopentelemetrymetersruntimeenabled) + [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](#monitoringopentelemetrymetersservercpucreditsenabled) + [Monitoring.OpenTelemetry.Meters.Server.Enabled](#monitoringopentelemetrymetersserverenabled) + [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](#monitoringopentelemetrymetersservergcenabled) + [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](#monitoringopentelemetrymetersservergeneralenabled) + [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](#monitoringopentelemetrymetersserverrequestsenabled) + [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](#monitoringopentelemetrymetersserverresourcesenabled) + [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](#monitoringopentelemetrymetersserverstorageenabled) + [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](#monitoringopentelemetrymetersservertotaldatabasesenabled) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](#monitoringopentelemetryopentelemetryprotocolenabled) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](#monitoringopentelemetryopentelemetryprotocolendpoint) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](#monitoringopentelemetryopentelemetryprotocolexportprocessortype) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](#monitoringopentelemetryopentelemetryprotocolheaders) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](#monitoringopentelemetryopentelemetryprotocolprotocol) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](#monitoringopentelemetryopentelemetryprotocoltimeout) + [Monitoring.OpenTelemetry.ServiceInstanceId](#monitoringopentelemetryserviceinstanceid) + [Monitoring.OpenTelemetry.ServiceName](#monitoringopentelemetryservicename) + [Monitoring.OpenTelemetry.ServiceNamespace](#monitoringopentelemetryservicenamespace) * SNMP monitoring - [Monitoring.Snmp.AuthenticationPassword](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpassword) - [Monitoring.Snmp.AuthenticationPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpasswordsecondary) - [Monitoring.Snmp.AuthenticationProtocol](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocol) - [Monitoring.Snmp.AuthenticationProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocolsecondary) - [Monitoring.Snmp.AuthenticationUser](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationuser) - [Monitoring.Snmp.AuthenticationUser.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationusersecondary) - [Monitoring.Snmp.Community](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) - [Monitoring.Snmp.DisableTimeWindowChecks](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpdisabletimewindowchecks) - [Monitoring.Snmp.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpenabled) - [Monitoring.Snmp.Port](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpport) - [Monitoring.Snmp.PrivacyPassword](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypassword) - [Monitoring.Snmp.PrivacyPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypasswordsecondary) - [Monitoring.Snmp.PrivacyProtocol](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocol) - [Monitoring.Snmp.PrivacyProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocolsecondary) - [Monitoring.Snmp.SupportedVersions](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpsupportedversions) + [Monitoring.Snmp.AuthenticationPassword](#monitoringsnmpauthenticationpassword) + [Monitoring.Snmp.AuthenticationPassword.Secondary](#monitoringsnmpauthenticationpasswordsecondary) + [Monitoring.Snmp.AuthenticationProtocol](#monitoringsnmpauthenticationprotocol) + [Monitoring.Snmp.AuthenticationProtocol.Secondary](#monitoringsnmpauthenticationprotocolsecondary) + [Monitoring.Snmp.AuthenticationUser](#monitoringsnmpauthenticationuser) + [Monitoring.Snmp.AuthenticationUser.Secondary](#monitoringsnmpauthenticationusersecondary) + [Monitoring.Snmp.Community](#monitoringsnmpcommunity) + [Monitoring.Snmp.DisableTimeWindowChecks](#monitoringsnmpdisabletimewindowchecks) + [Monitoring.Snmp.Enabled](#monitoringsnmpenabled) + [Monitoring.Snmp.Port](#monitoringsnmpport) + [Monitoring.Snmp.PrivacyPassword](#monitoringsnmpprivacypassword) + [Monitoring.Snmp.PrivacyPassword.Secondary](#monitoringsnmpprivacypasswordsecondary) + [Monitoring.Snmp.PrivacyProtocol](#monitoringsnmpprivacyprotocol) + [Monitoring.Snmp.PrivacyProtocol.Secondary](#monitoringsnmpprivacyprotocolsecondary) + [Monitoring.Snmp.SupportedVersions](#monitoringsnmpsupportedversions) * Other monitoring: - [Monitoring.Cpu.Exec](../../server/configuration/monitoring-configuration.mdx#monitoringcpuexec) - [Monitoring.Cpu.Exec.Arguments](../../server/configuration/monitoring-configuration.mdx#monitoringcpuexecarguments) - [Monitoring.Disk.ReadStatsDebounceTimeInMs](../../server/configuration/monitoring-configuration.mdx#monitoringdiskreadstatsdebouncetimeinms) + [Monitoring.Cpu.Exec](#monitoringcpuexec) + [Monitoring.Cpu.Exec.Arguments](#monitoringcpuexecarguments) + [Monitoring.Disk.ReadStatsDebounceTimeInMs](#monitoringdiskreadstatsdebouncetimeinms) @@ -257,7 +257,7 @@ OpenTelemetryProtocol timeout value. * Sets the OpenTelemetry **service name**. This value is reported as the `service.name` resource attribute and is used to identify the RavenDB service in observability tools, such as the .NET Aspire dashboard. -* If [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) is set to `true`, +* If [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) is set to `true`, the effective value must not be `null`, empty, or whitespace. Otherwise, the server will fail to start. @@ -274,7 +274,7 @@ OpenTelemetryProtocol timeout value. * Sets the OpenTelemetry **service namespace**. This value is reported as the `service.namespace` resource attribute and is used to group related services together in observability tools. -* If [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) is set to `true`, +* If [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) is set to `true`, the effective value must not be `null`, empty, or whitespace. Otherwise, the server will fail to start. diff --git a/versioned_docs/version-6.2/server/configuration/patching-configuration.mdx b/versioned_docs/version-6.2/server/configuration/patching-configuration.mdx index 081e55e895..613dc8b1b1 100644 --- a/versioned_docs/version-6.2/server/configuration/patching-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/patching-configuration.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Set-base patch operations](../../client-api/operations/patching/set-based.mdx) * [Apply patching from the Studio](../../studio/database/documents/patch-view.mdx) * In this article: - * [Patching.AllowStringCompilation](../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) - * [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) - * [Patching.StrictMode](../../server/configuration/patching-configuration.mdx#patchingstrictmode) + * [Patching.AllowStringCompilation](#patchingallowstringcompilation) + * [Patching.MaxStepsForScript](#patchingmaxstepsforscript) + * [Patching.StrictMode](#patchingstrictmode) ## Patching.AllowStringCompilation diff --git a/versioned_docs/version-6.2/server/configuration/performance-hints-configuration.mdx b/versioned_docs/version-6.2/server/configuration/performance-hints-configuration.mdx index d0135f6555..e4f488f395 100644 --- a/versioned_docs/version-6.2/server/configuration/performance-hints-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/performance-hints-configuration.mdx @@ -15,15 +15,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [PerformanceHints.Documents.HugeDocumentsCollectionSize](../../server/configuration/performance-hints-configuration.mdx#performancehintsdocumentshugedocumentscollectionsize) - * [PerformanceHints.Documents.HugeDocumentSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehintsdocumentshugedocumentsizeinmb) - * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingalertwhensourcedocumentincludedinoutput) - * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxdepthofrecursioninlinqselect) - * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) - * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxnumberofloadsperreference) - * [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) - * [PerformanceHints.Memory.MinSwapSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehintsmemoryminswapsizeinmb) - * [PerformanceHints.TooLongRequestThresholdInSec](../../server/configuration/performance-hints-configuration.mdx#performancehintstoolongrequestthresholdinsec) + * [PerformanceHints.Documents.HugeDocumentsCollectionSize](#performancehintsdocumentshugedocumentscollectionsize) + * [PerformanceHints.Documents.HugeDocumentSizeInMb](#performancehintsdocumentshugedocumentsizeinmb) + * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](#performancehintsindexingalertwhensourcedocumentincludedinoutput) + * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](#performancehintsindexingmaxdepthofrecursioninlinqselect) + * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](#performancehintsindexingmaxindexoutputsperdocument) + * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](#performancehintsindexingmaxnumberofloadsperreference) + * [PerformanceHints.MaxNumberOfResults](#performancehintsmaxnumberofresults) + * [PerformanceHints.Memory.MinSwapSizeInMb](#performancehintsmemoryminswapsizeinmb) + * [PerformanceHints.TooLongRequestThresholdInSec](#performancehintstoolongrequestthresholdinsec) ## PerformanceHints.Documents.HugeDocumentsCollectionSize diff --git a/versioned_docs/version-6.2/server/configuration/security-configuration.mdx b/versioned_docs/version-6.2/server/configuration/security-configuration.mdx index f84d3e3729..4f51b16a6b 100644 --- a/versioned_docs/version-6.2/server/configuration/security-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/security-configuration.mdx @@ -19,50 +19,50 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Security.AuditLog: - [Security.AuditLog.Compress](../../server/configuration/security-configuration.mdx#securityauditlogcompress) - [Security.AuditLog.FolderPath](../../server/configuration/security-configuration.mdx#securityauditlogfolderpath) - [Security.AuditLog.RetentionSizeInMb](../../server/configuration/security-configuration.mdx#securityauditlogretentionsizeinmb) - [Security.AuditLog.RetentionTimeInHours](../../server/configuration/security-configuration.mdx#securityauditlogretentiontimeinhourssecurityauditlogretentiontimeinhrs) + [Security.AuditLog.Compress](#securityauditlogcompress) + [Security.AuditLog.FolderPath](#securityauditlogfolderpath) + [Security.AuditLog.RetentionSizeInMb](#securityauditlogretentionsizeinmb) + [Security.AuditLog.RetentionTimeInHours](#securityauditlogretentiontimeinhourssecurityauditlogretentiontimeinhrs) * Security.Certificate: - [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) - [Security.Certificate.Change.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificatechangeexecarguments) - [Security.Certificate.Exec](../../server/configuration/security-configuration.mdx#securitycertificateexec) - [Security.Certificate.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitycertificateexectimeoutinsec) - [Security.Certificate.ExpiringThresholdInDays](../../server/configuration/security-configuration.mdx#securitycertificateexpiringthresholdindays) - [Security.Certificate.LetsEncrypt.Email](../../server/configuration/security-configuration.mdx#securitycertificateletsencryptemail) - [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) - [Security.Certificate.Load.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificateloadexecarguments) - [Security.Certificate.Password](../../server/configuration/security-configuration.mdx#securitycertificatepassword) - [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) - [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) - [Security.Certificate.Renew.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) - [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexec) - [Security.Certificate.Validation.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) - [Security.Certificate.Validation.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexectimeoutinsec) - [Security.Certificate.Validation.KeyUsages](../../server/configuration/security-configuration.mdx#securitycertificatevalidationkeyusages) + [Security.Certificate.Change.Exec](#securitycertificatechangeexec) + [Security.Certificate.Change.Exec.Arguments](#securitycertificatechangeexecarguments) + [Security.Certificate.Exec](#securitycertificateexec) + [Security.Certificate.Exec.TimeoutInSec](#securitycertificateexectimeoutinsec) + [Security.Certificate.ExpiringThresholdInDays](#securitycertificateexpiringthresholdindays) + [Security.Certificate.LetsEncrypt.Email](#securitycertificateletsencryptemail) + [Security.Certificate.Load.Exec](#securitycertificateloadexec) + [Security.Certificate.Load.Exec.Arguments](#securitycertificateloadexecarguments) + [Security.Certificate.Password](#securitycertificatepassword) + [Security.Certificate.Path](#securitycertificatepath) + [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) + [Security.Certificate.Renew.Exec.Arguments](#securitycertificaterenewexecarguments) + [Security.Certificate.Validation.Exec](#securitycertificatevalidationexec) + [Security.Certificate.Validation.Exec.Arguments](#securitycertificatevalidationexecarguments) + [Security.Certificate.Validation.Exec.TimeoutInSec](#securitycertificatevalidationexectimeoutinsec) + [Security.Certificate.Validation.KeyUsages](#securitycertificatevalidationkeyusages) * Security.Csrf: - [Security.Csrf.AdditionalOriginHeaders](../../server/configuration/security-configuration.mdx#securitycsrfadditionaloriginheaders) - [Security.Csrf.Enabled](../../server/configuration/security-configuration.mdx#securitycsrfenabled) - [Security.Csrf.TrustedOrigins](../../server/configuration/security-configuration.mdx#securitycsrftrustedorigins) + [Security.Csrf.AdditionalOriginHeaders](#securitycsrfadditionaloriginheaders) + [Security.Csrf.Enabled](#securitycsrfenabled) + [Security.Csrf.TrustedOrigins](#securitycsrftrustedorigins) * Security.MasterKey: - [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) - [Security.MasterKey.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitymasterkeyexecarguments) - [Security.MasterKey.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitymasterkeyexectimeoutinsec) - [Security.MasterKey.Path](../../server/configuration/security-configuration.mdx#securitymasterkeypath) + [Security.MasterKey.Exec](#securitymasterkeyexec) + [Security.MasterKey.Exec.Arguments](#securitymasterkeyexecarguments) + [Security.MasterKey.Exec.TimeoutInSec](#securitymasterkeyexectimeoutinsec) + [Security.MasterKey.Path](#securitymasterkeypath) * Security.TwoFactor: - [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactordefaultsessiondurationinmin) - [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactormaxsessiondurationinmin) + [Security.TwoFactor.DefaultSessionDurationInMin](#securitytwofactordefaultsessiondurationinmin) + [Security.TwoFactor.MaxSessionDurationInMin](#securitytwofactormaxsessiondurationinmin) * Certificate and issuer validation: - [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) - [Security.WellKnownIssuerHashes.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuerhashesadmin) - [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) - [Security.WellKnownIssuers.Admin.ValidateCertificateNames](../../server/configuration/security-configuration.mdx#securitywellknownissuersadminvalidatecertificatenames) + [Security.WellKnownCertificates.Admin](#securitywellknowncertificatesadmin) + [Security.WellKnownIssuerHashes.Admin](#securitywellknownissuerhashesadmin) + [Security.WellKnownIssuers.Admin](#securitywellknownissuersadmin) + [Security.WellKnownIssuers.Admin.ValidateCertificateNames](#securitywellknownissuersadminvalidatecertificatenames) * Other: - [Security.DisableHsts](../../server/configuration/security-configuration.mdx#securitydisablehsts) - [Security.DisableHttpsRedirection](../../server/configuration/security-configuration.mdx#securitydisablehttpsredirection) - [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror) - [Security.TlsCipherSuites](../../server/configuration/security-configuration.mdx#securitytlsciphersuites) - [Security.UnsecuredAccessAllowed](../../server/configuration/security-configuration.mdx#securityunsecuredaccessallowed) + [Security.DisableHsts](#securitydisablehsts) + [Security.DisableHttpsRedirection](#securitydisablehttpsredirection) + [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](#securitydonotconsidermemorylockfailureascatastrophicerror) + [Security.TlsCipherSuites](#securitytlsciphersuites) + [Security.UnsecuredAccessAllowed](#securityunsecuredaccessallowed) ## Security.AuditLog.Compress @@ -113,7 +113,7 @@ The number of hours audit logs are kept before they are deleted. A command or executable that handles cluster certificate changes. This executable allows you to implement your own custom logic for persisting the new certificate on all nodes. -Note: it will only be triggered if [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) is not defined. +Note: it will only be triggered if [Security.Certificate.Path](#securitycertificatepath) is not defined. - **Type**: `string` - **Default**: `null` @@ -123,7 +123,7 @@ Note: it will only be triggered if [Security.Certificate.Path](../../server/conf ## Security.Certificate.Change.Exec.Arguments -The command line arguments for the [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) command or executable. +The command line arguments for the [Security.Certificate.Change.Exec](#securitycertificatechangeexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -134,9 +134,9 @@ The command line arguments for the [Security.Certificate.Change.Exec](../../serv ## Security.Certificate.Exec Deprecated. -Use [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) -along with [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) -and [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) instead. +Use [Security.Certificate.Load.Exec](#securitycertificateloadexec) +along with [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) +and [Security.Certificate.Change.Exec](#securitycertificatechangeexec) instead. @@ -144,9 +144,9 @@ and [Security.Certificate.Change.Exec](../../server/configuration/security-confi * The number of seconds to wait for the certificate executables to exit. * Applies to: - * [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) - * [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) - * [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) + * [Security.Certificate.Load.Exec](#securitycertificateloadexec) + * [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) + * [Security.Certificate.Change.Exec](#securitycertificatechangeexec) - **Type**: `int` - **Default**: `30` - **Scope**: Server-wide only @@ -179,7 +179,7 @@ Used for renewal requests. * A command or executable that provides the `.pfx` cluster certificate when invoked by RavenDB. If specified, RavenDB will use HTTPS/SSL for all network activities. -* The [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) setting takes precedence over this executable. +* The [Security.Certificate.Path](#securitycertificatepath) setting takes precedence over this executable. * Learn more in [get certificate via loader](../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage). - **Type**: `string` @@ -190,7 +190,7 @@ Used for renewal requests. ## Security.Certificate.Load.Exec.Arguments -The command line arguments for the [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) command or executable. +The command line arguments for the [Security.Certificate.Load.Exec](#securitycertificateloadexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -228,7 +228,7 @@ Certificate setting priority order: * The [leader node](../../server/clustering/rachis/cluster-topology.mdx#leader) will invoke this executable once every hour, and if a new certificate is received, it will be sent to all other nodes. -* The executable specified in [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) +* The executable specified in [Security.Certificate.Change.Exec](#securitycertificatechangeexec) will then be used to persist the certificate across the cluster on all nodes. - **Type**: `string` - **Default**: `null` @@ -238,7 +238,7 @@ Certificate setting priority order: ## Security.Certificate.Renew.Exec.Arguments -The command line arguments for the [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) command or executable. +The command line arguments for the [Security.Certificate.Renew.Exec](#securitycertificaterenewexecarguments) command or executable. - **Type**: `string` - **Default**: `null` @@ -265,7 +265,7 @@ The executable will return a case-insensitive boolean string through the standar EXPERT ONLY: -The optional user arguments for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) command or executable. +The optional user arguments for the [Security.Certificate.Validation.Exec](#securitycertificatevalidationexecarguments) command or executable. The arguments must be escaped for the command line. - **Type**: `string` @@ -276,7 +276,7 @@ The arguments must be escaped for the command line. ## Security.Certificate.Validation.Exec.TimeoutInSec -The number of seconds to wait for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) executable to exit. +The number of seconds to wait for the [Security.Certificate.Validation.Exec](#securitycertificatevalidationexecarguments) executable to exit. - **Type**: `int` - **Default**: `5` @@ -341,7 +341,7 @@ If specified, RavenDB will use this key to protect secrets. ## Security.MasterKey.Exec.Arguments -The command line arguments for the [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) command or executable. +The command line arguments for the [Security.MasterKey.Exec](#securitymasterkeyexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -408,7 +408,7 @@ Specify well known certificate thumbprints that will be trusted by the server as OBSOLETE. This is no longer supported or used. -Use [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) instead. +Use [Security.WellKnownIssuers.Admin](#securitywellknownissuersadmin) instead. diff --git a/versioned_docs/version-6.2/server/configuration/server-configuration.mdx b/versioned_docs/version-6.2/server/configuration/server-configuration.mdx index 4a5764017a..5175a507c1 100644 --- a/versioned_docs/version-6.2/server/configuration/server-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/server-configuration.mdx @@ -17,12 +17,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Various configuration options for the server's behavior. * In this page: - * [Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec](../../server/configuration/server-configuration.mdx#servermaxtimefortasktowaitfordatabasetoloadinsec) - * [Server.ProcessAffinityMask](../../server/configuration/server-configuration.mdx#serverprocessaffinitymask) - * [Server.IndexingAffinityMask](../../server/configuration/server-configuration.mdx#serverindexingaffinitymask) - * [Server.NumberOfUnusedCoresByIndexes](../../server/configuration/server-configuration.mdx#servernumberofunusedcoresbyindexes) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../../server/configuration/server-configuration.mdx#servercpucreditsexhaustionbackupdelayinmin) - * [Server.Tcp.Compression.Disable](../../server/configuration/server-configuration.mdx#servertcpcompressiondisable) + * [Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec](#servermaxtimefortasktowaitfordatabasetoloadinsec) + * [Server.ProcessAffinityMask](#serverprocessaffinitymask) + * [Server.IndexingAffinityMask](#serverindexingaffinitymask) + * [Server.NumberOfUnusedCoresByIndexes](#servernumberofunusedcoresbyindexes) + * [Server.CpuCredits.ExhaustionBackupDelayInMin](#servercpucreditsexhaustionbackupdelayinmin) + * [Server.Tcp.Compression.Disable](#servertcpcompressiondisable) ## Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec diff --git a/versioned_docs/version-6.2/server/configuration/subscription-configuration.mdx b/versioned_docs/version-6.2/server/configuration/subscription-configuration.mdx index ad34d3c879..e6f3f9c33a 100644 --- a/versioned_docs/version-6.2/server/configuration/subscription-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/subscription-configuration.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more about subscriptions in [Data subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx). * In this article: - * [Subscriptions.ArchivedDataProcessingBehavior](../../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) - * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptionsmaxnumberofconcurrentconnections) + * [Subscriptions.ArchivedDataProcessingBehavior](#subscriptionsarchiveddataprocessingbehavior) + * [Subscriptions.MaxNumberOfConcurrentConnections](#subscriptionsmaxnumberofconcurrentconnections) diff --git a/versioned_docs/version-6.2/server/content/_embedded-csharp.mdx b/versioned_docs/version-6.2/server/content/_embedded-csharp.mdx index 6613c7a0e4..9c02d1a8ab 100644 --- a/versioned_docs/version-6.2/server/content/_embedded-csharp.mdx +++ b/versioned_docs/version-6.2/server/content/_embedded-csharp.mdx @@ -9,22 +9,22 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../server/embedded.mdx#overview) - * [Prerequisites and Recommendations](../../server/embedded.mdx#prerequisites-and-recommendations) - * [Installation](../../server/embedded.mdx#installation) - * [Starting the server](../../server/embedded.mdx#starting-the-server) - * [Server options](../../server/embedded.mdx#server-options) - * [Setting server directory](../../server/embedded.mdx#setting-server-directory) - * [Restarting the server](../../server/embedded.mdx#restarting-the-server) - * [ServerProcessExited Event](../../server/embedded.mdx#serverprocessexited-event) - * [Embedded server licensing](../../server/embedded.mdx#embedded-server-licensing) - * [Licensing configuration options](../../server/embedded.mdx#licensing-configuration-options) - * [License an embedded server using an Environment variable](../../server/embedded.mdx#license-an-embedded-server-using-an-environment-variable) - * [`.NET` FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) - * [Security](../../server/embedded.mdx#security) - * [Document store](../../server/embedded.mdx#document-store) - * [Get server URL and process ID](../../server/embedded.mdx#get-server-url-and-process-id) - * [Remarks](../../server/embedded.mdx#remarks) + * [Overview](#overview) + * [Prerequisites and Recommendations](#prerequisites-and-recommendations) + * [Installation](#installation) + * [Starting the server](#starting-the-server) + * [Server options](#server-options) + * [Setting server directory](#setting-server-directory) + * [Restarting the server](#restarting-the-server) + * [ServerProcessExited Event](#serverprocessexited-event) + * [Embedded server licensing](#embedded-server-licensing) + * [Licensing configuration options](#licensing-configuration-options) + * [License an embedded server using an Environment variable](#license-an-embedded-server-using-an-environment-variable) + * [`.NET` FrameworkVersion](#net-frameworkversion) + * [Security](#security) + * [Document store](#document-store) + * [Get server URL and process ID](#get-server-url-and-process-id) + * [Remarks](#remarks) ## Overview @@ -67,14 +67,14 @@ using (var store = await EmbeddedServer.Instance.GetDocumentStoreAsync("Embedded * **Prerequisites** * Install [`.NET` Core runtime](https://dotnet.microsoft.com/en-us/download), - either manually or [along with a RavenDB full version](../embedded.mdx#setting-server-directory). - * Verify that the RavenDB server [FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) + either manually or [along with a RavenDB full version](#setting-server-directory). + * Verify that the RavenDB server [FrameworkVersion](#net-frameworkversion) definition matches the `.NET` Core version that you install. * **Recommendations** * Projects targeting `.NET Framework 4.6.1+` that use the old `packages.config` for NuGet packages maintenance, should migrate to `PackageReference` package management. - Find additional details [below](../../server/embedded.mdx#migrating-from--to--in-old-csproj-projects). + Find additional details [below](#migrating-from--to--in-old-csproj-projects). ### `.NET` Core Runtime: RavenDB Embedded **does not include** the `.NET` Core runtime engine required for its operation. @@ -175,7 +175,7 @@ and additional options. | **ServerUrl** | `string` | What address we want to start our server (default `127.0.0.1:0`) | | **MaxServerStartupTimeDuration** | `TimeSpan` | The timeout for the server to start | | **CommandLineArgs** | `List` | The [command lines arguments](../../server/configuration/configuration-options.mdx#command-line-arguments) to start the server with | -| **ServerDirectory** | `string` | The path to the server binary files<sup>[*](../../server/embedded.mdx#setting-server-directory) | +| **ServerDirectory** | `string` | The path to the server binary files<sup>[*](#setting-server-directory) | diff --git a/versioned_docs/version-6.2/server/extensions/content/_expiration-csharp.mdx b/versioned_docs/version-6.2/server/extensions/content/_expiration-csharp.mdx index 2652a382ec..a34339b38d 100644 --- a/versioned_docs/version-6.2/server/extensions/content/_expiration-csharp.mdx +++ b/versioned_docs/version-6.2/server/extensions/content/_expiration-csharp.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * You can enable or disable the expiration feature while the database is already live with data. * In this page: - * [Expiration feature usages](../../../server/extensions/expiration.mdx#expiration-feature-usages) - * [Configuring the expiration feature](../../../server/extensions/expiration.mdx#configuring-the-expiration-feature) - * [Configure expiration settings using the client API](../../../server/extensions/expiration.mdx#configure-expiration-settings-using-the-client-api) - * [Setting the document expiration time](../../../server/extensions/expiration.mdx#setting-the-document-expiration-time) - * [Eventual consistency considerations](../../../server/extensions/expiration.mdx#eventual-consistency-considerations) + * [Expiration feature usages](#expiration-feature-usages) + * [Configuring the expiration feature](#configuring-the-expiration-feature) + * [Configure expiration settings using the client API](#configure-expiration-settings-using-the-client-api) + * [Setting the document expiration time](#setting-the-document-expiration-time) + * [Eventual consistency considerations](#eventual-consistency-considerations) ## Expiration feature usages @@ -101,7 +101,7 @@ object and sending it to RavenDB using a `ConfigureExpirationOperation` operatio * If and when the expiration feature is enabled, it will process all documents carrying the `@expires` flag and automatically delete each document - [by its expiration time](../../../server/extensions/expiration.mdx#eventual-consistency-considerations). + [by its expiration time](#eventual-consistency-considerations). * To set the document expiration time from the client, use the following code: diff --git a/versioned_docs/version-6.2/server/extensions/content/_expiration-nodejs.mdx b/versioned_docs/version-6.2/server/extensions/content/_expiration-nodejs.mdx index 434db5583e..72e2e60ada 100644 --- a/versioned_docs/version-6.2/server/extensions/content/_expiration-nodejs.mdx +++ b/versioned_docs/version-6.2/server/extensions/content/_expiration-nodejs.mdx @@ -10,10 +10,10 @@ import CodeBlock from '@theme/CodeBlock'; * You can enable or disable the expiration feature while the database is already live with data. * In this page: - * [Expiration feature usages](../../../server/extensions/expiration.mdx#expiration-feature-usages) - * [Configuring the expiration feature](../../../server/extensions/expiration.mdx#configuring-the-expiration-feature) - * [Setting the document expiration time](../../../server/extensions/expiration.mdx#setting-the-document-expiration-time) - * [Eventual consistency considerations](../../../server/extensions/expiration.mdx#eventual-consistency-considerations) + * [Expiration feature usages](#expiration-feature-usages) + * [Configuring the expiration feature](#configuring-the-expiration-feature) + * [Setting the document expiration time](#setting-the-document-expiration-time) + * [Eventual consistency considerations](#eventual-consistency-considerations) ## Expiration feature usages diff --git a/versioned_docs/version-6.2/server/extensions/content/_refresh-csharp.mdx b/versioned_docs/version-6.2/server/extensions/content/_refresh-csharp.mdx index 7b5e51c496..84dda44c34 100644 --- a/versioned_docs/version-6.2/server/extensions/content/_refresh-csharp.mdx +++ b/versioned_docs/version-6.2/server/extensions/content/_refresh-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Refresh is scheduled using the `@refresh` flag in a document's [metadata](../../../client-api/session/how-to/get-and-modify-entity-metadata.mdx). * In this page: - * [Overview](../../../server/extensions/refresh.mdx#overview) - * [Examples](../../../server/extensions/refresh.mdx#examples) - * [Syntax](../../../server/extensions/refresh.mdx#syntax) - * [Configure from Studio](../../../server/extensions/refresh.mdx#configure-from-studio) + * [Overview](#overview) + * [Examples](#examples) + * [Syntax](#syntax) + * [Configure from Studio](#configure-from-studio) @@ -35,7 +35,7 @@ import CodeBlock from '@theme/CodeBlock'; 1. The refresh time value set for the `@refresh` property. - 2. The way you set the [Refresh Configuration](../../../server/extensions/refresh.mdx#syntax), + 2. The way you set the [Refresh Configuration](#syntax), including - - The interval by which the server refreshes documents (set by default to 60 seconds). - The way you set **maximal items to process**, potentially limiting the number diff --git a/versioned_docs/version-6.2/server/extensions/content/_refresh-nodejs.mdx b/versioned_docs/version-6.2/server/extensions/content/_refresh-nodejs.mdx index fdf9a64a1f..33a6ec49e5 100644 --- a/versioned_docs/version-6.2/server/extensions/content/_refresh-nodejs.mdx +++ b/versioned_docs/version-6.2/server/extensions/content/_refresh-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Refresh is scheduled using the `@refresh` flag in a document's [metadata](../../../client-api/session/how-to/get-and-modify-entity-metadata.mdx). * In this page: - * [Overview](../../../server/extensions/refresh.mdx#overview) - * [Examples](../../../server/extensions/refresh.mdx#examples) - * [Syntax](../../../server/extensions/refresh.mdx#syntax) - * [Configure from Studio](../../../server/extensions/refresh.mdx#configure-from-studio) + * [Overview](#overview) + * [Examples](#examples) + * [Syntax](#syntax) + * [Configure from Studio](#configure-from-studio) ## Overview diff --git a/versioned_docs/version-6.2/server/kb/content/_document-identifier-generation-csharp.mdx b/versioned_docs/version-6.2/server/kb/content/_document-identifier-generation-csharp.mdx index ede36ea509..d938fda326 100644 --- a/versioned_docs/version-6.2/server/kb/content/_document-identifier-generation-csharp.mdx +++ b/versioned_docs/version-6.2/server/kb/content/_document-identifier-generation-csharp.mdx @@ -15,18 +15,18 @@ import Panel from '@site/src/components/Panel'; To create a document from the Studio, see [Create new document](../../../studio/database/documents/create-new-document.mdx#create-new-document). * In this article: - * [Overview](../../../server/kb/document-identifier-generation.mdx#overview) - * [ID types](../../../server/kb/document-identifier-generation.mdx#id-types) - * [ID structure](../../../server/kb/document-identifier-generation.mdx#id-structure) - * [ID limitations](../../../server/kb/document-identifier-generation.mdx#id-limitations) - * [Document IDs:](../../../server/kb/document-identifier-generation.mdx#document-ids) - * [Semantic ID](../../../server/kb/document-identifier-generation.mdx#semantic-id) - * [GUID](../../../server/kb/document-identifier-generation.mdx#guid) - * [Server-side ID](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * [Identity ID](../../../server/kb/document-identifier-generation.mdx#identity-id) - * [HiLo algorithm ID](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) - * [Artificial document ID](../../../server/kb/document-identifier-generation.mdx#artificial-document-id) - * [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character) + * [Overview](#overview) + * [ID types](#id-types) + * [ID structure](#id-structure) + * [ID limitations](#id-limitations) + * [Document IDs:](#document-ids) + * [Semantic ID](#semantic-id) + * [GUID](#guid) + * [Server-side ID](#server-side-id) + * [Identity ID](#identity-id) + * [HiLo algorithm ID](#hilo-algorithm-id) + * [Artificial document ID](#artificial-document-id) + * [Customizing the separator character](#customizing-the-separator-character) @@ -39,22 +39,22 @@ RavenDB supports several document ID types, where the ID string can be generated * **Defined by the user**: You explicitly specify the document ID. - * [Semantic ID](../../../server/kb/document-identifier-generation.mdx#semantic-id) + * [Semantic ID](#semantic-id) * **Generated by the server**: The server generates the document ID based on the ID string format you provide when creating the document. - * [GUID](../../../server/kb/document-identifier-generation.mdx#guid) - * [Server-side ID](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * [Identity ID](../../../server/kb/document-identifier-generation.mdx#identity-id) + * [GUID](#guid) + * [Server-side ID](#server-side-id) + * [Identity ID](#identity-id) * **Generated by the client (from a range provided by the server)**: The server assigns a range of IDs to the client upon request. The client then uses that range to generate document IDs locally within the session. - * [HiLo algorithm ID](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) + * [HiLo algorithm ID](#hilo-algorithm-id) * **Generated from a Map-Reduce index output**: The ID is generated by the server when saving map-reduce results as artificial documents. - * [Artificial document ID](../../../server/kb/document-identifier-generation.mdx#artificial-document-id) + * [Artificial document ID](#artificial-document-id) @@ -67,9 +67,9 @@ For example: `users/123-A` (HiLo ID), or `users/000000000001-A` (Server-side ID) This structure is common but not mandatory: * RavenDB does not require the ID to include a collection prefix. - * The default slash separator (`/`) can be **customized** for [HiLo IDs](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) - and [Identity IDs](../../../server/kb/document-identifier-generation.mdx#identity-id). - See [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character) below. + * The default slash separator (`/`) can be **customized** for [HiLo IDs](#hilo-algorithm-id) + and [Identity IDs](#identity-id). + See [Customizing the separator character](#customizing-the-separator-character) below. @@ -80,8 +80,8 @@ The following limitations apply to document IDs: * Maximum length: `512` bytes (in UTF-8) * Document IDs cannot end with the following reserved characters: - * `/` - reserved for [Server-side ID generation](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * `|` - reserved for [Identity ID generation](../../../server/kb/document-identifier-generation.mdx#identity-id) + * `/` - reserved for [Server-side ID generation](#server-side-id) + * `|` - reserved for [Identity ID generation](#identity-id) @@ -230,7 +230,7 @@ using (var session = store.OpenSession()) The leading zeros in server-side generated IDs help reduce the risk of such accidental collisions. * **Customizing the separator character**: - The separator character can be customized. See: [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + The separator character can be customized. See: [Customizing the separator character](#customizing-the-separator-character). If it was modified (e.g., to `$`), you must end your ID string with that character instead of `/`. --- @@ -308,7 +308,7 @@ using (var session = store.OpenSession()) * **Customizing the separator character**: The separator character used in the identity IDs can be customized. - Learn more in [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + Learn more in [Customizing the separator character](#customizing-the-separator-character). * **Customizing the identity number**: The numeric part of an identity ID is an always-incrementing value managed by the server. @@ -375,7 +375,7 @@ using (var session = store.OpenSession()) * **Customizing the separator character**: The separator character used in the HiLo document IDs can be customized. - Learn more in [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + Learn more in [Customizing the separator character](#customizing-the-separator-character). --- @@ -425,8 +425,8 @@ using (var session = store.OpenSession()) -The separator character used in the [Identity](../../../server/kb/document-identifier-generation.mdx#identity-id), -[HiLo](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id), and [Server-side](../../../server/kb/document-identifier-generation.mdx#server-side-id) document IDs can be customized. +The separator character used in the [Identity](#identity-id), +[HiLo](#hilo-algorithm-id), and [Server-side](#server-side-id) document IDs can be customized. By default, the separator is a _slash_ (`/`), but this can be changed to any other character, except _pipe_ (`|`). There are several ways to customize the separator. diff --git a/versioned_docs/version-6.2/server/kb/javascript-engine.mdx b/versioned_docs/version-6.2/server/kb/javascript-engine.mdx index 317ac7f690..ce94eeea52 100644 --- a/versioned_docs/version-6.2/server/kb/javascript-engine.mdx +++ b/versioned_docs/version-6.2/server/kb/javascript-engine.mdx @@ -29,8 +29,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; RavenDB uses [Jint](https://github.com/sebastienros/jint), an open source JavaScript interpreter supporting ECMAScript 5.1. * In this page: - * [How RavenDB uses Jint](../../server/kb/javascript-engine.mdx#how-ravendb-uses-jint) - * [Predefined JavaScript functions](../../server/kb/javascript-engine.mdx#predefined-javascript-functions) + * [How RavenDB uses Jint](#how-ravendb-uses-jint) + * [Predefined JavaScript functions](#predefined-javascript-functions) diff --git a/versioned_docs/version-6.2/server/kb/numbers-in-ravendb.mdx b/versioned_docs/version-6.2/server/kb/numbers-in-ravendb.mdx index aaba9fe80c..0c2baa8c63 100644 --- a/versioned_docs/version-6.2/server/kb/numbers-in-ravendb.mdx +++ b/versioned_docs/version-6.2/server/kb/numbers-in-ravendb.mdx @@ -24,12 +24,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [About numbers](../../server/kb/numbers-in-ravendb.mdx#about-numbers) -* [Numbers in documents](../../server/kb/numbers-in-ravendb.mdx#numbers-in-documents) -* [Numbers in JavaScript](../../server/kb/numbers-in-ravendb.mdx#numbers-in-javascript-engine) -* [Numbers in indexes and queries](../../server/kb/numbers-in-ravendb.mdx#numbers-in-indexes-and-queries) -* [Numbers in studio](../../server/kb/numbers-in-ravendb.mdx#numbers-in-management-studio) -* [Numbers in client API](../../server/kb/numbers-in-ravendb.mdx#numbers-in-client-api) +* [About numbers](#about-numbers) +* [Numbers in documents](#numbers-in-documents) +* [Numbers in JavaScript](#numbers-in-javascript-engine) +* [Numbers in indexes and queries](#numbers-in-indexes-and-queries) +* [Numbers in studio](#numbers-in-management-studio) +* [Numbers in client API](#numbers-in-client-api) diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/backup-overview.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/backup-overview.mdx index 23d9f25295..7c37d546f8 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/backup-overview.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/backup-overview.mdx @@ -36,27 +36,27 @@ import LanguageContent from "@site/src/components/LanguageContent"; Read about backups on a sharded database [in the section dedicated to it](../../sharding/backup-and-restore/backup.mdx). * In this page: - * [Backup Type](../../server/ongoing-tasks/backup-overview.mdx#backup-type) - * [Backup Contents](../../server/ongoing-tasks/backup-overview.mdx#backup-contents) + * [Backup Type](#backup-type) + * [Backup Contents](#backup-contents) * [Backup Scope: Full or Incremental](../../server/ongoing-tasks/backup-overview.mdx#backup-scope:-full-or-incremental) - * [Backup Name and Folder Structure](../../server/ongoing-tasks/backup-overview.mdx#backup-name-and-folder-structure) - * [Encryption](../../server/ongoing-tasks/backup-overview.mdx#encryption) - * [Compression](../../server/ongoing-tasks/backup-overview.mdx#compression) - * [Retention Policy](../../server/ongoing-tasks/backup-overview.mdx#retention-policy) - * [Restoration Procedure](../../server/ongoing-tasks/backup-overview.mdx#restoration-procedure) + * [Backup Name and Folder Structure](#backup-name-and-folder-structure) + * [Encryption](#encryption) + * [Compression](#compression) + * [Retention Policy](#retention-policy) + * [Restoration Procedure](#restoration-procedure) ## Backup Type There are two backup types: [Logical-backup](../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup) (or simply "Backup") and [Snapshot](../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot). #### Logical Backup - A logical backup is a compressed JSON dump of database contents, including documents, index definitions, and [additional data](../../server/ongoing-tasks/backup-overview.mdx#backup-contents) - that can be stored in [full](../../server/ongoing-tasks/backup-overview.mdx#full-backup) and [incremental](../../server/ongoing-tasks/backup-overview.mdx#incremental-backup) backups. + A logical backup is a compressed JSON dump of database contents, including documents, index definitions, and [additional data](#backup-contents) + that can be stored in [full](#full-backup) and [incremental](#incremental-backup) backups. * After a database restore, the dataset is re-indexed by the backed-up index definitions. This can be time-consuming in large datasets. #### Snapshot - A snapshot is a binary image of the database contents, full indexes, and [additional data](../../server/ongoing-tasks/backup-overview.mdx#backup-contents) + A snapshot is a binary image of the database contents, full indexes, and [additional data](#backup-contents) at a given point in time. * Restoration time is reduced because no re-indexing is needed, but more data is transferred during backups. @@ -72,7 +72,7 @@ There are two backup types: [Logical-backup](../../client-api/operations/mainten Backed-up data includes both database-level and cluster-level contents, as detailed below. -| Database-level data | [Logical Backup](../../server/ongoing-tasks/backup-overview.mdx#logical-backup) | [Snapshot](../../server/ongoing-tasks/backup-overview.mdx#snapshot) | +| Database-level data | [Logical Backup](#logical-backup) | [Snapshot](#snapshot) | |---- | - | - | | [Documents & Revisions](https://ravendb.net/learn/inside-ravendb-book/reader/4.0/3-document-modeling) | ✔ | ✔ | | [Attachments](../../document-extensions/attachments/what-are-attachments.mdx) | ✔ | ✔ | @@ -83,7 +83,7 @@ Backed-up data includes both database-level and cluster-level contents, as detai | [Conflicts](../../server/clustering/replication/replication-conflicts.mdx) | ✔ | ✔ | -| Cluster-level data | [Logical Backup](../../server/ongoing-tasks/backup-overview.mdx#logical-backup) | [Snapshot](../../server/ongoing-tasks/backup-overview.mdx#snapshot) | +| Cluster-level data | [Logical Backup](#logical-backup) | [Snapshot](#snapshot) | |---- | - | - | | [Database Record](../../studio/database/settings/database-record.mdx) | ✔ | ✔ | | [Compare-exchange values](../../client-api/operations/compare-exchange/overview.mdx) | ✔ | ✔ | diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/basics.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/basics.mdx index d1b0e25de9..72b5ccf1b1 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/basics.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/basics.mdx @@ -29,13 +29,13 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more about how ETL works on a sharded database [here](../../../sharding/etl.mdx). * In this article: - * [Why use ETL](../../../server/ongoing-tasks/etl/basics.mdx#why-use-etl) - * [Defining ETL Tasks](../../../server/ongoing-tasks/etl/basics.mdx#defining-etl-tasks) - * [ETL Stages:](../../../server/ongoing-tasks/etl/basics.mdx#etl-stages) - * [Extract](../../../server/ongoing-tasks/etl/basics.mdx#extract) - * [Transform](../../../server/ongoing-tasks/etl/basics.mdx#transform) - * [Load](../../../server/ongoing-tasks/etl/basics.mdx#load) - * [Troubleshooting](../../../server/ongoing-tasks/etl/basics.mdx#troubleshooting) + * [Why use ETL](#why-use-etl) + * [Defining ETL Tasks](#defining-etl-tasks) + * [ETL Stages:](#etl-stages) + * [Extract](#extract) + * [Transform](#transform) + * [Load](#load) + * [Troubleshooting](#troubleshooting) @@ -87,9 +87,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; ETL's three stages are: -* [Extract](../../../server/ongoing-tasks/etl/basics.mdx#extract) - Extract the documents from the database -* [Transform](../../../server/ongoing-tasks/etl/basics.mdx#transform) - Transform & filter the documents data according to the supplied script (optional) -* [Load](../../../server/ongoing-tasks/etl/basics.mdx#load) - Load (write) the transformed data into the target destination +* [Extract](#extract) - Extract the documents from the database +* [Transform](#transform) - Transform & filter the documents data according to the supplied script (optional) +* [Load](#load) - Load (write) the transformed data into the target destination --- @@ -159,7 +159,7 @@ These are not part of the general JavaScript engine and **apply to ETL scripts o | Function / Member | Type | Description | |-----------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `loadTo` | function | Loads an object to the specified target. An object will only be sent to the destination if this method is called.
This command has several syntax options,
see [The loadTo method](../../../server/ongoing-tasks/etl/basics.mdx#theloadtomethod) below. | +| `loadTo` | function | Loads an object to the specified target. An object will only be sent to the destination if this method is called.
This command has several syntax options,
see [The loadTo method](#theloadtomethod) below. | | **Attachments:** | | | | `loadAttachment(name)` | function | Loads an attachment of the current document. | | `hasAttachment(name)` | function | Returns `true` if an attachment with the given name exists on the current document. | diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/elasticsearch.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/elasticsearch.mdx index fa3541da5c..44feb73351 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/elasticsearch.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/elasticsearch.mdx @@ -21,39 +21,39 @@ import LanguageContent from "@site/src/components/LanguageContent"; or your [client](../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-elasticsearch-etl-task). * In this page: - * [Elasticsearch ETL](../../../server/ongoing-tasks/etl/elasticsearch.mdx#elasticsearch-etl) - * [Transformation Script](../../../server/ongoing-tasks/etl/elasticsearch.mdx#transformation-script) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/elasticsearch.mdx#alternative-syntax) - * [Data Delivery](../../../server/ongoing-tasks/etl/elasticsearch.mdx#data-delivery) - * [What is Transferred](../../../server/ongoing-tasks/etl/elasticsearch.mdx#what-is-transferred) - * [Document Identifiers](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) - * [Transactions](../../../server/ongoing-tasks/etl/elasticsearch.mdx#transactions) - * [Insert Only Mode](../../../server/ongoing-tasks/etl/elasticsearch.mdx#insert-only-mode) - * [Elasticsearch Index Definition](../../../server/ongoing-tasks/etl/elasticsearch.mdx#elasticsearch-index-definition) - * [Client API](../../../server/ongoing-tasks/etl/elasticsearch.mdx#client-api) - * [Add an Elasticsearch ETL Task](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) - * [Add an Elasticsearch Connection String](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) - * [Supported Elasticsearch Versions](../../../server/ongoing-tasks/etl/elasticsearch.mdx#supported-elasticsearch-versions) + * [Elasticsearch ETL](#elasticsearch-etl) + * [Transformation Script](#transformation-script) + * [Alternative Syntax](#alternative-syntax) + * [Data Delivery](#data-delivery) + * [What is Transferred](#what-is-transferred) + * [Document Identifiers](#document-identifiers) + * [Transactions](#transactions) + * [Insert Only Mode](#insert-only-mode) + * [Elasticsearch Index Definition](#elasticsearch-index-definition) + * [Client API](#client-api) + * [Add an Elasticsearch ETL Task](#add-an-elasticsearch-etl-task) + * [Add an Elasticsearch Connection String](#add-an-elasticsearch-connection-string) + * [Supported Elasticsearch Versions](#supported-elasticsearch-versions) ## Elasticsearch ETL * The following steps are required when creating an Elasticsearch ETL task: - * Define a [connection string](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) which includes: + * Define a [connection string](#add-an-elasticsearch-connection-string) which includes: * URLs to Elasticsearch nodes. * Authentication method required by the Elasticsearch nodes. * **Define the Elasticsearch Indexes** * Indexes are used by Elasticsearch to store and locate documents. * The ETL task will send new documents to the specified Elasticsearch indexes. * If not otherwise specified, existing Elasticsearch documents will be removed before adding new documents. - * A [document identifier](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) + * A [document identifier](#document-identifiers) field property is defined per document, and used by the delete command to locate the matching documents. * **Define Transformation Scripts**. The transformation script determines which RavenDB documents will be transferred, to which Elasticsearch Indexes, and in what form. * For a thorough step-by-step explanation: - * Learn [here](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) + * Learn [here](#add-an-elasticsearch-etl-task) to define an Elasticsearch ETL task using **code**. * Learn [here](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx) to define an Elasticsearch ETL task using **Studio**. @@ -148,7 +148,7 @@ adToOrders(orderData); * In addition to specifying this document property in the script, it must be defined for the ETL task: - * Either set `DocumentIdProperty` through code (see [code sample](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task)), + * Either set `DocumentIdProperty` through code (see [code sample](#add-an-elasticsearch-etl-task)), * or Set the [Document ID Property Name](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) field via Studio. ### Transactions @@ -176,7 +176,7 @@ OrderLinesCount":3,"TotalCost":0,"DocID":"orders/1-a"\} ### Insert Only Mode -You can enable the task's **Insert Only** mode using [code](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) +You can enable the task's **Insert Only** mode using [code](#add-an-elasticsearch-etl-task) or via [Studio](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes), to **omit** _delete_by_query commands and so refrain from deleting documents before the transfer. @@ -235,7 +235,7 @@ as **"keyword"** in your index definition. Pass it an `ElasticSearchEtlConfiguration`instance with - * The name of a defined **Connection String**. You can define a connection string - [using code](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) + [using code](#add-an-elasticsearch-connection-string) or via [Studio](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#define-the-elasticsearch-etl-task). * A list of **Elasticsearch Indexes**. * A list of **Transformation Scripts**. @@ -309,7 +309,7 @@ store.Maintenance.Send(operation); | Property | Type | Description | |:-------------|:-------------|:-------------| | **IndexName** | `string` | Elasticsearch Index name.
Name indexes **using lower-case characters only**, e.g. `orders`. | - | **DocumentIdProperty** | `string` | The [document ID property](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) defined on the transferred document object inside the transformation script. | + | **DocumentIdProperty** | `string` | The [document ID property](#document-identifiers) defined on the transferred document object inside the transformation script. | | **InsertOnlyMode** | `bool` | `true` - Do not delete existing documents before appending new ones.
`false` - Delete existing document versions before appending documents.| diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/olap.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/olap.mdx index be938872b8..8ee0555977 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/olap.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/olap.mdx @@ -28,10 +28,10 @@ an alternative to CSV that is much faster to query. Unlike CSV, Parquet groups t column (by field) instead of by row (by document). * In this page: - * [Client API](../../../server/ongoing-tasks/etl/olap.mdx#client-api) - * [Transform Script](../../../server/ongoing-tasks/etl/olap.mdx#transform-script) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/olap.mdx#alternative-syntax) - * [Athena Examples](../../../server/ongoing-tasks/etl/olap.mdx#athena-examples) + * [Client API](#client-api) + * [Transform Script](#transform-script) + * [Alternative Syntax](#alternative-syntax) + * [Athena Examples](#athena-examples) ## Client API @@ -82,7 +82,7 @@ AddEtlOperationResult result = store.Maintenance.Send(operation); | Property | Type | Description | | - | - | - | | `RunFrequency` | `string` | Takes a [cron expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm) which determines how often the server will execute the ETL process. | -| `CustomPartitionValue` | `string` | A value that can be used as a partition name in multiple scripts. See [below](../../../server/ongoing-tasks/etl/olap.mdx#the-custom-partition-value). | +| `CustomPartitionValue` | `string` | A value that can be used as a partition name in multiple scripts. See [below](#the-custom-partition-value). | | `OlapTables` | `List` | List of naming configurations for individual tables. See more details below. | #### `OlapConnectionString` @@ -284,7 +284,7 @@ using this syntax: `loadTo('folder_name', key, object)` #### The Custom Partition Value The custom partition value is a string value that can be set in the -[`OlapEtlConfiguration` object](../../../server/ongoing-tasks/etl/olap.mdx#section). This value can be +[`OlapEtlConfiguration` object](#section). This value can be referenced in the transform script as `$customPartitionValue`. This setting gives you another way to distinguish data from different ETL tasks that use the same transform script. diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx index 4b525de193..53a7e5b3fa 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx @@ -37,16 +37,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this page: - * [Add an Azure Queue Storage connection string](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#add-an-azure-queue-storage-connection-string) - * [Authentication methods](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#authentication-methods) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#syntax) - * [Add an Azure Queue Storage ETL task](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#add-an-azure-queue-storage-etl-task) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#example-basic) - * [Delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-loadto-method) + * [Add an Azure Queue Storage connection string](#add-an-azure-queue-storage-connection-string) + * [Authentication methods](#authentication-methods) + * [Example](#example) + * [Syntax](#syntax) + * [Add an Azure Queue Storage ETL task](#add-an-azure-queue-storage-etl-task) + * [Example](#example-basic) + * [Delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) ## Add an Azure Queue Storage connection string @@ -172,7 +172,7 @@ public class Passwordless * Extract source documents from the "Orders" collection in RavenDB. * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersQueue" in an Azure Queue Storage. -* For more details about the script and the `loadTo` method, see the [transromation script](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-transformation-script) section below. +* For more details about the script and the `loadTo` method, see the [transromation script](#the-transformation-script) section below. diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/kafka.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/kafka.mdx index 1dee1ad681..79b0c1f9f3 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/kafka.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/kafka.mdx @@ -36,25 +36,25 @@ import ContentFrame from "@site/src/components/ContentFrame"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this article: - * [Setup workflow](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#setup-workflow) - * [Creating a Kafka ETL task using the Client API](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#creating-a-kafka-etl-task-using-the-client-api) - * [Add a Kafka connection string](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#add-a-kafka-connection-string) - * [Example: connecting to a secure Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-secure-kafka-cluster) - * [Use RavenDB Certificate](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#use-ravendb-certificate) - * [Add a Kafka ETL task](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#add-a-kafka-etl-task) - * [Example: basic](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-basic) - * [Example: delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#delete-processed-documents) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-loadto-method) - * [Prerequisites for a secure Kafka server](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#prerequisites-for-a-secure-kafka-server) - * [What needs to be granted](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#what-needs-to-be-granted) - * [Computing the transactional IDs](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#computing-the-transactional-ids) - * [Example: building the transactional ID](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-building-the-transactional-id) - * [Entering the grants on the Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#entering-the-grants-on-the-kafka-cluster) - * [Single-node Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#single-node-kafka-cluster) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#syntax) - * [Connection string classes](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#connection-string-classes) - * [ETL task classes](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#etl-task-classes) + * [Setup workflow](#setup-workflow) + * [Creating a Kafka ETL task using the Client API](#creating-a-kafka-etl-task-using-the-client-api) + * [Add a Kafka connection string](#add-a-kafka-connection-string) + * [Example: connecting to a secure Kafka cluster](#example-secure-kafka-cluster) + * [Use RavenDB Certificate](#use-ravendb-certificate) + * [Add a Kafka ETL task](#add-a-kafka-etl-task) + * [Example: basic](#example-basic) + * [Example: delete processed documents](#delete-processed-documents) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) + * [Prerequisites for a secure Kafka server](#prerequisites-for-a-secure-kafka-server) + * [What needs to be granted](#what-needs-to-be-granted) + * [Computing the transactional IDs](#computing-the-transactional-ids) + * [Example: building the transactional ID](#example-building-the-transactional-id) + * [Entering the grants on the Kafka cluster](#entering-the-grants-on-the-kafka-cluster) + * [Single-node Kafka cluster](#single-node-kafka-cluster) + * [Syntax](#syntax) + * [Connection string classes](#connection-string-classes) + * [ETL task classes](#etl-task-classes) @@ -192,7 +192,7 @@ In this example, the Kafka ETL Task will: * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersTopic" in a Kafka broker. -For more details about the script and the `loadTo` method, see [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-transformation-script) below. +For more details about the script and the `loadTo` method, see [The transformation script](#the-transformation-script) below. ```csharp // Define a transformation script for the task: diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx index b62f1f5ab3..20791150a1 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -22,19 +22,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **RabbitMQ** * **Azure Queue Storage** -* This functionality is achieved by defining [Queue ETL tasks](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#queue-etl-tasks) within a RavenDB database. +* This functionality is achieved by defining [Queue ETL tasks](#queue-etl-tasks) within a RavenDB database. * RavenDB can also function as a _Consumer_. To learn about RavenDB's role as a _Consumer_ please refer to the [Queue Sink section](../../../../server/ongoing-tasks/queue-sink/overview.mdx). * In this page: - * [Queue ETL tasks](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#queue-etl-tasks) - * [Data delivery](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#data-delivery) - * [What is transferred](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#what-is-transferred) - * [How are messages produced and consumed](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#how-are-messages-produced-and-consumed) - * [Idempotence and message duplication](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#idempotence-and-message-duplication) - * [CloudEvents](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#cloudevents) - * [Task statistics](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#task-statistics) + * [Queue ETL tasks](#queue-etl-tasks) + * [Data delivery](#data-delivery) + * [What is transferred](#what-is-transferred) + * [How are messages produced and consumed](#how-are-messages-produced-and-consumed) + * [Idempotence and message duplication](#idempotence-and-message-duplication) + * [CloudEvents](#cloudevents) + * [Task statistics](#task-statistics) ## Queue ETL tasks @@ -68,7 +68,7 @@ The above ETL tasks: Document extensions like attachments, counters, or time series, will not be transferred. * **CloudEvents messages** JSON objects produced by the task's transformation script are wrapped - and delivered as [CloudEvents Messages](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#cloudevents). + and delivered as [CloudEvents Messages](#cloudevents). #### How are messages produced and consumed: diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx index 7e8d667597..a24c1995f0 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx @@ -30,16 +30,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this page: - * [Add a RabbitMQ connection string](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#add-a-rabbitmq-connection-string) - * [Exmaple](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#syntax) - * [Add a RabbitMQ ETL task](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#add-a-rabbitmq-etl-task) - * [Example - basic](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#example-basic) - * [Example - delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-loadto-method) - * [Available method overloads](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#available-method-overloads) + * [Add a RabbitMQ connection string](#add-a-rabbitmq-connection-string) + * [Exmaple](#example) + * [Syntax](#syntax) + * [Add a RabbitMQ ETL task](#add-a-rabbitmq-etl-task) + * [Example - basic](#example-basic) + * [Example - delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) + * [Available method overloads](#available-method-overloads) ## Add a RabbitMQ connection string @@ -126,7 +126,7 @@ var res = store.Maintenance.Send( * Extract source documents from the "Orders" collection in RavenDB. * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersExchange" in a RabbitMQ broker. -* For more details about the script and the `loadTo` method overloads, see the [transromation script](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-transformation-script) section below. +* For more details about the script and the `loadTo` method overloads, see the [transromation script](#the-transformation-script) section below. diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/raven.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/raven.mdx index f51de534a6..463e0627ef 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/raven.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/raven.mdx @@ -30,24 +30,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; * RavenDB ETL tasks can be defined via the Client API or the [Studio](../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx). * In this article: - * [Transformation script options](../../../server/ongoing-tasks/etl/raven.mdx#transformation-script-options) - * [Empty Script](../../../server/ongoing-tasks/etl/raven.mdx#empty-script) - * [Attachments](../../../server/ongoing-tasks/etl/raven.mdx#attachments) - * [Counters](../../../server/ongoing-tasks/etl/raven.mdx#counters) - * [Time Series](../../../server/ongoing-tasks/etl/raven.mdx#time-series) - * [Revisions](../../../server/ongoing-tasks/etl/raven.mdx#revisions) - * [Deletions](../../../server/ongoing-tasks/etl/raven.mdx#deletions) + * [Transformation script options](#transformation-script-options) + * [Empty Script](#empty-script) + * [Attachments](#attachments) + * [Counters](#counters) + * [Time Series](#time-series) + * [Revisions](#revisions) + * [Deletions](#deletions) -* [Loading documents to the destination database](../../../server/ongoing-tasks/etl/raven.mdx#loading-documents-to-the-destination-database) -* [Document identifiers](../../../server/ongoing-tasks/etl/raven.mdx#document-identifiers) -* [Filtering](../../../server/ongoing-tasks/etl/raven.mdx#filtering) -* [Loading data from related documents](../../../server/ongoing-tasks/etl/raven.mdx#loading-data-from-related-documents) -* [Accessing metadata](../../../server/ongoing-tasks/etl/raven.mdx#accessing-metadata) -* [Creating multiple documents from a single document](../../../server/ongoing-tasks/etl/raven.mdx#creating-multiple-documents-from-a-single-document) +* [Loading documents to the destination database](#loading-documents-to-the-destination-database) +* [Document identifiers](#document-identifiers) +* [Filtering](#filtering) +* [Loading data from related documents](#loading-data-from-related-documents) +* [Accessing metadata](#accessing-metadata) +* [Creating multiple documents from a single document](#creating-multiple-documents-from-a-single-document) --- @@ -169,7 +169,7 @@ loadToEmployees({ ### Document Identifiers Document IDs assigned to documents written to the destination depend on whether the source and destination collections share the same name. -You can also configure a [postfix](../../../server/ongoing-tasks/etl/raven.mdx#setting-a-destination-document-id-postfix) to further modify the resulting ID. +You can also configure a [postfix](#setting-a-destination-document-id-postfix) to further modify the resulting ID. @@ -202,7 +202,7 @@ the destination ID will look like: `employees/1-A/people/00000000000000000024-A` This happens because the ETL task appends `/` to the source ID, signaling the destination server to generate an [identity-based ID](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids). Since the destination ID differs from the source ID, the old document version is deleted on the destination database and replaced with each update. -This behavior can be changed - see [Deletions](../../../server/ongoing-tasks/etl/raven.mdx#deletions). +This behavior can be changed - see [Deletions](#deletions). ```js @@ -430,10 +430,10 @@ var managerMeta = getMetadata(manager); * If you use a script you can indicate that an attachment should also be sent by using dedicated functions: - `loadAttachment(name)` returns a reference to an attachment that is meant be passed to `addAttachment()` - `.addAttachment([name,] attachmentRef)` adds an attachment to a document that will be sent in the process, `` is a reference returned by `loadTo()` -* [Sending attachments together with documents](../../../server/ongoing-tasks/etl/raven.mdx#sending-attachments-together-with-documents) -* [Changing attachment name](../../../server/ongoing-tasks/etl/raven.mdx#changing-attachment-name) -* [Loading non-existent attachment](../../../server/ongoing-tasks/etl/raven.mdx#loading-non-existent-attachment) -* [Accessing attachments from metadata](../../../server/ongoing-tasks/etl/raven.mdx#accessing-attachments-from-metadata) +* [Sending attachments together with documents](#sending-attachments-together-with-documents) +* [Changing attachment name](#changing-attachment-name) +* [Loading non-existent attachment](#loading-non-existent-attachment) +* [Accessing attachments from metadata](#accessing-attachments-from-metadata) ### Sending attachments together with documents @@ -490,13 +490,13 @@ var attachments = this['@metadata']['@attachments']; * Counters are sent automatically when you send a _full_ collection to the destination using an _empty_ script. * If a script is defined RavenDB doesn't send counters by default. -* To indicate that a counter should also be sent, the [behavior function](../../../server/ongoing-tasks/etl/raven.mdx#counter-behavior-function) +* To indicate that a counter should also be sent, the [behavior function](#counter-behavior-function) (e.g. by increment operation). If the relevant function doesn't exist, a counter isn't loaded. * The reason that counters require special functions is that incrementing a counter _doesn't_ modify the change vector of a related document so the document _isn't_ processed by ETL on a change in the counter. * Another option of sending a counter is to explicitly add it in a script to a loaded document. -* [Counter behavior function](../../../server/ongoing-tasks/etl/raven.mdx#counter-behavior-function) -* [Adding counter explicitly in a script](../../../server/ongoing-tasks/etl/raven.mdx#adding-counter-explicitly-in-a-script) +* [Counter behavior function](#counter-behavior-function) +* [Adding counter explicitly in a script](#adding-counter-explicitly-in-a-script) ### Counter behavior function @@ -556,7 +556,7 @@ function loadCountersOfProductsBehavior(docId, counterName) { Counter behavior functions typically handle counters of documents that are loaded to the same collection. If a transformation script for `Employees` collection specifies that they are loaded to the `People` collection in a target database, - then due to document ID generation strategy by ETL process (see [Documents Identifiers](../../../server/ongoing-tasks/etl/raven.mdx#documents-identifiers)), + then due to document ID generation strategy by ETL process (see [Documents Identifiers](#documents-identifiers)), the counters won't be sent because the final ID of a loaded document isn't known on the source side. You can use special functions in the script code to deal with counters on documents that are loaded into different collections: @@ -595,8 +595,8 @@ but it **sets the value using a** `put` command. * If the transformation script is empty, time series are transferred along with their documents by default. * When the script is not empty, ETL can be set for time series via: - * [Time Series Load Behavior Function](../../../server/ongoing-tasks/etl/raven.mdx#time-series-load-behavior-function) - * [Adding Time Series to Documents](../../../server/ongoing-tasks/etl/raven.mdx#adding-time-series-to-documents) + * [Time Series Load Behavior Function](#time-series-load-behavior-function) + * [Adding Time Series to Documents](#adding-time-series-to-documents) ### Time Series Load Behavior Function @@ -721,12 +721,12 @@ Upon source document modifications, ETL is set to delete and replace the destina If you want to control the way deletions are handled in the destination database, you can change the default settings with the configurable functions described in this section. -* [Why documents are deleted by default](../../../server/ongoing-tasks/etl/raven.mdx#deletions-why-documents-are-deleted-by-default-in-the-destination-database) -* [When destination collections are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) -* [Collection specific function](../../../server/ongoing-tasks/etl/raven.mdx#deletions-collection-specific-function) -* [Generic function](../../../server/ongoing-tasks/etl/raven.mdx#deletions-generic-function) -* [Filtering deletions in the destination database](../../../server/ongoing-tasks/etl/raven.mdx#deletions-filtering-deletions-in-the-destination-database) -* [Deletions Example: ETL script with deletion behavior defined](../../../server/ongoing-tasks/etl/raven.mdx#deletions-example-etl-script-with-deletion-behavior-defined) +* [Why documents are deleted by default](#deletions-why-documents-are-deleted-by-default-in-the-destination-database) +* [When destination collections are different](#when-destination-collections-are-different) +* [Collection specific function](#deletions-collection-specific-function) +* [Generic function](#deletions-generic-function) +* [Filtering deletions in the destination database](#deletions-filtering-deletions-in-the-destination-database) +* [Deletions Example: ETL script with deletion behavior defined](#deletions-example-etl-script-with-deletion-behavior-defined) --- @@ -747,9 +747,9 @@ The functions in this section were created to allow developers this control. **If we ETL to a different collection than the source**, the source isn't aware of the new IDs created. This forces us to load new documents with incremented IDs instead of overwriting the fields in existing documents. -RavenDB has to create a new, updated document in the destination with an [incremented server-made identity](../../../server/ongoing-tasks/etl/raven.mdx#documents-identifiers). +RavenDB has to create a new, updated document in the destination with an [incremented server-made identity](#documents-identifiers). You can then choose if you want to delete the old version in the destination by selecting -`return false` in the transform script function [deleteDocumentsBehavior](../../../server/ongoing-tasks/etl/raven.mdx#deletions-generic-function). +`return false` in the transform script function [deleteDocumentsBehavior](#deletions-generic-function). * Each updated version of the document gets a [server generated ID](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids) in which the number at the end is incremented with each version. @@ -775,7 +775,7 @@ sending a single delete command in the destination for a given ID. If documents are updated and not deleted in the source, they will simply be updated in the destination with no change to the destination document ID. Deletions can be controlled by defining deletion behavior functions in the ETL script. -* See a [sample ETL script with deletion behavior defined](../../../server/ongoing-tasks/etl/raven.mdx#deletions-example-etl-script-with-deletion-behavior-defined). +* See a [sample ETL script with deletion behavior defined](#deletions-example-etl-script-with-deletion-behavior-defined). --- @@ -793,7 +793,7 @@ function deleteDocumentsOfBehavior(docId, deleted) { `` needs to be substituted by a real collection name that the ETL script is working on -(same convention as for [loadTo](../../../server/ongoing-tasks/etl/raven.mdx#transformation-script-options) method). +(same convention as for [loadTo](#transformation-script-options) method). e.g. `function deleteDocumentsOfOrdersBehavior(docId, deleted) {return false;}` | Parameter | Type | Description | Notes | @@ -861,7 +861,7 @@ trigger the command regardless of whether the source document was deleted. ### Example - Generic deletions behavior function -[If the source and destination collection names are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) +[If the source and destination collection names are different](#when-destination-collections-are-different) and deletions behavior is set to false, each document change will load a new document with an incremented document identity, thus saving a history. @@ -958,7 +958,7 @@ function deleteDocumentsBehavior(docId, collection, deleted) { The following example will check if the source document was deleted or just updated before loading the transformed document. This function can be used if the destination collection is the same or different from the source. -> [In this example, the source and destination collection names are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) +> [In this example, the source and destination collection names are different](#when-destination-collections-are-different) and deletions behavior is set to false if the source is deleted, so source deletions won't delete the destination document, thus saving a history of documents even if they're deleted in the source. diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/sql.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/sql.mdx index 50d08c6960..40167d1fa9 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/sql.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/sql.mdx @@ -15,24 +15,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **SQL ETL** is a task that creates an [ETL process](../../../server/ongoing-tasks/etl/basics.mdx) where data from a RavenDB database is extracted, transformed, and loaded into a relational database as the destination. * In this article: - * [Supported relational databases](../../../server/ongoing-tasks/etl/sql.mdx#supported-relational-databases) - * [Creating the SQL ETL task](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task) - * [Configuring the SQL tables](../../../server/ongoing-tasks/etl/sql.mdx#configuring-the-sql-tables) - * [Document ID column](../../../server/ongoing-tasks/etl/sql.mdx#document-id-column) - * [Insert only](../../../server/ongoing-tasks/etl/sql.mdx#insert-only) - * [Transformation scripts](../../../server/ongoing-tasks/etl/sql.mdx#transformation-scripts) - * [The `loadTo` method](../../../server/ongoing-tasks/etl/sql.mdx#the-loadto-method) - * [Loading to multiple tables](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-multiple-tables) - * [Loading related documents](../../../server/ongoing-tasks/etl/sql.mdx#loading-related-documents) - * [Loading attachments](../../../server/ongoing-tasks/etl/sql.mdx#loading-attachments) - * [Loading to VARCHAR and NVARCHAR columns](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-varchar-and-nvarchar-columns) - * [Loading to specific column types](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-specific-column-types) - * [Filtering](../../../server/ongoing-tasks/etl/sql.mdx#filtering) - * [Accessing the metadata](../../../server/ongoing-tasks/etl/sql.mdx#accessing-the-metadata) - * [Document extensions](../../../server/ongoing-tasks/etl/sql.mdx#document-extensions) - * [Advanced options](../../../server/ongoing-tasks/etl/sql.mdx#advanced-options) - * [Transaction processing](../../../server/ongoing-tasks/etl/sql.mdx#transaction-processing) - * [Creating the SQL ETL task from the Client API](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task-from-the-client-api) + * [Supported relational databases](#supported-relational-databases) + * [Creating the SQL ETL task](#creating-the-sql-etl-task) + * [Configuring the SQL tables](#configuring-the-sql-tables) + * [Document ID column](#document-id-column) + * [Insert only](#insert-only) + * [Transformation scripts](#transformation-scripts) + * [The `loadTo` method](#the-loadto-method) + * [Loading to multiple tables](#loading-to-multiple-tables) + * [Loading related documents](#loading-related-documents) + * [Loading attachments](#loading-attachments) + * [Loading to VARCHAR and NVARCHAR columns](#loading-to-varchar-and-nvarchar-columns) + * [Loading to specific column types](#loading-to-specific-column-types) + * [Filtering](#filtering) + * [Accessing the metadata](#accessing-the-metadata) + * [Document extensions](#document-extensions) + * [Advanced options](#advanced-options) + * [Transaction processing](#transaction-processing) + * [Creating the SQL ETL task from the Client API](#creating-the-sql-etl-task-from-the-client-api) @@ -59,7 +59,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; -To create an SQL ETL task using the Client API, see [Creating the SQL ETL task from the Client API](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task-from-the-client-api). +To create an SQL ETL task using the Client API, see [Creating the SQL ETL task from the Client API](#creating-the-sql-etl-task-from-the-client-api). To create an SQL ETL task from Studio, open `Tasks` > `Ongoing Tasks`. ![Configure SQL ETL task](./assets/sql-etl-setup.png) diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/etl/test-scripts.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/etl/test-scripts.mdx index d4772eca3b..05a53ddb7b 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/etl/test-scripts.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/etl/test-scripts.mdx @@ -17,8 +17,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * ETL transformations can be tested with the usage of `Test script` option. Edit your script in the Studio to enter test mode. * In this page: - * [Testing Raven ETL Scripts](../../../server/ongoing-tasks/etl/test-scripts.mdx#testing-raven-etl-scripts) - * [Testing SQL ETL Scripts](../../../server/ongoing-tasks/etl/test-scripts.mdx#testing-sql-etl-scripts) + * [Testing Raven ETL Scripts](#testing-raven-etl-scripts) + * [Testing SQL ETL Scripts](#testing-sql-etl-scripts) diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/external-replication.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/external-replication.mdx index 9f0b09671e..dbf762b66d 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/external-replication.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/external-replication.mdx @@ -26,17 +26,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; For additional functionality such as filtration and two-way replication consider [Hub/Sink Replication](../../server/ongoing-tasks/hub-sink-replication.mdx). * To replicate between two separate, secure RavenDB servers, - you need to [pass a client certificate](../../server/ongoing-tasks/external-replication.mdx#step-by-step-guide) from the source server to the destination. + you need to [pass a client certificate](#step-by-step-guide) from the source server to the destination. * The External Replication task **does _not_ create a backup** of your data and indexes. See more in [Backup -vs- Replication](../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task) * In this page: - * [General Information about External Replication Task](../../server/ongoing-tasks/external-replication.mdx#general-information-about-external-replication-task) - * [Code Sample](../../server/ongoing-tasks/external-replication.mdx#code-sample) - * [Step-by-Step Guide](../../server/ongoing-tasks/external-replication.mdx#step-by-step-guide) - * [Definition](../../server/ongoing-tasks/external-replication.mdx#definition) - * [Offline Behavior](../../server/ongoing-tasks/external-replication.mdx#offline-behavior) - * [Delayed Replication](../../server/ongoing-tasks/external-replication.mdx#delayed-replication) + * [General Information about External Replication Task](#general-information-about-external-replication-task) + * [Code Sample](#code-sample) + * [Step-by-Step Guide](#step-by-step-guide) + * [Definition](#definition) + * [Offline Behavior](#offline-behavior) + * [Delayed Replication](#delayed-replication) @@ -167,7 +167,7 @@ To create an external replication task via the RavenDB Studio, see the [Step-by- ## Definition -To learn how to define an external replication task via code, see [code sample](../../server/ongoing-tasks/external-replication.mdx#code-sample). +To learn how to define an external replication task via code, see [code sample](#code-sample). You can also configure external eplication tasks [via RavenDB Studio](../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition). diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/hub-sink-replication.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/hub-sink-replication.mdx index f57fb65ce8..91bc8262d4 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/hub-sink-replication.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/hub-sink-replication.mdx @@ -35,14 +35,14 @@ Hub whenever they are online. * In this page: * [What is and is not replicated?](../../server/ongoing-tasks/hub-sink-replication.mdx#what-is-and-is-not-replicated?) - * [Defining Replication Tasks](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-replication-tasks) - * [Defining a Replication Hub](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-replication-hub) - * [Defining a Hub Access](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-hub-access) - * [Defining a Replication Sink](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-replication-sink) - * [Defining a Connection String](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-connection-string) - * [Usage Sample](../../server/ongoing-tasks/hub-sink-replication.mdx#usage-sample) - * [Failover](../../server/ongoing-tasks/hub-sink-replication.mdx#failover) - * [Backward Compatibility](../../server/ongoing-tasks/hub-sink-replication.mdx#backward-compatibility) + * [Defining Replication Tasks](#defining-replication-tasks) + * [Defining a Replication Hub](#defining-a-replication-hub) + * [Defining a Hub Access](#defining-a-hub-access) + * [Defining a Replication Sink](#defining-a-replication-sink) + * [Defining a Connection String](#defining-a-connection-string) + * [Usage Sample](#usage-sample) + * [Failover](#failover) + * [Backward Compatibility](#backward-compatibility) ## What is and is not replicated? diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx index 00c431a764..8e936d3d3c 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx @@ -27,15 +27,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; user-defined scripts, and store the documents in RavenDB collections. * In this page: - * [The Queue Sink Task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#the-queue-sink-task) - * [Connecting a Kafka broker](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#connecting-a-kafka-broker) - * [Retrieving enqueued messages from selected Kafka topics](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#retrieving-enqueued-messages-from-selected-kafka-topics) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#client-api) - * [Add a Kafka Connection String](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#add-a-kafka-connection-string) - * [Add a Kafka Sink Task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#add-a-kafka-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#configuration-options) + * [The Queue Sink Task](#the-queue-sink-task) + * [Connecting a Kafka broker](#connecting-a-kafka-broker) + * [Retrieving enqueued messages from selected Kafka topics](#retrieving-enqueued-messages-from-selected-kafka-topics) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Add a Kafka Connection String](#add-a-kafka-connection-string) + * [Add a Kafka Sink Task](#add-a-kafka-sink-task) + * [Configuration Options](#configuration-options) @@ -54,7 +54,7 @@ In the message broker architecture, RavenDB sinks take the role of data consumer A sink would connect a Kafka broker using a connection string, and retrieve messages from the broker's Topics. -Read [below](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#add-a-kafka-connection-string) +Read [below](#add-a-kafka-connection-string) about adding a connection string via API. Read [here](../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-a-kafka-sink-task) about adding a connection string using Studio. @@ -176,7 +176,7 @@ user in Studio, but **continue processing the batch**. Once a batch is consumed, the task confirms it by calling `kafkaConsumer.Commit()`. Note that the number of documents included in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). Producers may enqueue diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/overview.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/overview.mdx index 897416bb0c..909d7451ae 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/overview.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/overview.mdx @@ -39,9 +39,9 @@ ability to process this data, reveal and exploit its value. * In this page: - * [Supported Message Brokers](../../../server/ongoing-tasks/queue-sink/overview.mdx#supported-message-brokers) - * [Task Statistics](../../../server/ongoing-tasks/queue-sink/overview.mdx#task-statistics) - * [Licensing](../../../server/ongoing-tasks/queue-sink/overview.mdx#licensing) + * [Supported Message Brokers](#supported-message-brokers) + * [Task Statistics](#task-statistics) + * [Licensing](#licensing) ## Supported Message Brokers diff --git a/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx b/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx index ac6e88140f..f31619f584 100644 --- a/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx +++ b/versioned_docs/version-6.2/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx @@ -27,15 +27,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; using user-defined scripts, and store the documents in RavenDB collections. * In this page: - * [The RabbitMQ Sink Task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#the-rabbitmq-sink-task) - * [Connecting a RabbitMQ broker](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#connecting-a-rabbitmq-broker) - * [Retrieving messages from RabbitMQ queues](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#retrieving-messages-from-rabbitmq-queues) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#client-api) - * [Add a RabbitMQ Connection String](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#add-a-rabbitmq-connection-string) - * [Add a RabbitMQ Sink Task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#add-a-rabbitmq-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#configuration-options) + * [The RabbitMQ Sink Task](#the-rabbitmq-sink-task) + * [Connecting a RabbitMQ broker](#connecting-a-rabbitmq-broker) + * [Retrieving messages from RabbitMQ queues](#retrieving-messages-from-rabbitmq-queues) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Add a RabbitMQ Connection String](#add-a-rabbitmq-connection-string) + * [Add a RabbitMQ Sink Task](#add-a-rabbitmq-sink-task) + * [Configuration Options](#configuration-options) @@ -54,7 +54,7 @@ In the message broker architecture, RavenDB sinks take the role of data consumer A sink would connect a RabbitMQ broker using a connection string, and retrieve messages from the broker's queues. -Read [below](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#add-a-rabbitmq-connection-string) +Read [below](#add-a-rabbitmq-connection-string) about adding a connection string via API. Read [here](../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-a-rabbitmq-sink-task) about adding a connection string using Studio. @@ -163,7 +163,7 @@ user in Studio, but **continue processing the batch**. Once a batch is consumed, the task confirms it by sending `_channel.BasicAck`. Note that the number of documents included in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). Producers may enqueue diff --git a/versioned_docs/version-6.2/server/security/audit-log/audit-log-overview.mdx b/versioned_docs/version-6.2/server/security/audit-log/audit-log-overview.mdx index c80740c436..d412b3ab3a 100644 --- a/versioned_docs/version-6.2/server/security/audit-log/audit-log-overview.mdx +++ b/versioned_docs/version-6.2/server/security/audit-log/audit-log-overview.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; See the full list of what is being logged below. * In this page: - * [Enabling the audit log](../../../server/security/audit-log/audit-log-overview.mdx#enabling-the-audit-log) - * [What is being logged](../../../server/security/audit-log/audit-log-overview.mdx#what-is-being-logged) - * [Things to consider](../../../server/security/audit-log/audit-log-overview.mdx#things-to-consider) + * [Enabling the audit log](#enabling-the-audit-log) + * [What is being logged](#what-is-being-logged) + * [Things to consider](#things-to-consider) ## Enabling the audit log diff --git a/versioned_docs/version-6.2/server/security/authentication/certificate-configuration.mdx b/versioned_docs/version-6.2/server/security/authentication/certificate-configuration.mdx index e52216009e..9ce7ae5ef7 100644 --- a/versioned_docs/version-6.2/server/security/authentication/certificate-configuration.mdx +++ b/versioned_docs/version-6.2/server/security/authentication/certificate-configuration.mdx @@ -23,12 +23,12 @@ authentication in a much easier and faster way with automatic certificate renewa If you choose manual setup and/or to provide your own certificate, **you are responsible for its periodic renewal**. * In this page: - * [Prerequisites](../../../server/security/authentication/certificate-configuration.mdx#prerequisites) - * [Standard Manual Setup With Certificate Stored Locally](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) - * [Certificate Requirements](../../../server/security/authentication/certificate-configuration.mdx#certificate-requirements) - * [Certificate Location](../../../server/security/authentication/certificate-configuration.mdx#certificate-location) - * [With Logic Foreign to RavenDB or External Certificate Storage](../../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage) - * [Step-by-step Guide to Installing Certificate](../../../server/security/authentication/certificate-configuration.mdx#step-by-step-guide-to-installing-certificate) + * [Prerequisites](#prerequisites) + * [Standard Manual Setup With Certificate Stored Locally](#standard-manual-setup-with-certificate-stored-locally) + * [Certificate Requirements](#certificate-requirements) + * [Certificate Location](#certificate-location) + * [With Logic Foreign to RavenDB or External Certificate Storage](#with-logic-foreign-to-ravendb-or-external-certificate-storage) + * [Step-by-step Guide to Installing Certificate](#step-by-step-guide-to-installing-certificate) @@ -39,7 +39,7 @@ To enable authentication, either `Security.Certificate.Path` or `Security.Certif #### Setting up Client Certificates When the server is manually set up with a server certificate for the first time, there are no client certificates registered in the server yet. The first action an administrator will do is to [generate/register a new client certificate](../../../server/security/authentication/client-certificate-usage.mdx). -Find detailed instructions of the process [below](../../../server/security/authentication/certificate-configuration.mdx#step-by-step-guide-to-installing-certificate). +Find detailed instructions of the process [below](#step-by-step-guide-to-installing-certificate). You can set up various client certificates with different security clearance levels and database permissions. See [Certificate Management](../../../server/security/authentication/certificate-management.mdx) for more about permissions. @@ -180,7 +180,7 @@ In all secure configurations, the `ServerUrl` must contain the same domain name - Extract the .zip into the folders on each machine where the server nodes will permanently live. - Store server certificate in your desired location with secure permissions. -2. In each node `Server` folder, create the `settings.json` file which you will configure like the [examples](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. +2. In each node `Server` folder, create the `settings.json` file which you will configure like the [examples](#standard-manual-setup-with-certificate-stored-locally) above. * You can do this by going into the node `Server` folder > right-click > **New** > **Text Document** > name it `settings.json` instead of ...txt > click **Yes** > open it and begin configuring. * Place the `settings.json` inside each node's `Server` folder because when you run the server, RavenDB is programmed to find the settings there. @@ -189,12 +189,12 @@ In all secure configurations, the `ServerUrl` must contain the same domain name - Set the `ServerUrl`. Make sure to use `https` and that it matches the domain established in your certificate. - Set `Setup.Mode` to `None` to deactivate the RavenDB Setup Wizard. - Set `DataDir` to the desired database storage folder on each machine. - - Set the `Security.Certificate.Path` to the **.pfx** that you placed in each server folder if certificate is stored with [RavenDB logic on local machines](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) - or `Security.Certificate.Load.Exec` if using [external location or logic](../../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage). + - Set the `Security.Certificate.Path` to the **.pfx** that you placed in each server folder if certificate is stored with [RavenDB logic on local machines](#standard-manual-setup-with-certificate-stored-locally) + or `Security.Certificate.Load.Exec` if using [external location or logic](#with-logic-foreign-to-ravendb-or-external-certificate-storage). - Make sure that the certificate .path or .load script lead to the correct certificate location. `.Path` should look something like this: `"Security.Certificate.Path": "C:/Windows/MyDomainName/A/Server/ravendb.domain.com.pfx"` - See [.json example for a .Path situation](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. - - Setting a **password** on the certificate is optional. See [settings.json example](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. + See [.json example for a .Path situation](#standard-manual-setup-with-certificate-stored-locally) above. + - Setting a **password** on the certificate is optional. See [settings.json example](#standard-manual-setup-with-certificate-stored-locally) above. Run 4. Right-click and run the `run.ps1` (or `run.sh` in Linux) in the extracted server package. In Windows, it runs in PowerShell as a default. diff --git a/versioned_docs/version-6.2/server/security/authentication/certificate-management.mdx b/versioned_docs/version-6.2/server/security/authentication/certificate-management.mdx index 20c7509084..efdc063062 100644 --- a/versioned_docs/version-6.2/server/security/authentication/certificate-management.mdx +++ b/versioned_docs/version-6.2/server/security/authentication/certificate-management.mdx @@ -17,26 +17,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Once authentication is set up, it's the administrator's responsibility to issue and manage client certificates. Each client certificate can be configured to specify which databases the certificate can access and its authorization clearance level. -* Read about the logic and rationale behind RavenDB's client certificates in [The RavenDB Security Authorization Approach](../../../server/security/authentication/certificate-management.mdx#the-ravendb-security-authorization-approach) to ensure that you configure them appropriately. +* Read about the logic and rationale behind RavenDB's client certificates in [The RavenDB Security Authorization Approach](#the-ravendb-security-authorization-approach) to ensure that you configure them appropriately. * See the API article for integrating a client certificate into an application via the [document store](../../../client-api/creating-document-store.mdx). In this page: -* [Studio Certificate Management View](../../../server/security/authentication/certificate-management.mdx#studio-certificates-management-view) -* [The RavenDB Security Authorization Approach](../../../server/security/authentication/certificate-management.mdx#the-ravendb-security-authorization-approach) - * [Authorization Levels in Client Certificates](../../../server/security/authentication/certificate-management.mdx#authorization-levels-in-client-certificates) - * [Partial Access to Database](../../../server/security/authentication/certificate-management.mdx#partial-access-to-database) -* [Create and Configure Certificates](../../../server/security/authentication/certificate-management.mdx#create-and-configure-certificates) - * [List of Registered Certificates](../../../server/security/authentication/certificate-management.mdx#list-of-registered-certificates) - * [Generate Client Certificate](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) - * [Edit Certificate](../../../server/security/authentication/certificate-management.mdx#edit-certificate) +* [Studio Certificate Management View](#studio-certificates-management-view) +* [The RavenDB Security Authorization Approach](#the-ravendb-security-authorization-approach) + * [Authorization Levels in Client Certificates](#authorization-levels-in-client-certificates) + * [Partial Access to Database](#partial-access-to-database) +* [Create and Configure Certificates](#create-and-configure-certificates) + * [List of Registered Certificates](#list-of-registered-certificates) + * [Generate Client Certificate](#generate-client-certificate) + * [Edit Certificate](#edit-certificate) * [Enabling Communication Between Servers: Importing and Exporting Certificates](../../../server/security/authentication/certificate-management.mdx#enabling-communication-between-servers:-importing-and-exporting-certificates) - * [Export Server Certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) - * [Upload an Existing Certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) - * [Certificate Collections](../../../server/security/authentication/certificate-management.mdx#certificate-collections) - * [Private Keys](../../../server/security/authentication/certificate-management.mdx#private-keys) - * [Client Certificate Chain of Trust](../../../server/security/authentication/certificate-management.mdx#client-certificate-chain-of-trust) + * [Export Server Certificates](#export-server-certificates) + * [Upload an Existing Certificate](#upload-an-existing-certificate) + * [Certificate Collections](#certificate-collections) + * [Private Keys](#private-keys) + * [Client Certificate Chain of Trust](#client-certificate-chain-of-trust) ## Studio Certificates Management View @@ -48,19 +48,19 @@ In this page: 3. **Client certificate** ![Client Certificate Button Options](./assets/client-certificate-button-options.png) * **Generate client certificate** - [Create and configure](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) a new client certificate + [Create and configure](#generate-client-certificate) a new client certificate * **Upload client certificate** - [Import a client certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) that was exported from another server so that they can communicate. + [Import a client certificate](#upload-an-existing-certificate) that was exported from another server so that they can communicate. 4. **Server certificates** ![Server Certificates Button Options](./assets/server-certificates-button-options.png) * **Export server certificates** - [Download server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) so that you can download and then import them into another server. + [Download server certificates](#export-server-certificates) so that you can download and then import them into another server. * **Replace server certificates** [Replace server certificates](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) by uploading another `.pfx` certificate. 5. Status of the current server certificate. * Click [Renew now](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) to renew a server certificate's expiration period. If you did not set up your server with the RavenDB Installation Wizard and Let's Encrypt then **you are responsible** to renew your certificates periodically. -6. Status of current client certificates active in this server. You can remove or [edit client certificates](../../../server/security/authentication/certificate-management.mdx#edit-certificate), +6. Status of current client certificates active in this server. You can remove or [edit client certificates](#edit-certificate), including configuring databases permissions and [authorization (security clearance) levels](../../../server/security/authorization/security-clearance-and-permissions.mdx#authorization-security-clearance-and-permissions) here. @@ -90,7 +90,7 @@ does not really exist within RavenDB in this manner. Instead, cluster admins or * [User](../../../server/security/authorization/security-clearance-and-permissions.mdx#user) Lowest levels of privileges. * "User" certificates are configured to specify which databases people can access with each certificate. - * ["User" authorization levels](../../../server/security/authentication/certificate-management.mdx#setting-user-access-levels) are also configured per database. + * ["User" authorization levels](#setting-user-access-levels) are also configured per database. In most cases, users do not access RavenDB directly. Aside from admins and developers during the development process, all access to the data inside RavenDB is expected to be done through your applications. A security mechanism on a per-user basis is not practical in complex systems @@ -121,19 +121,19 @@ any and all documents in that database unless protection is explicitly configure There are two approaches to giving partial access to a database: - * [Using ETL for selective, one-way data transfer](../../../server/security/authentication/certificate-management.mdx#using-etl-for-selective-one-way-data-transfer) - * [Setting "User" Access Levels](../../../server/security/authentication/certificate-management.mdx#setting-user-access-levels) + * [Using ETL for selective, one-way data transfer](#using-etl-for-selective-one-way-data-transfer) + * [Setting "User" Access Levels](#setting-user-access-levels) #### *Using ETL for selective, one-way data transfer* Some developers need to provide partial access to a database that also contains sensitive data. One approach is to set up an [Extract, Transform, Load (ETL) task](../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx): 1. [Create](../../../studio/database/create-new-database/general-flow.mdx) a dedicated database that the public will be able to access. -2. [Generate a client certificate](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) with "User" security clearance so that +2. [Generate a client certificate](#generate-client-certificate) with "User" security clearance so that you can configure it to give access only to the dedicated, public-facing database. 3. If the dedicated database is on a different cluster than the source database: (This is optional. If both databases are on the same cluster, skip to step 4.) - * [Export (download) server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) from the **destination server**. - * [Upload the .pfx certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) to the **source server** to enable the two to connect. + * [Export (download) server certificates](#export-server-certificates) from the **destination server**. + * [Upload the .pfx certificate](#upload-an-existing-certificate) to the **source server** to enable the two to connect. * While uploading, configure the certificate to give access to the target source database. 4. Then set up an [ETL](../../../server/ongoing-tasks/etl/raven.mdx) task from the source database to the exposed, destination database. * Set up a Javascript [Transform script](../../../server/ongoing-tasks/etl/basics.mdx#transform) in the ETL to automatically filter the information passed from the source to destination databases. @@ -164,12 +164,12 @@ With this clearance, you can set a different access level to each database. The -This approach is similar to the HR Manager and Customers certificates in the example given [above](../../../server/security/authentication/certificate-management.mdx#authorization-levels-in-client-certificates). +This approach is similar to the HR Manager and Customers certificates in the example given [above](#authorization-levels-in-client-certificates). It enables developers to control access levels by configuring client certificates. -* To learn how to configure each client certificate's database permissions and authorization levels via the RavenDB Studio GUI, see [Create and Configure Certificates](../../../server/security/authentication/certificate-management.mdx#create-and-configure-certificates). +* To learn how to configure each client certificate's database permissions and authorization levels via the RavenDB Studio GUI, see [Create and Configure Certificates](#create-and-configure-certificates). * To learn how to configure client certificates via CLI, see [Authentication: Client Certificate Usage](../../../server/security/authentication/client-certificate-usage.mdx#authentication-client-certificate-usage) @@ -287,8 +287,8 @@ The following section explains how to give configurable access that enables comm To connect two secure databases, the destination cluster needs to trust the source cluster. To achieve that you need to: -a. **Export** ([download](../../../server/security/authentication/certificate-management.mdx#export-server-certificates)) the server certificate **from the source server**. -b. **Upload** ([import](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate)) the downloaded certificate **into the destination server**. +a. **Export** ([download](#export-server-certificates)) the server certificate **from the source server**. +b. **Upload** ([import](#upload-an-existing-certificate)) the downloaded certificate **into the destination server**. @@ -298,19 +298,19 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana 2. Click **Server certificates** in the source server. ![Server Certificates Button Options](./assets/server-certificates-button-options.png) * **Export server certificates** - [Download server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) + [Download server certificates](#export-server-certificates) so that you can download and then import them into another server. 3. Click **Client certificate** in the destination server. ![Client Certificate Button Options](./assets/client-certificate-button-options.png) * **Upload client certificate** - [Import a client certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) + [Import a client certificate](#upload-an-existing-certificate) that was exported from another server so that the two can communicate. ### Export Server Certificates ![Figure 6. Export Server Certificates](./assets/export-server-certificates.png) This option allows you to export the server certificate as a .pfx file. In the case of a cluster which contains several different server certificates, -a .pfx [collection](../../../server/security/authentication/certificate-management.mdx#certificate-collections) will be exported. +a .pfx [collection](#certificate-collections) will be exported. ### Upload an Existing Certificate Click the **Client certificate** button, select **Upload client certificate** and you will see the following window. diff --git a/versioned_docs/version-6.2/server/security/authentication/lets-encrypt-certificates.mdx b/versioned_docs/version-6.2/server/security/authentication/lets-encrypt-certificates.mdx index 305554f5d4..ae4ef8c8a5 100644 --- a/versioned_docs/version-6.2/server/security/authentication/lets-encrypt-certificates.mdx +++ b/versioned_docs/version-6.2/server/security/authentication/lets-encrypt-certificates.mdx @@ -108,7 +108,7 @@ When your server uses a Let's Encrypt certificate obtained via the Setup Wizard, ravendb> triggerCertificateRefresh [-replaceImmediately] ``` -Both methods trigger the same certificate replacement process described [above](../../../server/security/authentication/lets-encrypt-certificates.mdx#automatic-renewal-for-lets-encrypt-certificates-obtained-via-ravendb). +Both methods trigger the same certificate replacement process described [above](#automatic-renewal-for-lets-encrypt-certificates-obtained-via-ravendb). If a node is down when renewal is triggered, the cluster will complete the operation without that node. **When bringing that node up, the certificate must be replaced manually.** diff --git a/versioned_docs/version-6.2/server/security/authentication/recover-from-expired-certificate.mdx b/versioned_docs/version-6.2/server/security/authentication/recover-from-expired-certificate.mdx index bb03a50a4f..338c8945eb 100644 --- a/versioned_docs/version-6.2/server/security/authentication/recover-from-expired-certificate.mdx +++ b/versioned_docs/version-6.2/server/security/authentication/recover-from-expired-certificate.mdx @@ -37,12 +37,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; the server machine. * In this article: - * [What happens when the server certificate expires](../../../server/security/authentication/recover-from-expired-certificate.mdx#what-happens-when-the-server-certificate-expires) - * [Recover the server](../../../server/security/authentication/recover-from-expired-certificate.mdx#recover-the-server) - * [Obtain a valid certificate](../../../server/security/authentication/recover-from-expired-certificate.mdx#obtain-a-valid-certificate) - * [Install the new certificate](../../../server/security/authentication/recover-from-expired-certificate.mdx#install-the-new-certificate) - * [Recover a cluster](../../../server/security/authentication/recover-from-expired-certificate.mdx#recover-a-cluster) - * [Prevent recurrence](../../../server/security/authentication/recover-from-expired-certificate.mdx#prevent-recurrence) + * [What happens when the server certificate expires](#what-happens-when-the-server-certificate-expires) + * [Recover the server](#recover-the-server) + * [Obtain a valid certificate](#obtain-a-valid-certificate) + * [Install the new certificate](#install-the-new-certificate) + * [Recover a cluster](#recover-a-cluster) + * [Prevent recurrence](#prevent-recurrence) diff --git a/versioned_docs/version-6.2/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx b/versioned_docs/version-6.2/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx index 13a60d84a2..f14626cbbb 100644 --- a/versioned_docs/version-6.2/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx +++ b/versioned_docs/version-6.2/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; your own Let's Encrypt certificates as client certificates, the next certificate renewal may cause permission issues that need to be handled manually. -* Find [whether this issue is relevant for you](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#current-situation) - and if so, [how to handle it](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#solutions). +* Find [whether this issue is relevant for you](#current-situation) + and if so, [how to handle it](#solutions). * **In this page**: - * [Errors Relevant To This Issue](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#errors-relevant-to-this-issue) - * [Background And Current Situation](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#background-and-current-situation) - * [Solutions](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#solutions) + * [Errors Relevant To This Issue](#errors-relevant-to-this-issue) + * [Background And Current Situation](#background-and-current-situation) + * [Solutions](#solutions) ## Errors Relevant To This Issue diff --git a/versioned_docs/version-6.2/server/security/authorization/security-clearance-and-permissions.mdx b/versioned_docs/version-6.2/server/security/authorization/security-clearance-and-permissions.mdx index 9e08e8607c..db9525bb61 100644 --- a/versioned_docs/version-6.2/server/security/authorization/security-clearance-and-permissions.mdx +++ b/versioned_docs/version-6.2/server/security/authorization/security-clearance-and-permissions.mdx @@ -24,12 +24,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A client certificate's security clearance can be one of the following: Cluster Admin, Operator, User. * In this page: - * [Cluster Admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) - * [Operator](../../../server/security/authorization/security-clearance-and-permissions.mdx#operator) - * [User](../../../server/security/authorization/security-clearance-and-permissions.mdx#user) - * [Admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#section) - * [Read/Write](../../../server/security/authorization/security-clearance-and-permissions.mdx#section-1) - * [Read Only](../../../server/security/authorization/security-clearance-and-permissions.mdx#section-2) + * [Cluster Admin](#cluster-admin) + * [Operator](#operator) + * [User](#user) + * [Admin](#section) + * [Read/Write](#section-1) + * [Read Only](#section-2) ## Cluster Admin diff --git a/versioned_docs/version-6.2/server/security/common-errors-and-faq.mdx b/versioned_docs/version-6.2/server/security/common-errors-and-faq.mdx index 5eb4d347ba..5b76fdb978 100644 --- a/versioned_docs/version-6.2/server/security/common-errors-and-faq.mdx +++ b/versioned_docs/version-6.2/server/security/common-errors-and-faq.mdx @@ -17,20 +17,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This article explains some of the common security configuration errors and how to handle them. * In this page - * [Setup Wizard Issues](../../server/security/common-errors-and-faq.mdx#setup-wizard-issues) - * [Changing Configurations and Renewals Issues](../../server/security/common-errors-and-faq.mdx#changing-configurations-and-renewals-issues) - * [Authentication Issues](../../server/security/common-errors-and-faq.mdx#authentication-issues) - * [Encryption Issues](../../server/security/common-errors-and-faq.mdx#encryption-issues) + * [Setup Wizard Issues](#setup-wizard-issues) + * [Changing Configurations and Renewals Issues](#changing-configurations-and-renewals-issues) + * [Authentication Issues](#authentication-issues) + * [Encryption Issues](#encryption-issues) ## Setup Wizard Issues -* [Server cannot bind to the provided private IP address](../../server/security/common-errors-and-faq.mdx#server-cannot-bind-to-the-provided-private-ip-address) -* [Ports are blocked by the firewall](../../server/security/common-errors-and-faq.mdx#ports-are-blocked-by-the-firewall) -* [DNS is cached locally](../../server/security/common-errors-and-faq.mdx#dns-is-cached-locally) -* [Long DNS propagation time](../../server/security/common-errors-and-faq.mdx#long-dns-propagation-time) -* [If I already have the Zip file, can I avoid repeating the setup process?](../../server/security/common-errors-and-faq.mdx#if-i-already-have-the-zip-file-can-i-avoid-repeating-the-setup-process) +* [Server cannot bind to the provided private IP address](#server-cannot-bind-to-the-provided-private-ip-address) +* [Ports are blocked by the firewall](#ports-are-blocked-by-the-firewall) +* [DNS is cached locally](#dns-is-cached-locally) +* [Long DNS propagation time](#long-dns-propagation-time) +* [If I already have the Zip file, can I avoid repeating the setup process?](#if-i-already-have-the-zip-file-can-i-avoid-repeating-the-setup-process) ### Server cannot bind to the provided private IP address If the IP/port is not accessible on your machine, you'll get the following error. @@ -130,12 +130,12 @@ When building a cluster, repeat this step with nodes B, C, and so on. ## Changing Configurations and Renewals Issues -* [After installing with Let's Encrypt, can I change the DNS records?](../../server/security/common-errors-and-faq.mdx#after-installing-with-lets-encrypt-can-i-change-the-dns-records) -* [Can I change the (private) IP address RavenDB binds to?](../../server/security/common-errors-and-faq.mdx#can-i-change-the-private-ip-address-ravendb-binds-to) -* [The Let's Encrypt certificate is about to expire but doesn't renew automatically](../../server/security/common-errors-and-faq.mdx#the-lets-encrypt-certificate-is-about-to-expire-but-doesnt-renew-automatically) -* [What should I do when my license expires?](../../server/security/common-errors-and-faq.mdx#what-should-i-do-when-my-license-expires) -* [Let's Encrypt certificate permission errors after renewal](../../server/security/common-errors-and-faq.mdx#lets-encrypt-certificate-permission-errors-after-renewal) -* [How do I recover from an expired server certificate?](../../server/security/common-errors-and-faq.mdx#how-do-i-recover-from-an-expired-server-certificate) +* [After installing with Let's Encrypt, can I change the DNS records?](#after-installing-with-lets-encrypt-can-i-change-the-dns-records) +* [Can I change the (private) IP address RavenDB binds to?](#can-i-change-the-private-ip-address-ravendb-binds-to) +* [The Let's Encrypt certificate is about to expire but doesn't renew automatically](#the-lets-encrypt-certificate-is-about-to-expire-but-doesnt-renew-automatically) +* [What should I do when my license expires?](#what-should-i-do-when-my-license-expires) +* [Let's Encrypt certificate permission errors after renewal](#lets-encrypt-certificate-permission-errors-after-renewal) +* [How do I recover from an expired server certificate?](#how-do-i-recover-from-an-expired-server-certificate) ### After installing with Let's Encrypt, can I change the DNS records? Yes. @@ -229,16 +229,16 @@ See [recover from an expired certificate](../../server/security/authentication/r ## Authentication Issues -* [Authentication Error Occurred using Edge](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-edge) -* [Authentication Error Occurred using Chrome](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-chrome) -* [RavenDB is running as a service in Windows and Chrome doesn't use the client certificate from the OS store](../../server/security/common-errors-and-faq.mdx#ravendb-is-running-as-a-service-in-windows-and-chrome-doesnt-use-the-client-certificate-from-the-os-store) -* [Authentication Error Occurred in Firefox](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-in-firefox) -* [Cannot Import the Client Certificate to Firefox](../../server/security/common-errors-and-faq.mdx#cannot-import-the-client-certificate-to-firefox) -* [Getting the full error using PowerShell](../../server/security/common-errors-and-faq.mdx#getting-the-full-error-using-powershell) -* [Not using TLS](../../server/security/common-errors-and-faq.mdx#not-using-tls) -* [How to regain access to a server when you have physical access but no client certificate](../../server/security/common-errors-and-faq.mdx#how-to-regain-access-to-a-server-when-you-have-physical-access-but-no-client-certificate) -* [Certificate is not recognized when setting up on Azure App Services](../../server/security/common-errors-and-faq.mdx#certificate-is-not-recognized-when-setting-up-on-azure-app-services) -* [Automatic cluster certificate renewal following migration to 4.2](../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-42) +* [Authentication Error Occurred using Edge](#authentication-error-occurred-using-edge) +* [Authentication Error Occurred using Chrome](#authentication-error-occurred-using-chrome) +* [RavenDB is running as a service in Windows and Chrome doesn't use the client certificate from the OS store](#ravendb-is-running-as-a-service-in-windows-and-chrome-doesnt-use-the-client-certificate-from-the-os-store) +* [Authentication Error Occurred in Firefox](#authentication-error-occurred-in-firefox) +* [Cannot Import the Client Certificate to Firefox](#cannot-import-the-client-certificate-to-firefox) +* [Getting the full error using PowerShell](#getting-the-full-error-using-powershell) +* [Not using TLS](#not-using-tls) +* [How to regain access to a server when you have physical access but no client certificate](#how-to-regain-access-to-a-server-when-you-have-physical-access-but-no-client-certificate) +* [Certificate is not recognized when setting up on Azure App Services](#certificate-is-not-recognized-when-setting-up-on-azure-app-services) +* [Automatic cluster certificate renewal following migration to 4.2](#automatic-cluster-certificate-renewal-following-migration-to-42) ### Authentication Error Occurred using Edge You cannot access Studio using Edge, though during @@ -340,7 +340,7 @@ looks for the certificate not at the OS root but at the Chrome root store. To solve these issues: Using a user that the service is available for, install or import the certificate PFX -[as described above](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-chrome). +[as described above](#authentication-error-occurred-using-chrome). ### Authentication Error Occurred in Firefox You cannot access the Studio using Firefox even though you have finished the setup wizard successfully and you also checked the box saying "Automatically register the admin client certificate in this (local) OS". diff --git a/versioned_docs/version-6.2/server/security/encryption/encryption-at-rest.mdx b/versioned_docs/version-6.2/server/security/encryption/encryption-at-rest.mdx index ce1bed05c9..0a6e04764f 100644 --- a/versioned_docs/version-6.2/server/security/encryption/encryption-at-rest.mdx +++ b/versioned_docs/version-6.2/server/security/encryption/encryption-at-rest.mdx @@ -32,7 +32,7 @@ As long as the database is idle and there are no requests to serve, everything i Once a request is made, RavenDB will start a transaction (either read or write) and decrypt just the necessary data into memory. Then it will serve the request, and when the transaction is finished, modified pages are encrypted and written back to the datafile. The data is -[locked](../../../server/security/encryption/encryption-at-rest.mdx#locking-memory) during the transaction by default, and it is zeroed when the transaction completes. +[locked](#locking-memory) during the transaction by default, and it is zeroed when the transaction completes. 1. RavenDB makes sure that **no data is written to disk as plain text**. It will always be encrypted. diff --git a/versioned_docs/version-6.2/server/security/encryption/secret-key-management.mdx b/versioned_docs/version-6.2/server/security/encryption/secret-key-management.mdx index f7343c598d..983552b425 100644 --- a/versioned_docs/version-6.2/server/security/encryption/secret-key-management.mdx +++ b/versioned_docs/version-6.2/server/security/encryption/secret-key-management.mdx @@ -20,8 +20,8 @@ If the key is to be encrypted, another key is needed, and so on. In RavenDB this can be handled in one of two ways: -1. [Providing a master key to RavenDB](../../../server/security/encryption/secret-key-management.mdx#providing-a-master-key-to-ravendb) -2. [Relying on the OS protection methods](../../../server/security/encryption/secret-key-management.mdx#relying-on-the-os-protection-methods) +1. [Providing a master key to RavenDB](#providing-a-master-key-to-ravendb) +2. [Relying on the OS protection methods](#relying-on-the-os-protection-methods) ## Providing a Master Key to RavenDB diff --git a/versioned_docs/version-6.2/server/storage/content/_documents-compression-csharp.mdx b/versioned_docs/version-6.2/server/storage/content/_documents-compression-csharp.mdx index 0d136ec0a6..b86d76fac9 100644 --- a/versioned_docs/version-6.2/server/storage/content/_documents-compression-csharp.mdx +++ b/versioned_docs/version-6.2/server/storage/content/_documents-compression-csharp.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; or by updating the database record from the Client API, see below. * In this page: - * [Overview](../../../server/storage/documents-compression.mdx#overview) - * [Compression -vs- Compaction](../../../server/storage/documents-compression.mdx#compression--vs--compaction) - * [Set compression for all collections](../../../server/storage/documents-compression.mdx#set-compression-for-all-collections) - * [Set compression for selected collections](../../../server/storage/documents-compression.mdx#set-compression-for-selected-collections) - * [Syntax](../../../server/storage/documents-compression.mdx#syntax) + * [Overview](#overview) + * [Compression -vs- Compaction](#compression--vs--compaction) + * [Set compression for all collections](#set-compression-for-all-collections) + * [Set compression for selected collections](#set-compression-for-selected-collections) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/server/storage/content/_documents-compression-nodejs.mdx b/versioned_docs/version-6.2/server/storage/content/_documents-compression-nodejs.mdx index 41d6ab887b..d8a9eac073 100644 --- a/versioned_docs/version-6.2/server/storage/content/_documents-compression-nodejs.mdx +++ b/versioned_docs/version-6.2/server/storage/content/_documents-compression-nodejs.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; or by updating the database record from the Client API, see below. * In this page: - * [Overview](../../../server/storage/documents-compression.mdx#overview) - * [Compression -vs- Compaction](../../../server/storage/documents-compression.mdx#compression--vs--compaction) - * [Set compression for all collections](../../../server/storage/documents-compression.mdx#set-compression-for-all-collections) - * [Set compression for selected collections](../../../server/storage/documents-compression.mdx#set-compression-for-selected-collections) - * [Syntax](../../../server/storage/documents-compression.mdx#syntax) + * [Overview](#overview) + * [Compression -vs- Compaction](#compression--vs--compaction) + * [Set compression for all collections](#set-compression-for-all-collections) + * [Set compression for selected collections](#set-compression-for-selected-collections) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-6.2/server/storage/customizing-raven-data-files-locations.mdx b/versioned_docs/version-6.2/server/storage/customizing-raven-data-files-locations.mdx index 744f894d75..896b8b705d 100644 --- a/versioned_docs/version-6.2/server/storage/customizing-raven-data-files-locations.mdx +++ b/versioned_docs/version-6.2/server/storage/customizing-raven-data-files-locations.mdx @@ -21,12 +21,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A script can be used to automate the different location definitions. * In this page: - * [Why store data on different devices](../../server/storage/customizing-raven-data-files-locations.mdx#why-store-data-on-different-devices) - * [Configuring temp files location](../../server/storage/customizing-raven-data-files-locations.mdx#configuring-temp-files-location) - * [Configuring data files location](../../server/storage/customizing-raven-data-files-locations.mdx#configuring-data-files-location) - * [Automate storage definitions](../../server/storage/customizing-raven-data-files-locations.mdx#automate-storage-definitions) - * [Script example - Basic usage](../../server/storage/customizing-raven-data-files-locations.mdx#script-example---basic-usage) - * [Script example - Point Indexes to different location](../../server/storage/customizing-raven-data-files-locations.mdx#script-example---point-indexes-to-different-location) + * [Why store data on different devices](#why-store-data-on-different-devices) + * [Configuring temp files location](#configuring-temp-files-location) + * [Configuring data files location](#configuring-data-files-location) + * [Automate storage definitions](#automate-storage-definitions) + * [Script example - Basic usage](#script-example---basic-usage) + * [Script example - Point Indexes to different location](#script-example---point-indexes-to-different-location) ## Why store data on different devices diff --git a/versioned_docs/version-6.2/server/storage/directory-structure.mdx b/versioned_docs/version-6.2/server/storage/directory-structure.mdx index 53cbeb74ad..6ceb78f212 100644 --- a/versioned_docs/version-6.2/server/storage/directory-structure.mdx +++ b/versioned_docs/version-6.2/server/storage/directory-structure.mdx @@ -17,8 +17,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * RavenDB keeps all data under the location specified by the [DataDir](../../server/configuration/core-configuration.mdx#datadir) configuration value. * In this page: - * [On-disk Data Structure](../../server/storage/directory-structure.mdx#on-disk-data-structure) - * [Voron Storage Environment](../../server/storage/directory-structure.mdx#voron-storage-environment) + * [On-disk Data Structure](#on-disk-data-structure) + * [Voron Storage Environment](#voron-storage-environment) ## On-disk Data Structure diff --git a/versioned_docs/version-6.2/server/storage/storage-engine.mdx b/versioned_docs/version-6.2/server/storage/storage-engine.mdx index 31bb7fdbee..9c995eb003 100644 --- a/versioned_docs/version-6.2/server/storage/storage-engine.mdx +++ b/versioned_docs/version-6.2/server/storage/storage-engine.mdx @@ -26,11 +26,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; Fixed-Sized B+Trees. * In this page: - * [Transaction support](../../server/storage/storage-engine.mdx#transaction-support) - * [Single write model](../../server/storage/storage-engine.mdx#single-write-model) - * [Memory-mapped files](../../server/storage/storage-engine.mdx#memory-mapped-files) - * [Requirements](../../server/storage/storage-engine.mdx#requirements) - * [Limitations](../../server/storage/storage-engine.mdx#limitations) + * [Transaction support](#transaction-support) + * [Single write model](#single-write-model) + * [Memory-mapped files](#memory-mapped-files) + * [Requirements](#requirements) + * [Limitations](#limitations) ## Transaction support diff --git a/versioned_docs/version-6.2/server/tcp-compression.mdx b/versioned_docs/version-6.2/server/tcp-compression.mdx index e413c3af06..993054f875 100644 --- a/versioned_docs/version-6.2/server/tcp-compression.mdx +++ b/versioned_docs/version-6.2/server/tcp-compression.mdx @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [TCP Compression](../server/tcp-compression.mdx#tcp-compression) - * [Compression Algorithm and Ratio](../server/tcp-compression.mdx#compression-algorithm-and-ratio) - * [Enabling TCP Compression](../server/tcp-compression.mdx#enabling-tcp-compression) - * [Disabling TCP Compression](../server/tcp-compression.mdx#disabling-tcp-compression) + * [TCP Compression](#tcp-compression) + * [Compression Algorithm and Ratio](#compression-algorithm-and-ratio) + * [Enabling TCP Compression](#enabling-tcp-compression) + * [Disabling TCP Compression](#disabling-tcp-compression) ## TCP Compression diff --git a/versioned_docs/version-6.2/server/troubleshooting/collect-info.mdx b/versioned_docs/version-6.2/server/troubleshooting/collect-info.mdx index b5ea2dfaa5..a1ce605014 100644 --- a/versioned_docs/version-6.2/server/troubleshooting/collect-info.mdx +++ b/versioned_docs/version-6.2/server/troubleshooting/collect-info.mdx @@ -22,12 +22,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Provide incident description](../../server/troubleshooting/collect-info.mdx#provide-incident-description) - * [Create debug package](../../server/troubleshooting/collect-info.mdx#create-debug-package) - * [Enable logs for ongoing issues](../../server/troubleshooting/collect-info.mdx#enable-logs-for-ongoing-issues) - * [Download logs](../../server/troubleshooting/collect-info.mdx#download-logs) - * [Reproduce scenario](../../server/troubleshooting/collect-info.mdx#reproduce-scenario) - * [Create failing test](../../server/troubleshooting/collect-info.mdx#create-failing-test) + * [Provide incident description](#provide-incident-description) + * [Create debug package](#create-debug-package) + * [Enable logs for ongoing issues](#enable-logs-for-ongoing-issues) + * [Download logs](#download-logs) + * [Reproduce scenario](#reproduce-scenario) + * [Create failing test](#create-failing-test) @@ -192,7 +192,7 @@ __Before sending the log files__, perform the following checks: * If the incident is over and you can reproduce it, then first verify logging level is set to 'Information'. -* See how to enable the logs in [Enable logs](../../server/troubleshooting/collect-info.mdx#enable-logs-for-ongoing-issues). +* See how to enable the logs in [Enable logs](#enable-logs-for-ongoing-issues). diff --git a/versioned_docs/version-6.2/server/troubleshooting/debug-routes.mdx b/versioned_docs/version-6.2/server/troubleshooting/debug-routes.mdx index f20e90c9c5..c85891dce6 100644 --- a/versioned_docs/version-6.2/server/troubleshooting/debug-routes.mdx +++ b/versioned_docs/version-6.2/server/troubleshooting/debug-routes.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page contains a comprehensive list of endpoints for debugging and testing. * In this page: - * [Debug Endpoints](../../server/troubleshooting/debug-routes.mdx#debug-endpoints) - * [Production Endpoints](../../server/troubleshooting/debug-routes.mdx#production-endpoints) + * [Debug Endpoints](#debug-endpoints) + * [Production Endpoints](#production-endpoints) For the endpoints that begin with `/databases/*/`, replace `*` with the name of your database. diff --git a/versioned_docs/version-6.2/server/troubleshooting/traffic-watch.mdx b/versioned_docs/version-6.2/server/troubleshooting/traffic-watch.mdx index 3deeb4182a..3bde86bb33 100644 --- a/versioned_docs/version-6.2/server/troubleshooting/traffic-watch.mdx +++ b/versioned_docs/version-6.2/server/troubleshooting/traffic-watch.mdx @@ -23,8 +23,8 @@ import Panel from '@site/src/components/Panel'; Both the live stream and log-to-file can be active at the same time. * In this page: - * [Accessing Traffic Watch](../../server/troubleshooting/traffic-watch.mdx#accessing-traffic-watch) - * [Performance impact](../../server/troubleshooting/traffic-watch.mdx#performance-impact) + * [Accessing Traffic Watch](#accessing-traffic-watch) + * [Performance impact](#performance-impact) diff --git a/versioned_docs/version-6.2/sharding/administration/anchoring-documents.mdx b/versioned_docs/version-6.2/sharding/administration/anchoring-documents.mdx index 6fbed78165..1c7c5d1c53 100644 --- a/versioned_docs/version-6.2/sharding/administration/anchoring-documents.mdx +++ b/versioned_docs/version-6.2/sharding/administration/anchoring-documents.mdx @@ -23,10 +23,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To gain control over which specific shard a document will reside in, see [sharding by prefix](../../sharding/administration/sharding-by-prefix.mdx). * In this page: - * [Overview](../../sharding/administration/anchoring-documents.mdx#overview) - * [Anchor multiple documents to the same bucket as a specific document](../../sharding/administration/anchoring-documents.mdx#anchor-multiple-documents-to-the-same-bucket-as-a-specific-document) - * [Anchor multiple documents using a common suffix](../../sharding/administration/anchoring-documents.mdx#anchor-multiple-documents-using-a-common-suffix) - * [Examples](../../sharding/administration/anchoring-documents.mdx#examples) + * [Overview](#overview) + * [Anchor multiple documents to the same bucket as a specific document](#anchor-multiple-documents-to-the-same-bucket-as-a-specific-document) + * [Anchor multiple documents using a common suffix](#anchor-multiple-documents-using-a-common-suffix) + * [Examples](#examples) ## Overview diff --git a/versioned_docs/version-6.2/sharding/administration/api-admin.mdx b/versioned_docs/version-6.2/sharding/administration/api-admin.mdx index 67b441e3eb..cd20e3de53 100644 --- a/versioned_docs/version-6.2/sharding/administration/api-admin.mdx +++ b/versioned_docs/version-6.2/sharding/administration/api-admin.mdx @@ -19,15 +19,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; a sharded database using Studio. * In this page: - * [Creating a Sharded Database](../../sharding/administration/api-admin.mdx#creating-a-sharded-database) - * [Orchestrator Administration](../../sharding/administration/api-admin.mdx#orchestrator-administration) - * [Adding an Orchestrator](../../sharding/administration/api-admin.mdx#adding-an-orchestrator) - * [Removing an Orchestrator](../../sharding/administration/api-admin.mdx#removing-an-orchestrator) - * [Shard Administration](../../sharding/administration/api-admin.mdx#shard-administration) - * [Adding a Shard](../../sharding/administration/api-admin.mdx#adding-a-shard) - * [Adding a Shard Replica](../../sharding/administration/api-admin.mdx#adding-a-shard-replica) - * [Promoting a Shard Replica](../../sharding/administration/api-admin.mdx#promoting-a-shard-replica) - * [Removing a Shard](../../sharding/administration/api-admin.mdx#removing-a-shard) + * [Creating a Sharded Database](#creating-a-sharded-database) + * [Orchestrator Administration](#orchestrator-administration) + * [Adding an Orchestrator](#adding-an-orchestrator) + * [Removing an Orchestrator](#removing-an-orchestrator) + * [Shard Administration](#shard-administration) + * [Adding a Shard](#adding-a-shard) + * [Adding a Shard Replica](#adding-a-shard-replica) + * [Promoting a Shard Replica](#promoting-a-shard-replica) + * [Removing a Shard](#removing-a-shard) ## Creating a Sharded Database diff --git a/versioned_docs/version-6.2/sharding/administration/sharding-by-prefix.mdx b/versioned_docs/version-6.2/sharding/administration/sharding-by-prefix.mdx index a7a9b70edc..d6480901b9 100644 --- a/versioned_docs/version-6.2/sharding/administration/sharding-by-prefix.mdx +++ b/versioned_docs/version-6.2/sharding/administration/sharding-by-prefix.mdx @@ -24,20 +24,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * With prefixed sharding, you only control the shard where a document is stored. You cannot control the specific bucket within that shard where the document will reside. This can be partially addressed by [anchoring documents](../../sharding/administration/anchoring-documents.mdx) to a bucket. - Learn more [below](../../sharding/administration/sharding-by-prefix.mdx#prefixed-sharding-vs-anchoring-documents). + Learn more [below](#prefixed-sharding-vs-anchoring-documents). * In this page: - * [Why use prefixed sharding](../../sharding/administration/sharding-by-prefix.mdx#why-use-prefixed-sharding) - * [Overview](../../sharding/administration/sharding-by-prefix.mdx#overview) - * [Bucket management](../../sharding/administration/sharding-by-prefix.mdx#bucket-management) - * [Adding prefixes via Studio](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-studio) - * [Adding prefixes via Client API](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-client-api) - * [Add prefixes when creating a database](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-when-creating-a-database) - * [Add prefixes after database creation](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-after-database-creation) - * [Removing prefixes](../../sharding/administration/sharding-by-prefix.mdx#removing-prefixes) - * [Updating shard configurations for prefixes](../../sharding/administration/sharding-by-prefix.mdx#updating-shard-configurations-for-prefixes) - * [Querying selected shards by prefix](../../sharding/administration/sharding-by-prefix.mdx#querying-selected-shards-by-prefix) - * [Prefixed sharding vs Anchoring documents](../../sharding/administration/sharding-by-prefix.mdx#prefixed-sharding-vs-anchoring-documents) + * [Why use prefixed sharding](#why-use-prefixed-sharding) + * [Overview](#overview) + * [Bucket management](#bucket-management) + * [Adding prefixes via Studio](#adding-prefixes-via-studio) + * [Adding prefixes via Client API](#adding-prefixes-via-client-api) + * [Add prefixes when creating a database](#add-prefixes-when-creating-a-database) + * [Add prefixes after database creation](#add-prefixes-after-database-creation) + * [Removing prefixes](#removing-prefixes) + * [Updating shard configurations for prefixes](#updating-shard-configurations-for-prefixes) + * [Querying selected shards by prefix](#querying-selected-shards-by-prefix) + * [Prefixed sharding vs Anchoring documents](#prefixed-sharding-vs-anchoring-documents) ## Why use prefixed sharding @@ -71,7 +71,7 @@ reduces network latency for region-specific operations, and enhances overall sys * To store documents on a specific shard, define the target shard for each document ID prefix that you add. Documents with IDs matching any of the defined prefixes will be routed to the corresponding shard. - Learn how to [add prefixes](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-client-api) below. + Learn how to [add prefixes](#adding-prefixes-via-client-api) below. * For example, you can define that all documents with an ID starting with `users/us/` will be stored in shard **#0**. Consequently, the following sample documents will be stored in shard **#0**: @@ -392,7 +392,7 @@ await store.Maintenance.SendAsync(deletePrefixOp); * **When removing a shard from an existing prefix configuration**, you must first manually move the buckets from the removed shard to the other shards that are assigned to this prefix. -* In the below example, in addition to shard **#2** that was configured in the [previous](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-after-database-creation) example, +* In the below example, in addition to shard **#2** that was configured in the [previous](#add-prefixes-after-database-creation) example, we are adding shard **#0** as a destination for documents with prefix `users/eu/`. diff --git a/versioned_docs/version-6.2/sharding/administration/studio-admin.mdx b/versioned_docs/version-6.2/sharding/administration/studio-admin.mdx index 216a30ab7f..93c9f5ae2d 100644 --- a/versioned_docs/version-6.2/sharding/administration/studio-admin.mdx +++ b/versioned_docs/version-6.2/sharding/administration/studio-admin.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; a sharded database using API commands. * In this page: - * [Creating a sharded database](../../sharding/administration/studio-admin.mdx#creating-a-sharded-database) - * [Database View](../../sharding/administration/studio-admin.mdx#database-view) - * [Database Group](../../sharding/administration/studio-admin.mdx#database-group) + * [Creating a sharded database](#creating-a-sharded-database) + * [Database View](#database-view) + * [Database Group](#database-group) ## Creating a sharded database @@ -100,7 +100,7 @@ be available here: 6. **Backups view** Click to manage [backup tasks](../../studio/database/tasks/backup-task.mdx) and restore existing backups. 7. **Manage group** - Click to manage the database group ([see below](../../sharding/administration/studio-admin.mdx#database-group)). + Click to manage the database group ([see below](#database-group)). diff --git a/versioned_docs/version-6.2/sharding/backup-and-restore/backup.mdx b/versioned_docs/version-6.2/sharding/backup-and-restore/backup.mdx index a5088000f7..e55bdb7994 100644 --- a/versioned_docs/version-6.2/sharding/backup-and-restore/backup.mdx +++ b/versioned_docs/version-6.2/sharding/backup-and-restore/backup.mdx @@ -36,16 +36,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; backup **can** be created for a sharded database. * In this page: - * [Backup](../../sharding/backup-and-restore/backup.mdx#backup) - * [Sharded and Non-Sharded Backup Tasks](../../sharding/backup-and-restore/backup.mdx#sharded-and-non-sharded-backup-tasks) - * [Backup Storage: Local and Remote](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) - * [Backup Files Extension and Structure](../../sharding/backup-and-restore/backup.mdx#backup-files-extension-and-structure) - * [Backup Type](../../sharding/backup-and-restore/backup.mdx#backup-type) - * [Backup Scope](../../sharding/backup-and-restore/backup.mdx#backup-scope) - * [Naming Convention](../../sharding/backup-and-restore/backup.mdx#naming-convention) - * [Server-Wide Backup](../../sharding/backup-and-restore/backup.mdx#server-wide-backup) - * [Example](../../sharding/backup-and-restore/backup.mdx#example) - * [Backup Options Summary](../../sharding/backup-and-restore/backup.mdx#backup-options-summary) + * [Backup](#backup) + * [Sharded and Non-Sharded Backup Tasks](#sharded-and-non-sharded-backup-tasks) + * [Backup Storage: Local and Remote](#backup-storage-local-and-remote) + * [Backup Files Extension and Structure](#backup-files-extension-and-structure) + * [Backup Type](#backup-type) + * [Backup Scope](#backup-scope) + * [Naming Convention](#naming-convention) + * [Server-Wide Backup](#server-wide-backup) + * [Example](#example) + * [Backup Options Summary](#backup-options-summary) ## Backup @@ -98,7 +98,7 @@ manageable proportions no matter what the overall database size is. ## Backup Storage: Local and Remote Backup files can be stored locally and remotely. -Find a code example [here](../../sharding/backup-and-restore/backup.mdx#example). +Find a code example [here](#example). * **Local Backup** A shard's backup task may keep backup data locally, @@ -243,14 +243,14 @@ This type is specific to a sharded database, and casting it using a non-sharded | Option | Available on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | | Store backup files created by shards in **local shard machine storage** | **Yes** | Shards can store the backups they create locally. | -| Store backup files of sharded databases [remotely](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Shards can store the backups they create on remote S3, Azure, or Google Cloud destinations. | +| Store backup files of sharded databases [remotely](#backup-storage-local-and-remote) | **Yes** | Shards can store the backups they create on remote S3, Azure, or Google Cloud destinations. | | Create [Full](../../server/ongoing-tasks/backup-overview.mdx#full-backup) backups for sharded databases | **Yes** | | | Create [Incremental](../../server/ongoing-tasks/backup-overview.mdx#incremental-backup) backups for sharded databases | **Yes** | | | Create [Logical](../../server/ongoing-tasks/backup-overview.mdx#logical-backup) backups for sharded databases | **Yes** | | | Create [Snapshot](../../server/ongoing-tasks/backup-overview.mdx#snapshot) backups for sharded databases | **No** | Snapshot backups CANNOT be created for (nor restored to) sharded databases. | | Create **periodic backup tasks** for sharded databases | **Yes** | | | Run a manual [one-time](../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups) backup operation on a sharded database | **Yes** | | -| Include sharded databases in a [server-wide backup operation](../../sharding/backup-and-restore/backup.mdx#server-wide-backup) | **Yes (logical only)** | A server-wide **logical** backup includes all databases, including sharded ones. Sharded databases are automatically **excluded** from server-wide **snapshot** backups. | +| Include sharded databases in a [server-wide backup operation](#server-wide-backup) | **Yes (logical only)** | A server-wide **logical** backup includes all databases, including sharded ones. Sharded databases are automatically **excluded** from server-wide **snapshot** backups. | diff --git a/versioned_docs/version-6.2/sharding/backup-and-restore/restore.mdx b/versioned_docs/version-6.2/sharding/backup-and-restore/restore.mdx index be0e939345..fd24883c0a 100644 --- a/versioned_docs/version-6.2/sharding/backup-and-restore/restore.mdx +++ b/versioned_docs/version-6.2/sharding/backup-and-restore/restore.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; can retrieve and restore them. Shards must be restored in their - [original order](../../sharding/backup-and-restore/restore.mdx#restore). + [original order](#restore). The backup of shard 1, for example, must be restored as shard 1. * Backup files can be restored from local shard node storage or from @@ -40,14 +40,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; as a sharded database. * In this page: - * [Restore](../../sharding/backup-and-restore/restore.mdx#restore) - * [Set Paths to Backup Files Locations](../../sharding/backup-and-restore/restore.mdx#set-paths-to-backup-files-locations) - * [Define a Restore Configuration](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration) - * [`RestoreBackupConfigurationBase`](../../sharding/backup-and-restore/restore.mdx#section) - * [Run `RestoreBackupOperation` with the Restore Configuration](../../sharding/backup-and-restore/restore.mdx#run--with-the-restore-configuration) - * [Examples](../../sharding/backup-and-restore/restore.mdx#examples) - * [Restoring to a Selected Restore Point](../../sharding/backup-and-restore/restore.mdx#restoring-to-a-selected-restore-point) - * [Restore Options Summary](../../sharding/backup-and-restore/restore.mdx#restore-options-summary) + * [Restore](#restore) + * [Set Paths to Backup Files Locations](#set-paths-to-backup-files-locations) + * [Define a Restore Configuration](#define-a-restore-configuration) + * [`RestoreBackupConfigurationBase`](#section) + * [Run `RestoreBackupOperation` with the Restore Configuration](#run--with-the-restore-configuration) + * [Examples](#examples) + * [Restoring to a Selected Restore Point](#restoring-to-a-selected-restore-point) + * [Restore Options Summary](#restore-options-summary) ## Restore @@ -116,7 +116,7 @@ To restore the database, we pass the a **configuration object**. * The configuration object inherits properties from the `RestoreBackupConfigurationBase` class - ([discussed below](../../sharding/backup-and-restore/restore.mdx#section)) + ([discussed below](#section)) and defines additional sharding-specific settings. * We choose what configuration object to pass the restore operation, by @@ -126,10 +126,10 @@ a **configuration object**. | Configuration Object | Backup Location | Additional Properties | | -------------------- | --------------- | --------------------- | - | `RestoreBackupConfiguration` | Local shard storage | None (see [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromS3Configuration` | AWS S3 Bucket | `S3Settings` (see S3 [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromAzureConfiguration` | MS Azure Blob | `AzureSettings` (see Azure [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromGoogleCloudConfiguration` | Google Cloud Bucket | `GoogleCloudSettings` (see Google Cloud [example](../../sharding/backup-and-restore/restore.mdx#examples)) | + | `RestoreBackupConfiguration` | Local shard storage | None (see [example](#examples)) | + | `RestoreFromS3Configuration` | AWS S3 Bucket | `S3Settings` (see S3 [example](#examples)) | + | `RestoreFromAzureConfiguration` | MS Azure Blob | `AzureSettings` (see Azure [example](#examples)) | + | `RestoreFromGoogleCloudConfiguration` | Google Cloud Bucket | `GoogleCloudSettings` (see Google Cloud [example](#examples)) | ### `RestoreBackupConfigurationBase` `RestoreBackupConfigurationBase` is a parent class to all the configuration types mentioned above, allowing you to set backups **encryption settings** among other options. @@ -187,7 +187,7 @@ to restore the database. * Instead of `RestoreBackupConfigurationBase`, use the configuration object - you [prepared](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration): + you [prepared](#define-a-restore-configuration): * `RestoreBackupConfiguration` for locally-stored backups * `RestoreFromS3Configuration` to restore from S3 * `RestoreFromAzureConfiguration` to restore from Azure @@ -614,7 +614,7 @@ var operation = await docStore.Maintenance.Server.SendAsync(restoreBackupOperati | Option | Supported on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | | Restore from **local shard storage** | **Yes** | | -| Restore from a [remote location](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Define a [restore configuration](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration) with S3, Azure, or Google Cloud settings. | +| Restore from a [remote location](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Define a [restore configuration](#define-a-restore-configuration) with S3, Azure, or Google Cloud settings. | | Restore a **sharded database** backup
to a **sharded database** | **Yes** | | | Restore a **sharded database** backup
to a **non-sharded database** | **Yes** | | | Restore a **non-sharded database** backup
to a **sharded database** | **No** | A backup created for a non-sharded database CANNOT be restored to a sharded database. | diff --git a/versioned_docs/version-6.2/sharding/configuration.mdx b/versioned_docs/version-6.2/sharding/configuration.mdx index a74065efc8..9af46c56de 100644 --- a/versioned_docs/version-6.2/sharding/configuration.mdx +++ b/versioned_docs/version-6.2/sharding/configuration.mdx @@ -21,10 +21,10 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn how to apply configuration options in [Configuration Overview](../server/configuration/configuration-options.mdx). * In this article: - * [Sharding.Import.CompressionLevel](../sharding/configuration.mdx#shardingimportcompressionlevel) - * [Sharding.OrchestratorTimeoutInMin](../sharding/configuration.mdx#shardingorchestratortimeoutinmin) - * [Sharding.ShardExecutor.UseHttpCompression](../sharding/configuration.mdx#shardingshardexecutorusehttpcompression) - * [Sharding.ShardExecutor.UseHttpDecompression](../sharding/configuration.mdx#shardingshardexecutorusehttpdecompression) + * [Sharding.Import.CompressionLevel](#shardingimportcompressionlevel) + * [Sharding.OrchestratorTimeoutInMin](#shardingorchestratortimeoutinmin) + * [Sharding.ShardExecutor.UseHttpCompression](#shardingshardexecutorusehttpcompression) + * [Sharding.ShardExecutor.UseHttpDecompression](#shardingshardexecutorusehttpdecompression) diff --git a/versioned_docs/version-6.2/sharding/document-extensions.mdx b/versioned_docs/version-6.2/sharding/document-extensions.mdx index 03604a127f..42f3477647 100644 --- a/versioned_docs/version-6.2/sharding/document-extensions.mdx +++ b/versioned_docs/version-6.2/sharding/document-extensions.mdx @@ -33,10 +33,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; along with it to the new shard. * In this page: - * [Document Extensions and Resharding](../sharding/document-extensions.mdx#document-extensions-and-resharding) - * [Precautions and Recommendations](../sharding/document-extensions.mdx#precautions-and-recommendations) - * [Precautions](../sharding/document-extensions.mdx#precautions) - * [Recommendations](../sharding/document-extensions.mdx#recommendations) + * [Document Extensions and Resharding](#document-extensions-and-resharding) + * [Precautions and Recommendations](#precautions-and-recommendations) + * [Precautions](#precautions) + * [Recommendations](#recommendations) ## Document Extensions and Resharding diff --git a/versioned_docs/version-6.2/sharding/etl.mdx b/versioned_docs/version-6.2/sharding/etl.mdx index 6d4c7fa819..a8b252e45d 100644 --- a/versioned_docs/version-6.2/sharding/etl.mdx +++ b/versioned_docs/version-6.2/sharding/etl.mdx @@ -24,17 +24,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; its own local ETL task, based on the user's settings. * Resharding may result in the transfer of some documents more than once to the ETL destination. It is the user's responsibility to - [detect and handle](../sharding/etl.mdx#etl-and-resharding) such duplicates. -* ETL tasks information is available [per database and per shard](../sharding/etl.mdx#retrieving-shard-specific-etl-task-info). + [detect and handle](#etl-and-resharding) such duplicates. +* ETL tasks information is available [per database and per shard](#retrieving-shard-specific-etl-task-info). * In this page: - * [ETL](../sharding/etl.mdx#etl) - * [Sharded and Non-Sharded ETL Tasks](../sharding/etl.mdx#sharded-and-non-sharded-etl-tasks) - * [Non-Sharded Database ETL Tasks](../sharding/etl.mdx#non-sharded-database-etl-tasks) - * [Sharded Database ETL Tasks](../sharding/etl.mdx#sharded-database-etl-tasks) - * [ETL and Resharding](../sharding/etl.mdx#etl-and-resharding) - * [ETL Queries](../sharding/etl.mdx#etl-queries) - * [Retrieving Shard-Specific ETL Task Info](../sharding/etl.mdx#retrieving-shard-specific-etl-task-info) + * [ETL](#etl) + * [Sharded and Non-Sharded ETL Tasks](#sharded-and-non-sharded-etl-tasks) + * [Non-Sharded Database ETL Tasks](#non-sharded-database-etl-tasks) + * [Sharded Database ETL Tasks](#sharded-database-etl-tasks) + * [ETL and Resharding](#etl-and-resharding) + * [ETL Queries](#etl-queries) + * [Retrieving Shard-Specific ETL Task Info](#retrieving-shard-specific-etl-task-info) ## ETL diff --git a/versioned_docs/version-6.2/sharding/external-replication.mdx b/versioned_docs/version-6.2/sharding/external-replication.mdx index 90e8c80962..4263b99870 100644 --- a/versioned_docs/version-6.2/sharding/external-replication.mdx +++ b/versioned_docs/version-6.2/sharding/external-replication.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; their version is at least 6.0. * In this page: - * [Supported Versions](../sharding/external-replication.mdx#supported-versions) - * [External Replication Types](../sharding/external-replication.mdx#external-replication-types) - * [Non-Sharded Database to Sharded Database](../sharding/external-replication.mdx#non-sharded-database-to-sharded-database) - * [Sharded Database to Sharded Database](../sharding/external-replication.mdx#sharded-database-to-sharded-database) - * [Performance Considerations](../sharding/external-replication.mdx#performance-considerations) + * [Supported Versions](#supported-versions) + * [External Replication Types](#external-replication-types) + * [Non-Sharded Database to Sharded Database](#non-sharded-database-to-sharded-database) + * [Sharded Database to Sharded Database](#sharded-database-to-sharded-database) + * [Performance Considerations](#performance-considerations) ## Supported Versions diff --git a/versioned_docs/version-6.2/sharding/import-and-export.mdx b/versioned_docs/version-6.2/sharding/import-and-export.mdx index 07d9b1faa2..467705103f 100644 --- a/versioned_docs/version-6.2/sharding/import-and-export.mdx +++ b/versioned_docs/version-6.2/sharding/import-and-export.mdx @@ -34,9 +34,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Behind the scenes, Studio uses Smuggler to perform these operations. * In this page: - * [Export](../sharding/import-and-export.mdx#export) - * [Import](../sharding/import-and-export.mdx#import) - * [Export and Import Options Summary](../sharding/import-and-export.mdx#export-and-import-options-summary) + * [Export](#export) + * [Import](#import) + * [Export and Import Options Summary](#export-and-import-options-summary) ## Export @@ -67,7 +67,7 @@ and casting it using a non-sharded type [will fail](../migration/client-api/clie ## Import Smuggler can be used to [import](../client-api/smuggler/what-is-smuggler.mdx#import) -data into a database from either a [.ravendbdump](../sharding/import-and-export.mdx#export) +data into a database from either a [.ravendbdump](#export) file or from backup files (full or incremental). When data is imported into a sharded database one of the shard nodes @@ -133,7 +133,7 @@ Import the full backup first, and then the incremental backups that complement i | Option | Available on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | -| Export and Import [.ravendbdump](../sharding/import-and-export.mdx#export) files using [Smuggler](../client-api/smuggler/what-is-smuggler.mdx) | **Yes** | Smuggler behaves just like it does on non-sharded databases. | +| Export and Import [.ravendbdump](#export) files using [Smuggler](../client-api/smuggler/what-is-smuggler.mdx) | **Yes** | Smuggler behaves just like it does on non-sharded databases. | | [Export](../studio/database/tasks/export-database.mdx) and [import](../studio/database/tasks/import-data/import-data-file.mdx) sharded database data using Studio | **Yes** | Behind the scenes, Studio uses Smuggler. | | Export to **client machine** | **Yes** | | | Export to **local shard node storage** | **No** | | diff --git a/versioned_docs/version-6.2/sharding/indexing.mdx b/versioned_docs/version-6.2/sharding/indexing.mdx index 679365dc1a..12fa83f8f6 100644 --- a/versioned_docs/version-6.2/sharding/indexing.mdx +++ b/versioned_docs/version-6.2/sharding/indexing.mdx @@ -22,9 +22,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; Unsupported features are listed below. * In this article: - * [Indexing in a sharded database](../sharding/indexing.mdx#indexing-in-a-sharded-database) - * [Map-Reduce indexes in a sharded database](../sharding/indexing.mdx#map-reduce-indexes-in-a-sharded-database) - * [Unsupported indexing features](../sharding/indexing.mdx#unsupported-indexing-features) + * [Indexing in a sharded database](#indexing-in-a-sharded-database) + * [Map-Reduce indexes in a sharded database](#map-reduce-indexes-in-a-sharded-database) + * [Unsupported indexing features](#unsupported-indexing-features) diff --git a/versioned_docs/version-6.2/sharding/migration.mdx b/versioned_docs/version-6.2/sharding/migration.mdx index 9f25b5d210..e7a0a622dc 100644 --- a/versioned_docs/version-6.2/sharding/migration.mdx +++ b/versioned_docs/version-6.2/sharding/migration.mdx @@ -31,9 +31,9 @@ database to the new one in several ways. of the replica. * In this page: - * [Export & Import](../sharding/migration.mdx#export--import) - * [Backup](../sharding/migration.mdx#backup) - * [External Replication](../sharding/migration.mdx#external-replication) + * [Export & Import](#export--import) + * [Backup](#backup) + * [External Replication](#external-replication) ## Export & Import diff --git a/versioned_docs/version-6.2/sharding/overview.mdx b/versioned_docs/version-6.2/sharding/overview.mdx index 7b95f92ad2..dfe5381ac1 100644 --- a/versioned_docs/version-6.2/sharding/overview.mdx +++ b/versioned_docs/version-6.2/sharding/overview.mdx @@ -24,21 +24,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; (e.g., a 10-terabyte DB). * In this page: - * [Sharding](../sharding/overview.mdx#sharding) - * [Licensing](../sharding/overview.mdx#licensing) - * [Client compatibility](../sharding/overview.mdx#client-compatibility) - * [Client-Server communication](../sharding/overview.mdx#client-server-communication) - * [When should sharding be used?](../sharding/overview.mdx#when-should-sharding-be-used) - * [Shards](../sharding/overview.mdx#shards) - * [Shard replication](../sharding/overview.mdx#shard-replication) - * [How documents are distributed among shards](../sharding/overview.mdx#how-documents-are-distributed-among-shards) - * [Buckets allocation](../sharding/overview.mdx#buckets-allocation) - * [Buckets population](../sharding/overview.mdx#buckets-population) - * [Document extensions storage](../sharding/overview.mdx#document-extensions-storage) - * [Resharding](../sharding/overview.mdx#resharding) - * [Paging](../sharding/overview.mdx#paging) - * [Using local IP addresses](../sharding/overview.mdx#using-local-ip-addresses) - * [Creating a sharded database](../sharding/overview.mdx#creating-a-sharded-database) + * [Sharding](#sharding) + * [Licensing](#licensing) + * [Client compatibility](#client-compatibility) + * [Client-Server communication](#client-server-communication) + * [When should sharding be used?](#when-should-sharding-be-used) + * [Shards](#shards) + * [Shard replication](#shard-replication) + * [How documents are distributed among shards](#how-documents-are-distributed-among-shards) + * [Buckets allocation](#buckets-allocation) + * [Buckets population](#buckets-population) + * [Document extensions storage](#document-extensions-storage) + * [Resharding](#resharding) + * [Paging](#paging) + * [Using local IP addresses](#using-local-ip-addresses) + * [Creating a sharded database](#creating-a-sharded-database) ## Sharding @@ -47,7 +47,7 @@ As a database grows [very large](https://en.wikipedia.org/wiki/Very_large_databa System performance may suffer as resources like RAM, CPU, and storage are exhausted, routine chores like indexing and backup become massive tasks, responsiveness to client requests and queries slows down, and the system's throughput spreads thin serving an ever-growing number of clients. -With sharding, as the volume of stored data grows, the database can be scaled out by splitting it into [shards](../sharding/overview.mdx#shards). +With sharding, as the volume of stored data grows, the database can be scaled out by splitting it into [shards](#shards). This allows the database to be managed by multiple nodes and effectively removes most limits on its growth. In this manner, the size of the overall database, comprised of all shards, can reach dozens of terabytes and more, while keeping the resources of each shard in check and maintaining high performance and throughput. @@ -121,7 +121,7 @@ Take a 3-shard database, in which shard **1** is populated with documents `Users shard **2** contains documents `Users/2001`..`Users/4000`, and shard **3** contains `Users/4001`..`Users/6000`. A client that connects to this database to retrieve `Users/3000` and `Users/5000` would be served by an -automatically-appointed [orchestrator node](../sharding/overview.mdx#client-server-communication) +automatically-appointed [orchestrator node](#client-server-communication) that would seamlessly retrieve `Users/3000` from shard **2** and `Users/5000` from shard **3** and hand them to the client. diff --git a/versioned_docs/version-6.2/sharding/querying.mdx b/versioned_docs/version-6.2/sharding/querying.mdx index e8539dd415..a95b384bda 100644 --- a/versioned_docs/version-6.2/sharding/querying.mdx +++ b/versioned_docs/version-6.2/sharding/querying.mdx @@ -19,23 +19,23 @@ import ContentFrame from "@site/src/components/ContentFrame"; so queries written for a non-sharded database can usually be used without modification. * Some querying features are not yet implemented. - Others, such as [filter](../sharding/querying.mdx#filter), behave a little differently in a sharded database. + Others, such as [filter](#filter), behave a little differently in a sharded database. These cases are described below. * In this article: - * [Querying a sharded database](../sharding/querying.mdx#querying-a-sharded-database) - * [Querying selected shards](../sharding/querying.mdx#querying-selected-shards) - * [Including items in a query](../sharding/querying.mdx#including-items-in-a-query) - * [Paging query results](../sharding/querying.mdx#paging-query-results) - * [Streaming query results](../sharding/querying.mdx#streaming-query-results) - * [Filtering query results](../sharding/querying.mdx#filtering-query-results) - * [`where`](../sharding/querying.mdx#where) - * [`filter`](../sharding/querying.mdx#filter) - * [`where` vs `filter` recommendations](../sharding/querying.mdx#wherevsfilterrecommendations) - * [Loading a document within a projection](../sharding/querying.mdx#loading-a-document-within-a-projection) - * [`order by` and `limit` in a Map-Reduce query](../sharding/querying.mdx#order-by-and-limit-in-a-map-reduce-query) - * [Timing queries](../sharding/querying.mdx#timing-queries) - * [Unsupported querying features](../sharding/querying.mdx#unsupported-querying-features) + * [Querying a sharded database](#querying-a-sharded-database) + * [Querying selected shards](#querying-selected-shards) + * [Including items in a query](#including-items-in-a-query) + * [Paging query results](#paging-query-results) + * [Streaming query results](#streaming-query-results) + * [Filtering query results](#filtering-query-results) + * [`where`](#where) + * [`filter`](#filter) + * [`where` vs `filter` recommendations](#wherevsfilterrecommendations) + * [Loading a document within a projection](#loading-a-document-within-a-projection) + * [`order by` and `limit` in a Map-Reduce query](#order-by-and-limit-in-a-map-reduce-query) + * [Timing queries](#timing-queries) + * [Unsupported querying features](#unsupported-querying-features) @@ -277,7 +277,7 @@ where Name == "Joe" * Although includes are supported in regular sharded queries, they are **not** supported when query results are **streamed**. - Learn more in [Streaming query results](../sharding/querying.mdx#streaming-query-results). + Learn more in [Streaming query results](#streaming-query-results). @@ -519,7 +519,7 @@ Both static index queries and dynamic queries (auto-indexes) are supported. -Data can be filtered using the [where](../sharding/querying.mdx#where) and [filter](../sharding/querying.mdx#filter) keywords on both non-sharded and sharded databases. +Data can be filtered using the [where](#where) and [filter](#filter) keywords on both non-sharded and sharded databases. However, in a sharded database, **when filtering results from a Map-Reduce index query or a dynamic aggregation query**, these commands behave differently. @@ -556,11 +556,11 @@ The server uses it to retrieve only items that match the specified conditions. * Each shard evaluates the `where` condition using only the data stored on that shard. * If a product was sold 4000 times on each shard, the query shown above will filter it out on every shard — even though its total sales across the database far exceed 5000. - * To address this, use the [filter](../sharding/querying.mdx#filter) keyword instead, + * To address this, use the [filter](#filter) keyword instead, whose behavior on sharded databases is designed for exactly this case. * Note: using `where` does **not** cause this problem when filtering on a `GroupBy` field (the reduce-key), and is actually the recommended approach in that case. - Learn more in [`where` vs `filter` recommendations](../sharding/querying.mdx#wherevsfilterrecommendations) below. + Learn more in [`where` vs `filter` recommendations](#wherevsfilterrecommendations) below. @@ -949,13 +949,13 @@ Querying features that are not supported or not yet implemented in sharded datab will throw a `NotSupportedInShardingException`. * **Loading a document within a Map-Reduce projection** - Read more about this topic in [Loading a document within a projection](../sharding/querying.mdx#loading-a-document-within-a-projection) above. + Read more about this topic in [Loading a document within a projection](#loading-a-document-within-a-projection) above. * **Ordering streamed Map-Reduce results by _non-reduce-key_ fields** - Read more about this topic in [Streaming query results](../sharding/querying.mdx#streaming-query-results) above. + Read more about this topic in [Streaming query results](#streaming-query-results) above. * **_Includes_ and _loads_ are not supported in sharded streaming queries** - Read more about this topic in [Streaming query results](../sharding/querying.mdx#streaming-query-results) above. + Read more about this topic in [Streaming query results](#streaming-query-results) above. * **Querying for similar documents with _MoreLikeThis_** [MoreLikeThis](../client-api/session/querying/how-to-use-morelikethis.mdx) is not supported in a sharded database. diff --git a/versioned_docs/version-6.2/sharding/resharding.mdx b/versioned_docs/version-6.2/sharding/resharding.mdx index b36e96b18e..ec7a25e8d8 100644 --- a/versioned_docs/version-6.2/sharding/resharding.mdx +++ b/versioned_docs/version-6.2/sharding/resharding.mdx @@ -29,14 +29,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; at a time, to avoid resource overuse. * In this page: - * [Resharding](../sharding/resharding.mdx#resharding) - * [The Resharding Process](../sharding/resharding.mdx#the-resharding-process) - * [Following Resharding Progress](../sharding/resharding.mdx#following-resharding-progress) - * [Racing](../sharding/resharding.mdx#racing) - * [Change Vector on a Sharded Database](../sharding/resharding.mdx#change-vector-on-a-sharded-database) - * [Resharding and Other Features](../sharding/resharding.mdx#resharding-and-other-features) - * [Executing Resharding](../sharding/resharding.mdx#executing-resharding) - * [Bucket Ownership](../sharding/resharding.mdx#bucket-ownership) + * [Resharding](#resharding) + * [The Resharding Process](#the-resharding-process) + * [Following Resharding Progress](#following-resharding-progress) + * [Racing](#racing) + * [Change Vector on a Sharded Database](#change-vector-on-a-sharded-database) + * [Resharding and Other Features](#resharding-and-other-features) + * [Executing Resharding](#executing-resharding) + * [Bucket Ownership](#bucket-ownership) ## Resharding @@ -82,7 +82,7 @@ using a database like the one shown below: You can follow the progress of the resharding progress using - * **Studio Popup Messages** - When [Studio is used for resharding](../sharding/resharding.mdx#executing-resharding) + When [Studio is used for resharding](#executing-resharding) the user interface produces popup messages to keep users informed of its progress. @@ -177,7 +177,7 @@ related to them, including revisions, time series, attachments, and so on, resharding a large document's bucket may take a considerable amount of time. During this time, checking which shard the bucket belongs to -[may show](../sharding/resharding.mdx#bucket-ownership) +[may show](#bucket-ownership) both the bucket's source and destination shards. However, if documents stored in this bucket are [queried](../sharding/querying.mdx) during this time, RavenDB will add them to the retrieved dataset diff --git a/versioned_docs/version-6.2/sharding/subscriptions.mdx b/versioned_docs/version-6.2/sharding/subscriptions.mdx index 748f072786..1e0d4cc6b8 100644 --- a/versioned_docs/version-6.2/sharding/subscriptions.mdx +++ b/versioned_docs/version-6.2/sharding/subscriptions.mdx @@ -27,8 +27,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; that serve the workers, and shards that serve the orchestrators. * In this page: - * [Data Subscriptions in a Sharded Database](../sharding/subscriptions.mdx#data-subscriptions-in-a-sharded-database) - * [Unsupported Features](../sharding/subscriptions.mdx#unsupported-features) + * [Data Subscriptions in a Sharded Database](#data-subscriptions-in-a-sharded-database) + * [Unsupported Features](#unsupported-features) ## Data Subscriptions in a Sharded Database diff --git a/versioned_docs/version-6.2/sharding/unsupported.mdx b/versioned_docs/version-6.2/sharding/unsupported.mdx index c26023c436..48ab2dc1f4 100644 --- a/versioned_docs/version-6.2/sharding/unsupported.mdx +++ b/versioned_docs/version-6.2/sharding/unsupported.mdx @@ -20,16 +20,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; The list below details these unsupported features. * In this article: - * [Unsupported Indexing Features](../sharding/unsupported.mdx#unsupported-indexing-features) - * [Unsupported Querying Features](../sharding/unsupported.mdx#unsupported-querying-features) - * [Unsupported Document Extensions Features](../sharding/unsupported.mdx#unsupported-document-extensions-features) - * [Unsupported Backup Features](../sharding/unsupported.mdx#unsupported-backup-features) - * [Unsupported Import & Export Features](../sharding/unsupported.mdx#unsupported-import--export-features) - * [Unsupported Migration Features](../sharding/unsupported.mdx#unsupported-migration-features) - * [Unsupported Data Subscription Features](../sharding/unsupported.mdx#unsupported-data-subscription-features) - * [Unsupported Integrations Features](../sharding/unsupported.mdx#unsupported-integrations-features) - * [Unsupported Patching Features](../sharding/unsupported.mdx#unsupported-patching-features) - * [Unsupported Replication Features](../sharding/unsupported.mdx#unsupported-replication-features) + * [Unsupported Indexing Features](#unsupported-indexing-features) + * [Unsupported Querying Features](#unsupported-querying-features) + * [Unsupported Document Extensions Features](#unsupported-document-extensions-features) + * [Unsupported Backup Features](#unsupported-backup-features) + * [Unsupported Import & Export Features](#unsupported-import--export-features) + * [Unsupported Migration Features](#unsupported-migration-features) + * [Unsupported Data Subscription Features](#unsupported-data-subscription-features) + * [Unsupported Integrations Features](#unsupported-integrations-features) + * [Unsupported Patching Features](#unsupported-patching-features) + * [Unsupported Replication Features](#unsupported-replication-features) diff --git a/versioned_docs/version-6.2/start/containers/general-guide.mdx b/versioned_docs/version-6.2/start/containers/general-guide.mdx index 19eb8e4da4..1612aa54cb 100644 --- a/versioned_docs/version-6.2/start/containers/general-guide.mdx +++ b/versioned_docs/version-6.2/start/containers/general-guide.mdx @@ -21,10 +21,10 @@ This guide provides a comprehensive overview of running RavenDB in containers. I ## Contents -1. [Core Concepts & Difficulties](../../start/containers/general-guide.mdx#core-concepts) -2. [What We Offer](../../start/containers/general-guide.mdx#what-we-offer) -3. [What We Require](../../start/containers/general-guide.mdx#what-we-require) -4. [Benefits](../../start/containers/general-guide.mdx#benefits) +1. [Core Concepts & Difficulties](#core-concepts) +2. [What We Offer](#what-we-offer) +3. [What We Require](#what-we-require) +4. [Benefits](#benefits) ## 1. Core concepts #### Containers diff --git a/versioned_docs/version-6.2/start/content/_test-driver-csharp.mdx b/versioned_docs/version-6.2/start/content/_test-driver-csharp.mdx index 9b9df7d0d0..99fbcd8a5b 100644 --- a/versioned_docs/version-6.2/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-6.2/start/content/_test-driver-csharp.mdx @@ -12,20 +12,20 @@ import CodeBlock from '@theme/CodeBlock'; [prerequisites](../../server/embedded.mdx#prerequisite) as embedded servers to run the tests. * In this page: - - [`RavenTestDriver`](../../start/test-driver.mdx#raventestdriver) + - [`RavenTestDriver`](#raventestdriver) - [Pre-initializing the store: `PreInitialize`](../../start/test-driver.mdx#pre-initializing-the-store:-preinitialize) - [Configure the server: `ConfigureServer`](../../start/test-driver.mdx#configure-the-server:-configureserver) - - [Unit test](../../start/test-driver.mdx#unit-test) - - [Complete example](../../start/test-driver.mdx#complete-example) + - [Unit test](#unit-test) + - [Complete example](#complete-example) - [Continuous Integration (CI) Servers](../../start/test-driver.mdx#continuous-integration-(ci)-servers) - - [Licensing](../../start/test-driver.mdx#licensing) + - [Licensing](#licensing) ## `RavenTestDriver` Start by creating a class that derives from `RavenTestDriver`. -Find below a list of test driver methods, followed by [samples](../../start/test-driver.mdx#complete-example). +Find below a list of test driver methods, followed by [samples](#complete-example). ### TestDriver Methods @@ -167,7 +167,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b * `ConfigureServer` can only be set once per test run. It needs to be set before `GetDocumentStore` is called. - See an [example](../../start/test-driver.mdx#complete-example) below. + See an [example](#complete-example) below. * If it is called twice, or within the `DocumentStore` scope, you will get the following error message: `System.InvalidOperationException : Cannot configure server after it was started. Please call 'ConfigureServer' method before any 'GetDocumentStore' is called.` @@ -175,7 +175,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of -how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). +how the embedded server is going to run with just a minor [definition change](#example-2). * To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#serveroptions). * It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. @@ -214,7 +214,7 @@ We use [xunit](https://www.nuget.org/packages/xunit/) for the test framework in Note that the test itself is meant to show different capabilities of the test driver and is not meant to be the most efficient. -The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](../../start/test-driver.mdx#complete-example) +The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](#complete-example) #### Example diff --git a/versioned_docs/version-6.2/start/content/_test-driver-java.mdx b/versioned_docs/version-6.2/start/content/_test-driver-java.mdx index 219f3b636b..482e18c114 100644 --- a/versioned_docs/version-6.2/start/content/_test-driver-java.mdx +++ b/versioned_docs/version-6.2/start/content/_test-driver-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; [prerequisites](../../server/embedded.mdx#prerequisites) as embedded servers to run the tests. * In this page: - - [RavenTestDriver](../../start/test-driver.mdx#raventestdriver) - - [Pre-initializing the store](../../start/test-driver.mdx#preinitialize) - - [ConfigureServer](../../start/test-driver.mdx#configureserver) - - [Unit test](../../start/test-driver.mdx#unittest) - - [Complete example](../../start/test-driver.mdx#complete-example) + - [RavenTestDriver](#raventestdriver) + - [Pre-initializing the store](#preinitialize) + - [ConfigureServer](#configureserver) + - [Unit test](#unittest) + - [Complete example](#complete-example) @@ -36,7 +36,7 @@ First, please make sure that the Raven TestDriver is added to your project depen Then, define a class that derives from the Raven TestDriver. We can start by reviewing TestDriver methods, and then get into implementation -(find a complete Raven TestDriver code sample [below](../../start/test-driver.mdx#complete-example)). +(find a complete Raven TestDriver code sample [below](#complete-example)). ### Methods | Signature | Description | @@ -83,7 +83,7 @@ protected void preInitialize(IDocumentStore documentStore) \{ We'll be using [JUnit](https://junit.org/) for my test framework in the below example. Note that the test itself is meant to show different capabilities of the test driver and is not meant to be the most efficient. -The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](../../start/test-driver.mdx#complete-example) +The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](#complete-example) ### Example diff --git a/versioned_docs/version-6.2/start/getting-started.mdx b/versioned_docs/version-6.2/start/getting-started.mdx index c817ed298a..01882866a5 100644 --- a/versioned_docs/version-6.2/start/getting-started.mdx +++ b/versioned_docs/version-6.2/start/getting-started.mdx @@ -19,17 +19,17 @@ Welcome to RavenDB! * This article will get you started with RavenDB, covering the essentials for a simple setup and basic usage. -* The [Server section](../start/getting-started.mdx#server) covers installation, setup, and configuration of the RavenDB server: - * [Prerequisites](../start/getting-started.mdx#prerequisites) - * [Installation & Setup](../start/getting-started.mdx#installation--setup) - * [Configuration](../start/getting-started.mdx#configuration) - * [Studio](../start/getting-started.mdx#studio) - * [Security Concerns](../start/getting-started.mdx#security-concerns) - -* The [Client section](../start/getting-started.mdx#client) shows how to connect your application to the RavenDB server +* The [Server section](#server) covers installation, setup, and configuration of the RavenDB server: + * [Prerequisites](#prerequisites) + * [Installation & Setup](#installation--setup) + * [Configuration](#configuration) + * [Studio](#studio) + * [Security Concerns](#security-concerns) + +* The [Client section](#client) shows how to connect your application to the RavenDB server and begin working with documents using a client library: - * [DocumentStore](../start/getting-started.mdx#documentstore) - * [Session](../start/getting-started.mdx#session) + * [DocumentStore](#documentstore) + * [Session](#session) @@ -219,7 +219,7 @@ Whenever you run the server folder script `run.ps1` the Studio opens automatical ### Security Concerns **We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start** to prevent potential future vulnerability. -[The process](../start/getting-started.mdx#installation--setup) in RavenDB only takes a few minutes and is free. +[The process](#installation--setup) in RavenDB only takes a few minutes and is free. To let a developer start coding an application quickly, RavenDB will run with the following default security mode: diff --git a/versioned_docs/version-6.2/start/guides/aws-lambda/overview.mdx b/versioned_docs/version-6.2/start/guides/aws-lambda/overview.mdx index c3e16b8ffb..d5a067bb96 100644 --- a/versioned_docs/version-6.2/start/guides/aws-lambda/overview.mdx +++ b/versioned_docs/version-6.2/start/guides/aws-lambda/overview.mdx @@ -21,19 +21,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this guide, you will learn how to deploy a .NET C# Lambda Handler Function using the [RavenDB AWS Lambda C# template][template] that is connected to your RavenDB database. -* Watch our tutorial video [below](../../../start/guides/aws-lambda/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=T2r9sqrTrYE). * In this page: - * [Before We Get Started](../../../start/guides/aws-lambda/overview.mdx#before-we-get-started) - * [Create a Local Lambda Function](../../../start/guides/aws-lambda/overview.mdx#create-a-local-lambda-function) - * [Configuring Local Connection to RavenDB](../../../start/guides/aws-lambda/overview.mdx#configuring-local-connection-to-ravendb) - * [Deploying to AWS](../../../start/guides/aws-lambda/overview.mdx#deploying-to-aws) - * [Configuring Production Connection to RavenDB](../../../start/guides/aws-lambda/overview.mdx#configuring-production-connection-to-ravendb) - * [Verify the Connection Works](../../../start/guides/aws-lambda/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Lambda Function](../../../start/guides/aws-lambda/overview.mdx#using-ravendb-in-the-lambda-function) - * [Next Steps](../../../start/guides/aws-lambda/overview.mdx#next-steps) - * [Tutorial Video](../../../start/guides/aws-lambda/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Lambda Function](#create-a-local-lambda-function) + * [Configuring Local Connection to RavenDB](#configuring-local-connection-to-ravendb) + * [Deploying to AWS](#deploying-to-aws) + * [Configuring Production Connection to RavenDB](#configuring-production-connection-to-ravendb) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Lambda Function](#using-ravendb-in-the-lambda-function) + * [Next Steps](#next-steps) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-csharp.mdx b/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-csharp.mdx index 2260de98e4..3d4e13e915 100644 --- a/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-csharp.mdx +++ b/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; We assume you are familiar with .NET development techniques and the basics of Azure Function apps. * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../../start/guides/azure-functions/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../../start/guides/azure-functions/existing-project.mdx#initializing-the-document-store) - * [Adding Support for App Settings](../../../../start/guides/azure-functions/existing-project.mdx#adding-support-for-app-settings) - * [Configuring Support for Certificates](../../../../start/guides/azure-functions/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Azure](../../../../start/guides/azure-functions/existing-project.mdx#configuring-azure) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Adding Support for App Settings](#adding-support-for-app-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Azure](#configuring-azure) diff --git a/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-nodejs.mdx b/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-nodejs.mdx index 179a73d64c..de8072c188 100644 --- a/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-nodejs.mdx +++ b/versioned_docs/version-6.2/start/guides/azure-functions/content/_existing-project-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; We assume you are familiar with Node.js development techniques and the basics of Azure Function apps. * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../../start/guides/azure-functions/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../../start/guides/azure-functions/existing-project.mdx#initializing-the-document-store) - * [Adding Support for App Settings](../../../../start/guides/azure-functions/existing-project.mdx#adding-support-for-app-settings) - * [Configuring Support for Certificates](../../../../start/guides/azure-functions/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Azure](../../../../start/guides/azure-functions/existing-project.mdx#configuring-azure) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Adding Support for App Settings](#adding-support-for-app-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Azure](#configuring-azure) diff --git a/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-csharp.mdx b/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-csharp.mdx index 683be2d6d8..5b01b1f7eb 100644 --- a/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-csharp.mdx +++ b/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-csharp.mdx @@ -18,18 +18,18 @@ import CodeBlock from '@theme/CodeBlock'; basics of Azure Function apps. -* Watch our tutorial video [below](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=1vnpfsD3bSE&). * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/overview.mdx#before-we-get-started) - * [Create a Local Azure Function App](../../../../start/guides/azure-functions/overview.mdx#create-a-local-azure-function-app) - * [Configuring Local Connection to RavenDB](../../../../start/guides/azure-functions/overview.mdx#configuring-local-connection-to-ravendb) - * [Creating Function App Resources in Azure](../../../../start/guides/azure-functions/overview.mdx#creating-function-app-resources-in-azure) - * [Deploying to Azure](../../../../start/guides/azure-functions/overview.mdx#deploying-to-azure) - * [Verify the Connection Works](../../../../start/guides/azure-functions/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Azure Functions App](../../../../start/guides/azure-functions/overview.mdx#using-ravendb-in-the-azure-functions-app) - * [Tutorial Video](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Azure Function App](#create-a-local-azure-function-app) + * [Configuring Local Connection to RavenDB](#configuring-local-connection-to-ravendb) + * [Creating Function App Resources in Azure](#creating-function-app-resources-in-azure) + * [Deploying to Azure](#deploying-to-azure) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Azure Functions App](#using-ravendb-in-the-azure-functions-app) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-nodejs.mdx b/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-nodejs.mdx index c1604d5040..63c2222eaa 100644 --- a/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-nodejs.mdx +++ b/versioned_docs/version-6.2/start/guides/azure-functions/content/_overview-nodejs.mdx @@ -18,18 +18,18 @@ import CodeBlock from '@theme/CodeBlock'; and the basics of Azure Function apps. -* Watch our tutorial video [below](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=TJdJ3TJK-Sg). * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/overview.mdx#before-we-get-started) - * [Create a Local Azure Function App](../../../../start/guides/azure-functions/overview.mdx#create-a-local-azure-function-app) - * [Connecting to RavenDB](../../../../start/guides/azure-functions/overview.mdx#connecting-to-ravendb) - * [Creating a Function App in Azure](../../../../start/guides/azure-functions/overview.mdx#creating-a-function-app-in-azure) - * [Deploying to Azure](../../../../start/guides/azure-functions/overview.mdx#deploying-to-azure) - * [Verify the Connection Works](../../../../start/guides/azure-functions/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Azure Functions App](../../../../start/guides/azure-functions/overview.mdx#using-ravendb-in-the-azure-functions-app) - * [Tutorial Video](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Azure Function App](#create-a-local-azure-function-app) + * [Connecting to RavenDB](#connecting-to-ravendb) + * [Creating a Function App in Azure](#creating-a-function-app-in-azure) + * [Deploying to Azure](#deploying-to-azure) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Azure Functions App](#using-ravendb-in-the-azure-functions-app) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-6.2/start/guides/azure-functions/deployment.mdx b/versioned_docs/version-6.2/start/guides/azure-functions/deployment.mdx index 4097d8b2ad..0ad8660675 100644 --- a/versioned_docs/version-6.2/start/guides/azure-functions/deployment.mdx +++ b/versioned_docs/version-6.2/start/guides/azure-functions/deployment.mdx @@ -19,7 +19,7 @@ serverless workloads to Microsoft Azure Functions platform. * In this page: * [Linux or Windows?](../../../start/guides/azure-functions/deployment.mdx#linux-or-windows?) - * [Document Store Lifetime and Cold Starts](../../../start/guides/azure-functions/deployment.mdx#document-store-lifetime-and-cold-starts) + * [Document Store Lifetime and Cold Starts](#document-store-lifetime-and-cold-starts) diff --git a/versioned_docs/version-6.2/start/guides/cloudflare-workers/existing-project.mdx b/versioned_docs/version-6.2/start/guides/cloudflare-workers/existing-project.mdx index 8cbef535d8..059eafd118 100644 --- a/versioned_docs/version-6.2/start/guides/cloudflare-workers/existing-project.mdx +++ b/versioned_docs/version-6.2/start/guides/cloudflare-workers/existing-project.mdx @@ -27,12 +27,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; We assume you are familiar with Node.js development techniques and the basics of Cloudflare Workers. * In this page: - * [Before We Get Started](../../../start/guides/cloudflare-workers/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../start/guides/cloudflare-workers/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../start/guides/cloudflare-workers/existing-project.mdx#initializing-the-document-store) - * [Updating Database Connection Settings](../../../start/guides/cloudflare-workers/existing-project.mdx#updating-database-connection-settings) - * [Configuring Support for Certificates](../../../start/guides/cloudflare-workers/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Cloudflare](../../../start/guides/cloudflare-workers/existing-project.mdx#configuring-cloudflare) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Updating Database Connection Settings](#updating-database-connection-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Cloudflare](#configuring-cloudflare) diff --git a/versioned_docs/version-6.2/start/guides/cloudflare-workers/overview.mdx b/versioned_docs/version-6.2/start/guides/cloudflare-workers/overview.mdx index 2f991a7b75..d92958b60f 100644 --- a/versioned_docs/version-6.2/start/guides/cloudflare-workers/overview.mdx +++ b/versioned_docs/version-6.2/start/guides/cloudflare-workers/overview.mdx @@ -25,17 +25,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; This guide assumes you are familiar with Node.js development techniques and the basics of Cloudflare Workers. -* Watch our tutorial video [below](../../../start/guides/cloudflare-workers/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=qMJfgQicjwk&t=1s). * In this page: - * [Before We Get Started](../../../start/guides/cloudflare-workers/overview.mdx#before-we-get-started) - * [Create a Cloudflare RavenDB Worker project](../../../start/guides/cloudflare-workers/overview.mdx#create-a-cloudflare-ravendb-worker-project) - * [Updating Database Connection Settings](../../../start/guides/cloudflare-workers/overview.mdx#updating-database-connection-settings) - * [Connecting to an Authenticated RavenDB Cluster](../../../start/guides/cloudflare-workers/overview.mdx#connecting-to-an-authenticated-ravendb-cluster) - * [Deploying to Production](../../../start/guides/cloudflare-workers/overview.mdx#deploying-to-production) - * [Using RavenDB in the Worker](../../../start/guides/cloudflare-workers/overview.mdx#using-ravendb-in-the-worker) - * [Tutorial Video](../../../start/guides/cloudflare-workers/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Cloudflare RavenDB Worker project](#create-a-cloudflare-ravendb-worker-project) + * [Updating Database Connection Settings](#updating-database-connection-settings) + * [Connecting to an Authenticated RavenDB Cluster](#connecting-to-an-authenticated-ravendb-cluster) + * [Deploying to Production](#deploying-to-production) + * [Using RavenDB in the Worker](#using-ravendb-in-the-worker) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-6.2/start/installation/deployment-considerations.mdx b/versioned_docs/version-6.2/start/installation/deployment-considerations.mdx index f2e956e459..fc04048986 100644 --- a/versioned_docs/version-6.2/start/installation/deployment-considerations.mdx +++ b/versioned_docs/version-6.2/start/installation/deployment-considerations.mdx @@ -15,12 +15,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Deployment Considerations](../../start/installation/deployment-considerations.mdx#deployment-considerations) - * [Performance Considerations](../../start/installation/deployment-considerations.mdx#performance-considerations) - * [Storage Considerations](../../start/installation/deployment-considerations.mdx#storage-considerations) - * [Network Considerations](../../start/installation/deployment-considerations.mdx#network-considerations) - * [Running RavenDB](../../start/installation/deployment-considerations.mdx#running-ravendb) - * [When the Database Grows Bigger](../../start/installation/deployment-considerations.mdx#when-the-database-grows-bigger) + * [Deployment Considerations](#deployment-considerations) + * [Performance Considerations](#performance-considerations) + * [Storage Considerations](#storage-considerations) + * [Network Considerations](#network-considerations) + * [Running RavenDB](#running-ravendb) + * [When the Database Grows Bigger](#when-the-database-grows-bigger) diff --git a/versioned_docs/version-6.2/start/installation/gnu-linux/deb.mdx b/versioned_docs/version-6.2/start/installation/gnu-linux/deb.mdx index cdabbefd92..d96d2a43cd 100644 --- a/versioned_docs/version-6.2/start/installation/gnu-linux/deb.mdx +++ b/versioned_docs/version-6.2/start/installation/gnu-linux/deb.mdx @@ -24,18 +24,18 @@ import LanguageContent from "@site/src/components/LanguageContent"; a browser and complete the setup process using our setup wizard. * In this page: - * [Downloading and Installing RavenDB](../../../start/installation/gnu-linux/deb.mdx#downloading-and-installing-ravendb) - * [1. Download DEB Package](../../../start/installation/gnu-linux/deb.mdx#download-deb-package) - * [2. Install RavenDB](../../../start/installation/gnu-linux/deb.mdx#install-ravendb) - * [3. Complete the setup](../../../start/installation/gnu-linux/deb.mdx#complete-the-setup) - * [4. Entering RavenDB Studio When Setup is Complete](../../../start/installation/gnu-linux/deb.mdx#entering-ravendb-studio-when-setup-is-complete) - * [Upgrading RavenDB](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb) - * [Removing RavenDB](../../../start/installation/gnu-linux/deb.mdx#removing-ravendb) - * [Remove RavenDB and Leave its Data and Settings Intact](../../../start/installation/gnu-linux/deb.mdx#remove-ravendb-and-leave-its-data-and-settings-intact) - * [Remove RavenDB Completely](../../../start/installation/gnu-linux/deb.mdx#remove-ravendb-completely) - * [File System Locations](../../../start/installation/gnu-linux/deb.mdx#file-system-locations) - * [Default Settings](../../../start/installation/gnu-linux/deb.mdx#default-settings) - * [RavenDB Service Definitions](../../../start/installation/gnu-linux/deb.mdx#ravendb-service-definitions) + * [Downloading and Installing RavenDB](#downloading-and-installing-ravendb) + * [1. Download DEB Package](#download-deb-package) + * [2. Install RavenDB](#install-ravendb) + * [3. Complete the setup](#complete-the-setup) + * [4. Entering RavenDB Studio When Setup is Complete](#entering-ravendb-studio-when-setup-is-complete) + * [Upgrading RavenDB](#upgrading-ravendb) + * [Removing RavenDB](#removing-ravendb) + * [Remove RavenDB and Leave its Data and Settings Intact](#remove-ravendb-and-leave-its-data-and-settings-intact) + * [Remove RavenDB Completely](#remove-ravendb-completely) + * [File System Locations](#file-system-locations) + * [Default Settings](#default-settings) + * [RavenDB Service Definitions](#ravendb-service-definitions) ## Downloading and Installing RavenDB @@ -59,7 +59,7 @@ Find it here: [https://ravendb.net/download](https://ravendb.net/download) The same command, `sudo apt install `, is also used to - [Upgrade RavenDB](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb). + [Upgrade RavenDB](#upgrading-ravendb). * The RavenDB service will be created and activated automatically. @@ -165,7 +165,7 @@ To remove RavenDB and **leave its settings and data intact**, use: `sudo apt-get !["Leave Data and Settings Intact"](./assets/sudo_apt-get_remove_ravendb.png) -[Reinstalling](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb) +[Reinstalling](#upgrading-ravendb) RavenDB after removing it this way will **restore** its data and settings. ### Remove RavenDB Completely diff --git a/versioned_docs/version-6.2/start/installation/manual.mdx b/versioned_docs/version-6.2/start/installation/manual.mdx index 02ce4bce90..3cc5e01aa7 100644 --- a/versioned_docs/version-6.2/start/installation/manual.mdx +++ b/versioned_docs/version-6.2/start/installation/manual.mdx @@ -24,11 +24,11 @@ If you choose manual setup and/or to provide your own certificate, **you are res In this page: -* [Downloading Server and Setting Up Node Folders](../../start/installation/manual.mdx#downloading-server-and-setting-up-node-folders) -* [Disabling 'Setup Wizard'](../../start/installation/manual.mdx#disabling-setup-wizard) -* [Server Url and Port](../../start/installation/manual.mdx#server-url-and-port) -* [Security](../../start/installation/manual.mdx#security) -* [Configuration](../../start/installation/manual.mdx#configuration) +* [Downloading Server and Setting Up Node Folders](#downloading-server-and-setting-up-node-folders) +* [Disabling 'Setup Wizard'](#disabling-setup-wizard) +* [Server Url and Port](#server-url-and-port) +* [Security](#security) +* [Configuration](#configuration) ## Downloading Server and Setting Up Node Folders Download the [RavenDB server package](https://ravendb.net/download) and extract it into permanent server folders on each machine. diff --git a/versioned_docs/version-6.2/start/installation/running-as-service.mdx b/versioned_docs/version-6.2/start/installation/running-as-service.mdx index 4f4364de7b..47b34323f5 100644 --- a/versioned_docs/version-6.2/start/installation/running-as-service.mdx +++ b/versioned_docs/version-6.2/start/installation/running-as-service.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Windows](../../start/installation/running-as-service.mdx#windows) - * [Registering](../../start/installation/running-as-service.mdx#registering) - * [Unregistering](../../start/installation/running-as-service.mdx#unregistering) - * [Starting and Stopping](../../start/installation/running-as-service.mdx#starting-and-stopping) -* [Linux - Ubuntu](../../start/installation/running-as-service.mdx#linux---ubuntu) +* [Windows](#windows) + * [Registering](#registering) + * [Unregistering](#unregistering) + * [Starting and Stopping](#starting-and-stopping) +* [Linux - Ubuntu](#linux---ubuntu) diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/additional-settings.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/additional-settings.mdx index 7b2a854487..cdb3441bad 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/additional-settings.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/additional-settings.mdx @@ -19,8 +19,8 @@ import Panel from '@site/src/components/Panel'; the next step is to **customize optional settings**. * In this article: - * [Additional settings](../../../start/installation/setup-wizard/additional-settings.mdx#additional-settings) - * [Configure advanced options](../../../start/installation/setup-wizard/additional-settings.mdx#configure-advanced-options) + * [Additional settings](#additional-settings) + * [Configure advanced options](#configure-advanced-options) @@ -61,7 +61,7 @@ import Panel from '@site/src/components/Panel'; 4. **Configure advanced options**: Toggle this option on to expand the section. - Learn more below in [Configure advanced options](../../../start/installation/setup-wizard/additional-settings.mdx#configure-advanced-options). + Learn more below in [Configure advanced options](#configure-advanced-options). 5. Click **"Continue"** to proceed to the next step: [Review setup](../../../start/installation/setup-wizard/review-setup.mdx). diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/choose-security-option.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/choose-security-option.mdx index a163f6e447..a3f16fc9aa 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/choose-security-option.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/choose-security-option.mdx @@ -34,10 +34,10 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Choose a security method](../../../start/installation/setup-wizard/choose-security-option.mdx#choose-a-security-method) - * [Generate Let's Encrypt certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#generate-let-s-encrypt-certificate) - * [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate) - * [Don't use certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#don-t-use-certificate) + * [Choose a security method](#choose-a-security-method) + * [Generate Let's Encrypt certificate](#generate-let-s-encrypt-certificate) + * [Provide your own certificate](#provide-your-own-certificate) + * [Don't use certificate](#don-t-use-certificate) @@ -47,9 +47,9 @@ In this step, choose one of three security options: ![Select how to secure](./assets/security-1.png) -1. [Generate Let's Encrypt certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#generate-let-s-encrypt-certificate) -2. [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate) -3. [Don't use certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#don-t-use-certificate) +1. [Generate Let's Encrypt certificate](#generate-let-s-encrypt-certificate) +2. [Provide your own certificate](#provide-your-own-certificate) +3. [Don't use certificate](#don-t-use-certificate) 4. After selecting a security method, click **"Continue"** to proceed with its setup steps. 5. Click **"Back"** to return to the previous step - [Provide license key](../../../start/installation/setup-wizard/provide-license-key.mdx). @@ -61,7 +61,7 @@ Use this option to secure your server with a [Let's Encrypt certificate](../../. Let’s Encrypt is a free, automated certificate authority that provides trusted SSL/TLS certificates for HTTPS communication. To make this process as seamless as possible, **RavenDB provides a free domain name** for your cluster. -RavenDB will automatically issue and renew a trusted HTTPS certificate for the [domain you define in the next step](../../../start/installation/setup-wizard/choose-security-option.mdx#enter-a-domain-name), +RavenDB will automatically issue and renew a trusted HTTPS certificate for the [domain you define in the next step](#enter-a-domain-name), fully managing the certificate lifecycle so you don't need to provide or maintain your own. **When to use this option**: @@ -144,7 +144,7 @@ we recommend using your own certificates and domains, avoiding reliance on a thi * **Using your own domain** The free subdomain is provided only for the purpose of proving ownership to Let's Encrypt. If you prefer to use your own domain, you are welcome to acquire your own certificate and use it instead. - See [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate). + See [Provide your own certificate](#provide-your-own-certificate). diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/choose-setup-method.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/choose-setup-method.mdx index 45f4fbde18..2afe3b8b3c 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/choose-setup-method.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/choose-setup-method.mdx @@ -19,10 +19,10 @@ import Panel from '@site/src/components/Panel'; the next step is to choose the **setup method** you want to proceed with. * In this article: - * [Available setup methods](../../../start/installation/setup-wizard/choose-setup-method.mdx#available-setup-methods) - * [Set up a new cluster](../../../start/installation/setup-wizard/choose-setup-method.mdx#set-up-a-new-cluster) - * [Create a package for external setup](../../../start/installation/setup-wizard/choose-setup-method.mdx#create-a-package-for-external-setup) - * [Use an existing setup package](../../../start/installation/setup-wizard/choose-setup-method.mdx#use-an-existing-setup-package) + * [Available setup methods](#available-setup-methods) + * [Set up a new cluster](#set-up-a-new-cluster) + * [Create a package for external setup](#create-a-package-for-external-setup) + * [Use an existing setup package](#use-an-existing-setup-package) @@ -35,15 +35,15 @@ The following setup methods are available: 1. **Set up a new cluster** Configure a new cluster (single-node or multi-node) and start the **first RavenDB instance** on the machine where the Setup Wizard is running. - Learn more below in [Set up a new cluster](../../../start/installation/setup-wizard/choose-setup-method.mdx#set-up-a-new-cluster). + Learn more below in [Set up a new cluster](#set-up-a-new-cluster). 2. **Create a package for external setup** Prepare a configuration package without starting a server locally. - Learn more below in [Create a package for external setup](../../../start/installation/setup-wizard/choose-setup-method.mdx#create-a-package-for-external-setup). + Learn more below in [Create a package for external setup](#create-a-package-for-external-setup). 3. **Use an existing setup package** Apply a previously generated setup package to join a node to a cluster. - Learn more below in [Use an existing setup package](../../../start/installation/setup-wizard/choose-setup-method.mdx#use-an-existing-setup-package). + Learn more below in [Use an existing setup package](#use-an-existing-setup-package). 4. Click **"Continue"** to proceed to the next step in the wizard, which is [Providing the license key](../../../start/installation/setup-wizard/provide-license-key.mdx). diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/configure-node-addresses.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/configure-node-addresses.mdx index 494521db36..653d86867c 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/configure-node-addresses.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/configure-node-addresses.mdx @@ -30,13 +30,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Set up node addresses for a SECURE cluster](../../../start/installation/setup-wizard/configure-node-addresses.mdx#set-up-node-addresses-for-a-secure-cluster) + * [Set up node addresses for a SECURE cluster](#set-up-node-addresses-for-a-secure-cluster) * [Behind a firewall or load balancer](../../../start/installation/setup-wizard/configure-node-addresses#behind-a-firewall-or-load-balancer) * [In a Docker container](../../../start/installation/setup-wizard/configure-node-addresses#in-a-docker-container) - * [Set up node addresses for an UNSECURED cluster](../../../start/installation/setup-wizard/configure-node-addresses.mdx#set-up-node-addresses-for-an-unsecured-cluster) - * [Cluster topology](../../../start/installation/setup-wizard/configure-node-addresses.mdx#cluster-topology) - * [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes) - * [Node layout](../../..//start/installation/setup-wizard/configure-node-addresses.mdx#node-layout) + * [Set up node addresses for an UNSECURED cluster](#set-up-node-addresses-for-an-unsecured-cluster) + * [Cluster topology](#cluster-topology) + * [Number of nodes](#number-of-nodes) + * [Node layout](#node-layout) @@ -103,7 +103,7 @@ import Panel from '@site/src/components/Panel'; Nodes can use the same HTTPS/TCP ports as long as they listen on different IP addresses or hostnames. You can add nodes up to the limit allowed by your license. For production, it is recommended to start with at least 3 nodes. - Learn more in [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes). + Learn more in [Number of nodes](#number-of-nodes). 11. **Save**: When you finish configuring this node, click this button to save its settings. @@ -203,7 +203,7 @@ The following example shows a configuration of a 3-node cluster: Nodes can use the same HTTP/TCP ports as long as they listen on different IP addresses or hostnames. You can add nodes up to the limit allowed by your license. For production, it is recommended to start with at least 3 nodes. - Learn more in [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes). + Learn more in [Number of nodes](#number-of-nodes). 8. Click **"Continue"** to proceed to the next step - [Additional settings](../../../start/installation/setup-wizard/additional-settings.mdx). The "Continue" button is enabled after you click "Save". 9. Click **"Back"** to return to the previous step - [Choosing a security option](../../../start/installation/setup-wizard/choose-security-option.mdx). diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/finish-setup.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/finish-setup.mdx index 901b3dcdfb..379f7d621c 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/finish-setup.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/finish-setup.mdx @@ -19,11 +19,11 @@ import Panel from '@site/src/components/Panel'; the wizard applies your configuration and either prepares the server for its first run or generates a setup package, depending on the flow you chose in earlier steps. * In this article: - * [Configuration in process](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-in-process) - * [Configuration is done](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-is-done) - * [The downloaded ZIP file](../../../start/installation/setup-wizard/finish-setup.mdx#the-downloaded-zip-file) - * [The "All Set!" screen](../../../start/installation/setup-wizard/finish-setup.mdx#the-all-set-screen) - * [Restarting the server](../../../start/installation/setup-wizard/finish-setup.mdx#restarting-the-server) + * [Configuration in process](#configuration-in-process) + * [Configuration is done](#configuration-is-done) + * [The downloaded ZIP file](#the-downloaded-zip-file) + * [The "All Set!" screen](#the-all-set-screen) + * [Restarting the server](#restarting-the-server) @@ -88,7 +88,7 @@ and [Chosen security method](../../../start/installation/setup-wizard/choose-sec **What happens next?** If all operations complete successfully, the wizard will automatically update the screen. -See the [Configuration is done](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-is-done) section below. +See the [Configuration is done](#configuration-is-done) section below. If an error occurs, the process will halt. The detailed configuration log will help you identify what went wrong. @@ -175,7 +175,7 @@ For example, when configuring a **multi-node secure cluster**, you will see the 3. **Restart server**: This button is now enabled. Click to apply the settings and restart the server on Node A. Once restarted, your browser will automatically open RavenDB Studio for this node. - Learn more in [Restarting the server](../../../start/installation/setup-wizard/finish-setup.mdx#restarting-the-server) below. + Learn more in [Restarting the server](#restarting-the-server) below. diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/overview.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/overview.mdx index 9b737d2628..8f3f770a7d 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/overview.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/overview.mdx @@ -21,10 +21,10 @@ import Panel from '@site/src/components/Panel'; * If you prefer to configure RavenDB manually, see: [Manual setup](../../../start/installation/manual.mdx). * In this article: - * [How to run the Setup Wizard](../../../start/installation/setup-wizard/overview.mdx#how-to-run-the-setup-wizard) - * [License agreement (EULA)](../../../start/installation/setup-wizard/overview.mdx#license-agreement-eula) - * [Guided setup flow](../../../start/installation/setup-wizard/overview.mdx#guided-setup-flow) - * [RavenDB settings files](../../../start/installation/setup-wizard/overview.mdx#ravendb-settings-files) + * [How to run the Setup Wizard](#how-to-run-the-setup-wizard) + * [License agreement (EULA)](#license-agreement-eula) + * [Guided setup flow](#guided-setup-flow) + * [RavenDB settings files](#ravendb-settings-files) diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/provide-license-key.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/provide-license-key.mdx index ea94bea09b..3fd9b8a9a8 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/provide-license-key.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/provide-license-key.mdx @@ -27,8 +27,8 @@ import Panel from '@site/src/components/Panel'; Learn more about licensing in [Licensing overview](../../../start/licensing/licensing-overview.mdx). * In this article: - * [Enter license key](../../../start/installation/setup-wizard/provide-license-key.mdx#enter-license-key) - * [Get a free license](../../../start/installation/setup-wizard/provide-license-key.mdx#get-a-free-license) + * [Enter license key](#enter-license-key) + * [Get a free license](#get-a-free-license) * [Running RavenDB without a license](../../../start/installation/setup-wizard/provide-license-key#running-ravendb-without-a-license) @@ -40,7 +40,7 @@ import Panel from '@site/src/components/Panel'; 1. Enter your license key, which was sent to the email address you provided when obtaining it. 2. If you do not have a license, select this option to obtain a free Developer or Community license. - Learn more below in [Get your free license](../../../start/installation/setup-wizard/provide-license-key.mdx#get-your-free-license). + Learn more below in [Get your free license](#get-your-free-license). 3. Click **"Continue"** to proceed to the next step in the wizard - [Choosing a security option](../../../start/installation/setup-wizard/choose-security-option.mdx). diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/review-setup.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/review-setup.mdx index fa067e6442..0ee102b20d 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/review-setup.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/review-setup.mdx @@ -19,7 +19,7 @@ import Panel from '@site/src/components/Panel'; the next step is to **review all your settings before proceeding**. * In this article: - * [Review setup](../../../start/installation/setup-wizard/review-setup.mdx#review-setup) + * [Review setup](#review-setup) diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard/use-setup-package.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard/use-setup-package.mdx index e0a42b7acf..32216463e6 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard/use-setup-package.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard/use-setup-package.mdx @@ -19,8 +19,8 @@ import Panel from '@site/src/components/Panel'; It allows you to initialize a RavenDB instance using a configuration ZIP file generated in a previous session. * In this article: - * [When to use](../../../start/installation/setup-wizard/use-setup-package.mdx#when-to-use) - * [Using an existing setup package](../../../start/installation/setup-wizard/use-setup-package.mdx#using-an-existing-setup-package) + * [When to use](#when-to-use) + * [Using an existing setup package](#using-an-existing-setup-package) diff --git a/versioned_docs/version-6.2/start/licensing/activate-license.mdx b/versioned_docs/version-6.2/start/licensing/activate-license.mdx index adbf87b1f7..5f722d2244 100644 --- a/versioned_docs/version-6.2/start/licensing/activate-license.mdx +++ b/versioned_docs/version-6.2/start/licensing/activate-license.mdx @@ -21,8 +21,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: - * [Activate license with configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys) - * [Activate license from the Studio](../../start/licensing/activate-license.mdx#activate-license-from-the-studio) + * [Activate license with configuration keys](#activate-license-with-configuration-keys) + * [Activate license from the Studio](#activate-license-from-the-studio) ## Activate license with configuration keys diff --git a/versioned_docs/version-6.2/start/licensing/force-update.mdx b/versioned_docs/version-6.2/start/licensing/force-update.mdx index 555c0df5ed..52f2bfb198 100644 --- a/versioned_docs/version-6.2/start/licensing/force-update.mdx +++ b/versioned_docs/version-6.2/start/licensing/force-update.mdx @@ -27,7 +27,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; This action also requires an active connection to the [License Server](../../start/licensing/licensing-overview.mdx#license-server). * In this page: - * [Force license update from Studio](../../start/licensing/force-update.mdx#force-license-update-from-studio) + * [Force license update from Studio](#force-license-update-from-studio) ## Force license update from Studio diff --git a/versioned_docs/version-6.2/start/licensing/license-under-docker.mdx b/versioned_docs/version-6.2/start/licensing/license-under-docker.mdx index 244d27be2e..d05a534631 100644 --- a/versioned_docs/version-6.2/start/licensing/license-under-docker.mdx +++ b/versioned_docs/version-6.2/start/licensing/license-under-docker.mdx @@ -23,12 +23,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A `RAVEN_License` environment variable can be set. * In this page: - * [Prerequisites](../../start/licensing/license-under-docker.mdx#prerequisites) - * [Licensing a RavenDB docker image](../../start/licensing/license-under-docker.mdx#licensing-a-ravendb-docker-image) - * [Passing a Path to the License File via CLI](../../start/licensing/license-under-docker.mdx#passing-a-path-to-the-license-file-via-cli) - * [Providing a License in `settings.json`](../../start/licensing/license-under-docker.mdx#providing-a-license-in-) - * [Setting a `RAVEN_License` Environment Variable](../../start/licensing/license-under-docker.mdx#setting-a--environment-variable) - * [Licensing RavenDB under Linux](../../start/licensing/license-under-docker.mdx#licensing-ravendb-under-linux) + * [Prerequisites](#prerequisites) + * [Licensing a RavenDB docker image](#licensing-a-ravendb-docker-image) + * [Passing a Path to the License File via CLI](#passing-a-path-to-the-license-file-via-cli) + * [Providing a License in `settings.json`](#providing-a-license-in-) + * [Setting a `RAVEN_License` Environment Variable](#setting-a--environment-variable) + * [Licensing RavenDB under Linux](#licensing-ravendb-under-linux) ## Prerequisites @@ -85,7 +85,7 @@ Provide the license as a property of the `settings.json` configuration file in o * Add `settings.json` the **full license string** as the value of the "License" key [as explained here](../../server/configuration/license-configuration.mdx). - Mount `settings.json` as [explained above](../../start/licensing/license-under-docker.mdx#passing-a-path-to-the-license-file-via-cli), + Mount `settings.json` as [explained above](#passing-a-path-to-the-license-file-via-cli), using the location of `settings.json` instead of the location of a license file. * Alternatively, add `settings.json` the **license path** as the value of the “License.Path” key and mount the license directory. diff --git a/versioned_docs/version-6.2/start/licensing/licensing-overview.mdx b/versioned_docs/version-6.2/start/licensing/licensing-overview.mdx index afe4216e31..bea73e1535 100644 --- a/versioned_docs/version-6.2/start/licensing/licensing-overview.mdx +++ b/versioned_docs/version-6.2/start/licensing/licensing-overview.mdx @@ -27,14 +27,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; To renew your license see [renew license](../../start/licensing/renew-license.mdx). * In this page: - * [License types](../../start/licensing/licensing-overview.mdx#license-types) - * [Developer](../../start/licensing/licensing-overview.mdx#developer) - * [Community](../../start/licensing/licensing-overview.mdx#community) - * [Professional](../../start/licensing/licensing-overview.mdx#professional) - * [Enterprise](../../start/licensing/licensing-overview.mdx#enterprise) - * [ISV Licenses](../../start/licensing/licensing-overview.mdx#isv-licenses) - * [ISV Bank-of-Cores License](../../start/licensing/licensing-overview.mdx#isv-bank-of-cores-license) - * [Manage license view](../../start/licensing/licensing-overview.mdx#manage-license-view) + * [License types](#license-types) + * [Developer](#developer) + * [Community](#community) + * [Professional](#professional) + * [Enterprise](#enterprise) + * [ISV Licenses](#isv-licenses) + * [ISV Bank-of-Cores License](#isv-bank-of-cores-license) + * [Manage license view](#manage-license-view) ## License types diff --git a/versioned_docs/version-6.2/start/licensing/renew-license.mdx b/versioned_docs/version-6.2/start/licensing/renew-license.mdx index 829c2c94b8..6c69ed4c1b 100644 --- a/versioned_docs/version-6.2/start/licensing/renew-license.mdx +++ b/versioned_docs/version-6.2/start/licensing/renew-license.mdx @@ -22,8 +22,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Renew your license** as described below. * In this page: - * [Renew commercial licenses](../../start/licensing/renew-license.mdx#renew-commercial-licenses) - * [Renew Developer & Community licenses](../../start/licensing/renew-license.mdx#renew-developer--community-licenses) + * [Renew commercial licenses](#renew-commercial-licenses) + * [Renew Developer & Community licenses](#renew-developer--community-licenses) ## Renew commercial licenses diff --git a/versioned_docs/version-6.2/start/licensing/replace-license.mdx b/versioned_docs/version-6.2/start/licensing/replace-license.mdx index 5e4e6f4a32..672fe477b5 100644 --- a/versioned_docs/version-6.2/start/licensing/replace-license.mdx +++ b/versioned_docs/version-6.2/start/licensing/replace-license.mdx @@ -21,12 +21,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * If you upgrade to RavenDB 6.0, you need to upgrade your current license key before applying it to the new version. Use our online license upgrade tool - as explained [below](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) + as explained [below](#upgrade-a-license-key-for-ravendb-6x) to upgrade your key. * In this page: - * [Replace license from Studio](../../start/licensing/replace-license.mdx#replace-license-from-studio) - * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) + * [Replace license from Studio](#replace-license-from-studio) + * [Upgrade a License Key For RavenDB 6.x](#upgrade-a-license-key-for-ravendb-6x) ## Replace license from Studio @@ -54,7 +54,7 @@ using our online [License upgrade tool](https://ravendb.net/l/8O2YU1). ![Replace License Tool](./assets/replace-license_replace-license-tool.png) A new key will be sent to the email address you registered your current license with. -[Replace](../../start/licensing/replace-license.mdx#replace-license-from-studio) your current key with the new one. +[Replace](#replace-license-from-studio) your current key with the new one. diff --git a/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx b/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx index ccae758f2d..e1b4757376 100644 --- a/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx +++ b/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx @@ -22,10 +22,10 @@ Customize the cluster dashboard according to your needs by: * **Repositioning** widgets * In this page: - * [Remove Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#remove-widget) - * [Add Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#add-widget) - * [Resize Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#resize-widget) - * [Reposition Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#reposition-widget) + * [Remove Widget](#remove-widget) + * [Add Widget](#add-widget) + * [Resize Widget](#resize-widget) + * [Reposition Widget](#reposition-widget) ## Remove Widget @@ -38,7 +38,7 @@ To remove a widget from the cluster dashboard - Removing a widget is **reversible**. - To return a widget that's been removed, [Add it](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#add-widget) + To return a widget that's been removed, [Add it](#add-widget) to the cluster dashboard. diff --git a/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx b/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx index 8b91d491ef..8ca0f63cb8 100644 --- a/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx +++ b/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The cluster dashboard can be freely rearranged by adding, removing, relocating, and resizing widgets. * In this page: - * [Initial Display](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#cluster-dashboard-initial-display) - * [Widgets Display](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#cluster-dashboard-widgets-display) - * [Setup changes](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#setup-changes) + * [Initial Display](#cluster-dashboard-initial-display) + * [Widgets Display](#cluster-dashboard-widgets-display) + * [Setup changes](#setup-changes) ## Cluster Dashboard Initial Display diff --git a/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx b/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx index abca1b680a..67c3d0dd3b 100644 --- a/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx +++ b/versioned_docs/version-6.2/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx @@ -18,16 +18,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Information is displayed for all cluster nodes. * Available Widgets: - * [Let's Get Started Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#let) - * [CPU Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#cpu-widget) - * [Memory Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#memory-widget) - * [Traffic Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#traffic-widget) - * [Traffic Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#traffic-per-database-widget) - * [Indexing Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#indexing-widget) - * [Indexing Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#indexing-per-database-widget) - * [Storage Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#storage-widget) - * [Storage Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#storage-per-database-widget) - * [License Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#license-widget) + * [Let's Get Started Widget](#let) + * [CPU Widget](#cpu-widget) + * [Memory Widget](#memory-widget) + * [Traffic Widget](#traffic-widget) + * [Traffic Per Database Widget](#traffic-per-database-widget) + * [Indexing Widget](#indexing-widget) + * [Indexing Per Database Widget](#indexing-per-database-widget) + * [Storage Widget](#storage-widget) + * [Storage Per Database Widget](#storage-per-database-widget) + * [License Widget](#license-widget) ## Let's Get Started Widget diff --git a/versioned_docs/version-6.2/studio/cluster/cluster-view.mdx b/versioned_docs/version-6.2/studio/cluster/cluster-view.mdx index 15403c21c2..2567e9cb2b 100644 --- a/versioned_docs/version-6.2/studio/cluster/cluster-view.mdx +++ b/versioned_docs/version-6.2/studio/cluster/cluster-view.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; working to achieve the same goal. * Using the Raft consensus protocol, the cluster distributes work among the various nodes, handles failures, recovery, and more. - The cluster Member nodes elect a [Leader](../../studio/cluster/cluster-view.mdx#cluster-nodes-types) - a node that manages the cluster state. + The cluster Member nodes elect a [Leader](#cluster-nodes-types) - a node that manages the cluster state. * This view shows your cluster's current state and structure. @@ -29,12 +29,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * And much more * In this page: - * [Cluster View Stats](../../studio/cluster/cluster-view.mdx#cluster-view-stats) - * [Cluster View Operations](../../studio/cluster/cluster-view.mdx#cluster-view-operations) - * [Reassign Cores](../../studio/cluster/cluster-view.mdx#reassign-cores) - * [Cluster Nodes Types](../../studio/cluster/cluster-view.mdx#cluster-nodes-types) - * [Cluster Nodes States & Types Flow](../../studio/cluster/cluster-view.mdx#cluster-nodes-states--types-flow) - * [Cluster-Wide operation -vs- Database Operations](../../studio/cluster/cluster-view.mdx#cluster-wide-operation--vs--database-operations) + * [Cluster View Stats](#cluster-view-stats) + * [Cluster View Operations](#cluster-view-operations) + * [Reassign Cores](#reassign-cores) + * [Cluster Nodes Types](#cluster-nodes-types) + * [Cluster Nodes States & Types Flow](#cluster-nodes-states--types-flow) + * [Cluster-Wide operation -vs- Database Operations](#cluster-wide-operation--vs--database-operations) ## Cluster View Stats diff --git a/versioned_docs/version-6.2/studio/cluster/setting-a-cluster.mdx b/versioned_docs/version-6.2/studio/cluster/setting-a-cluster.mdx index 055855231f..8f7954fa22 100644 --- a/versioned_docs/version-6.2/studio/cluster/setting-a-cluster.mdx +++ b/versioned_docs/version-6.2/studio/cluster/setting-a-cluster.mdx @@ -27,9 +27,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Creating a database on this server * In this page: - * [Bootstrap Cluster](../../studio/cluster/setting-a-cluster.mdx#bootstrap-cluster) - * [Add Another Node to the Cluster](../../studio/cluster/setting-a-cluster.mdx#add-another-node-to-the-cluster) - * [A Cluster with 2 nodes](../../studio/cluster/setting-a-cluster.mdx#a-cluster-with-2-nodes) + * [Bootstrap Cluster](#bootstrap-cluster) + * [Add Another Node to the Cluster](#add-another-node-to-the-cluster) + * [A Cluster with 2 nodes](#a-cluster-with-2-nodes) ## Bootstrap Cluster diff --git a/versioned_docs/version-6.2/studio/database/code-assistance.mdx b/versioned_docs/version-6.2/studio/database/code-assistance.mdx index 101378cba4..8e3e881ce2 100644 --- a/versioned_docs/version-6.2/studio/database/code-assistance.mdx +++ b/versioned_docs/version-6.2/studio/database/code-assistance.mdx @@ -31,8 +31,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; views. * In this page: - * [Auto-Completion](../../studio/database/code-assistance.mdx#auto-completion) - * [Syntax Verification](../../studio/database/code-assistance.mdx#syntax-verification) + * [Auto-Completion](#auto-completion) + * [Syntax Verification](#syntax-verification) ## Auto-Completion diff --git a/versioned_docs/version-6.2/studio/database/create-new-database/from-backup.mdx b/versioned_docs/version-6.2/studio/database/create-new-database/from-backup.mdx index 3d10b22721..0ccfd7f6a9 100644 --- a/versioned_docs/version-6.2/studio/database/create-new-database/from-backup.mdx +++ b/versioned_docs/version-6.2/studio/database/create-new-database/from-backup.mdx @@ -17,11 +17,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; Backups can be easily restored using RavenDB Studio. * In this page: - * [New Database From Backup - Studio Databases View](../../../studio/database/create-new-database/from-backup.mdx#new-database-from-backup---studio-databases-view) - * [New Database From Backup - Studio Backups View](../../../studio/database/create-new-database/from-backup.mdx#new-database-from-backup---studio-backups-view) - * [Backup Source Configuration](../../../studio/database/create-new-database/from-backup.mdx#backup-source-configuration) - * [Setting Up High Availability After Restoration](../../../studio/database/create-new-database/from-backup.mdx#setting-up-high-availability-after-restoration) - * [Importing Backups into a Sharded Database](../../../studio/database/create-new-database/from-backup.mdx#importing-backups-into-a-sharded-database) + * [New Database From Backup - Studio Databases View](#new-database-from-backup---studio-databases-view) + * [New Database From Backup - Studio Backups View](#new-database-from-backup---studio-backups-view) + * [Backup Source Configuration](#backup-source-configuration) + * [Setting Up High Availability After Restoration](#setting-up-high-availability-after-restoration) + * [Importing Backups into a Sharded Database](#importing-backups-into-a-sharded-database) ## New Database From Backup - Studio Databases View diff --git a/versioned_docs/version-6.2/studio/database/create-new-database/from-legacy-files.mdx b/versioned_docs/version-6.2/studio/database/create-new-database/from-legacy-files.mdx index c0bcb36a6f..f3c7ebb82d 100644 --- a/versioned_docs/version-6.2/studio/database/create-new-database/from-legacy-files.mdx +++ b/versioned_docs/version-6.2/studio/database/create-new-database/from-legacy-files.mdx @@ -17,8 +17,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; This database creation option is designed for importing database from data files from RavenDB v3.x. * In this page: - * [1. Creating New Database From Legacy Files](../../../studio/database/create-new-database/from-legacy-files.mdx#1-creating-new-database-from-legacy-files) - * [2. Data Source Configuration](../../../studio/database/create-new-database/from-legacy-files.mdx#2-data-source-configuration) + * [1. Creating New Database From Legacy Files](#1-creating-new-database-from-legacy-files) + * [2. Data Source Configuration](#2-data-source-configuration) ## 1. Creating New Database From Legacy Files diff --git a/versioned_docs/version-6.2/studio/database/create-new-database/general-flow.mdx b/versioned_docs/version-6.2/studio/database/create-new-database/general-flow.mdx index 6337c6be88..392212af02 100644 --- a/versioned_docs/version-6.2/studio/database/create-new-database/general-flow.mdx +++ b/versioned_docs/version-6.2/studio/database/create-new-database/general-flow.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * From the Studio, the database creation options are: - * **Regular** database - see [below](../../../studio/database/create-new-database/general-flow.mdx#1-new-database). + * **Regular** database - see [below](#1-new-database). * **Encrypted** database - see [Encrypted Database](../../../studio/database/create-new-database/encrypted.mdx). * Create a database from a **Backup** copy - see [From Backup](../../../studio/database/create-new-database/from-backup.mdx). * Create a database from a **Previous** RavenDB version database - see [From Legacy File](../../../studio/database/create-new-database/from-legacy-files.mdx). @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To create a new database using the Client API, see [Create database operation](../../../client-api/operations/server-wide/create-database.mdx). * In this article: - * [1. New Database](../../../studio/database/create-new-database/general-flow.mdx#1-new-database) - * [2. Database Name](../../../studio/database/create-new-database/general-flow.mdx#2-database-name) - * [3. Configure Replication](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) - * [4. Configure Path](../../../studio/database/create-new-database/general-flow.mdx#4-configure-path) - * [5. Create](../../../studio/database/create-new-database/general-flow.mdx#5-create) + * [1. New Database](#1-new-database) + * [2. Database Name](#2-database-name) + * [3. Configure Replication](#3-configure-replication) + * [4. Configure Path](#4-configure-path) + * [5. Create](#5-create) ## 1. New Database diff --git a/versioned_docs/version-6.2/studio/database/databases-list-view.mdx b/versioned_docs/version-6.2/studio/database/databases-list-view.mdx index b2fa9fcdf4..3222e1c32c 100644 --- a/versioned_docs/version-6.2/studio/database/databases-list-view.mdx +++ b/versioned_docs/version-6.2/studio/database/databases-list-view.mdx @@ -19,11 +19,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions can be performed on each database * In this page: - * [Database Stats](../../studio/database/databases-list-view.mdx#database-stats) - * [Database Actions](../../studio/database/databases-list-view.mdx#database-actions) - * [Creating New Database Options](../../studio/database/databases-list-view.mdx#creating-new-database-options) - * [More Actions](../../studio/database/databases-list-view.mdx#more-actions) - * [Remote Database](../../studio/database/databases-list-view.mdx#remote-database) + * [Database Stats](#database-stats) + * [Database Actions](#database-actions) + * [Creating New Database Options](#creating-new-database-options) + * [More Actions](#more-actions) + * [Remote Database](#remote-database) ## Database Stats @@ -37,7 +37,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * ***Disabled*** - the database has been disabled. * Note: - If the database is contained in a cluster's node that is different than the node that is currently viewed in this Studio instance, then 'Remote' will be indicated - see more [below](../../studio/database/databases-list-view.mdx#remote-database). + If the database is contained in a cluster's node that is different than the node that is currently viewed in this Studio instance, then 'Remote' will be indicated - see more [below](#remote-database). 2. **Containing nodes** These are the nodes that contain a copy of the database. @@ -70,7 +70,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Figure 2. Database Actions](./assets/database-actions-1.png) 1. **Create new database** - A new database can be created from scratch, from a backup copy, or from existing 3.x data - see more [below](../../studio/database/databases-list-view.mdx#creating-new-database-options). + A new database can be created from scratch, from a backup copy, or from existing 3.x data - see more [below](#creating-new-database-options). 2. **Manage group** Click to manage the nodes that contain this database - see more about [The Database Group](../../studio/database/settings/manage-database-group.mdx). @@ -79,7 +79,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; A disabled database cannot be accessed. 4. **More actions** - Pause indexing, Disable indexing, Compact database - see more [below](../../studio/database/databases-list-view.mdx#more-actions). + Pause indexing, Disable indexing, Compact database - see more [below](#more-actions). 5. **Refresh data** Refresh the database stats data in this view from the server. diff --git a/versioned_docs/version-6.2/studio/database/document-extensions/counters.mdx b/versioned_docs/version-6.2/studio/database/document-extensions/counters.mdx index 5ffdfdca22..172bc80968 100644 --- a/versioned_docs/version-6.2/studio/database/document-extensions/counters.mdx +++ b/versioned_docs/version-6.2/studio/database/document-extensions/counters.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Create and manage Counters using [API methods](../../../document-extensions/counters/overview.mdx) or through the Studio. * In this page: - * [Viewing Counters Data](../../../studio/database/document-extensions/counters.mdx#viewing-counters-data) - * [Managing Counters](../../../studio/database/document-extensions/counters.mdx#managing-counters) - * [Counters Export and Import](../../../studio/database/document-extensions/counters.mdx#counters-export-and-import) + * [Viewing Counters Data](#viewing-counters-data) + * [Managing Counters](#managing-counters) + * [Counters Export and Import](#counters-export-and-import) ## Viewing Counters Data diff --git a/versioned_docs/version-6.2/studio/database/document-extensions/revisions.mdx b/versioned_docs/version-6.2/studio/database/document-extensions/revisions.mdx index 726870f9fb..d3623a4958 100644 --- a/versioned_docs/version-6.2/studio/database/document-extensions/revisions.mdx +++ b/versioned_docs/version-6.2/studio/database/document-extensions/revisions.mdx @@ -26,11 +26,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Comparing revisions * Viewing revisions for deleted documents (Revisions Bin) * In this page: - * [Revisions Tab](../../../studio/database/document-extensions/revisions.mdx#revisions-tab) - * [Revision inspection](../../../studio/database/document-extensions/revisions.mdx#revision-inspection) - * [Revisions comparison](../../../studio/database/document-extensions/revisions.mdx#revisions-comparison) - * [Revisions Bin](../../../studio/database/document-extensions/revisions.mdx#revisions-bin) - * [Restoring revisions](../../../studio/database/document-extensions/revisions.mdx#restoring-revisions) + * [Revisions Tab](#revisions-tab) + * [Revision inspection](#revision-inspection) + * [Revisions comparison](#revisions-comparison) + * [Revisions Bin](#revisions-bin) + * [Restoring revisions](#restoring-revisions) ## Revisions Tab @@ -130,7 +130,7 @@ Click the revision's comparison button to compare it with other revisions: This is the ID of the document that was deleted. Click it to inspect the revisions created for this document. ![Revisions of a deleted document](./assets/orphaned-revisions.png) - * Revisions stored in the revisions bin can be [inspected](../../../studio/database/document-extensions/revisions.mdx#revision-inspection) + * Revisions stored in the revisions bin can be [inspected](#revision-inspection) and cloned just like the revisions of a live document. 5. **Change vector** The change vector of the revision that was created for the document when it was deleted. diff --git a/versioned_docs/version-6.2/studio/database/document-extensions/time-series.mdx b/versioned_docs/version-6.2/studio/database/document-extensions/time-series.mdx index 942df7b41d..b5e35e6882 100644 --- a/versioned_docs/version-6.2/studio/database/document-extensions/time-series.mdx +++ b/versioned_docs/version-6.2/studio/database/document-extensions/time-series.mdx @@ -21,19 +21,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * An **Incremental Time Series** is a special type of time series that allows you to handle time series values as counters. Read more about incremental time series [here](../../../document-extensions/timeseries/incremental-time-series/overview.mdx), - and learn how to define them through Studio [below](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series). + and learn how to define them through Studio [below](#incremental-time-series). * In this page: - * [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) - * [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) - * [Create new Time Series (by Creating the First Entry)](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-its-first-entry) - * [Editing an Entry](../../../studio/database/document-extensions/time-series.mdx#editing-an-entry) - * [Deleting a Range of Entries](../../../studio/database/document-extensions/time-series.mdx#deleting-a-range-of-entries) - * [Querying Time Series](../../../studio/database/document-extensions/time-series.mdx#querying-time-series) - * [Results in Graph View](../../../studio/database/document-extensions/time-series.mdx#results-in-graph-view) - * [Incremental Time Series](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series) - * [Creating a new Incremental Time Series (by Creating its First Entry)](../../../studio/database/document-extensions/time-series.mdx#creating-a-new-incremental-time-series-by-creating-its-first-entry) - * [Editing an Incremental Time Series Entry](../../../studio/database/document-extensions/time-series.mdx#editing-an-incremental-time-series-entry) + * [Document View](#document-view) + * [Time Series View](#time-series-view) + * [Create new Time Series (by Creating the First Entry)](#create-new-time-series-by-creating-its-first-entry) + * [Editing an Entry](#editing-an-entry) + * [Deleting a Range of Entries](#deleting-a-range-of-entries) + * [Querying Time Series](#querying-time-series) + * [Results in Graph View](#results-in-graph-view) + * [Incremental Time Series](#incremental-time-series) + * [Creating a new Incremental Time Series (by Creating its First Entry)](#creating-a-new-incremental-time-series-by-creating-its-first-entry) + * [Editing an Incremental Time Series Entry](#editing-an-incremental-time-series-entry) @@ -45,7 +45,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. To view a document's time series, open its [document view](../../../studio/database/documents/document-view.mdx) and click the time series tab on the right. -2. Click 'Add Time Series' to create a new time series [see more below](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-its-first-entry). +2. Click 'Add Time Series' to create a new time series [see more below](#create-new-time-series-by-creating-its-first-entry). 3. Click to view and modify time series data. @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A. Time series info: * B. **Name** - [Incremental Time Series](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series) + [Incremental Time Series](#incremental-time-series) names always begin with `INC:` E.g. **INC: Downloads** in the first time series listed above. @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Click to select another time series. -2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a [new time series](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-the-first-entry). +2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a [new time series](#create-new-time-series-by-creating-the-first-entry). 3. Delete all entries from a specified time range. 4. Edit entry. @@ -93,7 +93,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; once all entries have been deleted). * Click the **Add Time Series** button from the - [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) + [Document View](#document-view) to create the time series' first entry. ![Add Time Series](./assets/new-time-series.png) @@ -103,7 +103,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. **Time Series Type** * **Diasble** to create a **non-incremental time series**. - (Learn now to create an incremental time series [here](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series)) + (Learn now to create an incremental time series [here](#incremental-time-series)) 2. **Time Series Name** * Enter time series' name. * Name cannot start with 'INC:' as this prefix is reserved for incremental time series. @@ -121,7 +121,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ### Editing an Entry * Click the **Edit Item** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to edit a time series' entry. ![Edit Time Series](./assets/edit-time-series.png) @@ -138,7 +138,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ### Deleting a Range of Entries * Click the **Delete Range** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to delete a range of time series entries. ![Delete Range Button](./assets/delete-range-button.png) @@ -253,7 +253,7 @@ To specify a range of time series entries: once all entries have been deleted). * Click the **Add Time Series** button from the - [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) + [Document View](#document-view) to create the incremental time series' first entry. ![Add Time Series](./assets/new-time-series.png) @@ -279,7 +279,7 @@ To specify a range of time series entries: ### Editing an Incremental Time Series Entry * Click the **Edit Item** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to edit a time series' entry. ![Edit Time Series](./assets/edit-incremental-time-series.png) diff --git a/versioned_docs/version-6.2/studio/database/documents/compare-exchange-view.mdx b/versioned_docs/version-6.2/studio/database/documents/compare-exchange-view.mdx index c9fa3757ea..12230988c2 100644 --- a/versioned_docs/version-6.2/studio/database/documents/compare-exchange-view.mdx +++ b/versioned_docs/version-6.2/studio/database/documents/compare-exchange-view.mdx @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; as of RavenDB 5.2, we automatically create and maintain Atomic Guard CmpXchg items in cluster-wide sessions. * [API Operations](../../../client-api/operations/compare-exchange/overview.mdx) * [Session - Cluster Transaction](../../../client-api/session/cluster-transaction/overview.mdx) - * Using the [RavenDB Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) + * Using the [RavenDB Studio](#the-compare-exchange-view) * In this page: - * [The Compare Exchange View](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) + * [The Compare Exchange View](#the-compare-exchange-view) ## The Compare Exchange View diff --git a/versioned_docs/version-6.2/studio/database/documents/create-new-document.mdx b/versioned_docs/version-6.2/studio/database/documents/create-new-document.mdx index ef2443ab36..d560e93b1b 100644 --- a/versioned_docs/version-6.2/studio/database/documents/create-new-document.mdx +++ b/versioned_docs/version-6.2/studio/database/documents/create-new-document.mdx @@ -28,10 +28,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * For a full description of the different ID types, see [Document Identifier Generation](../../../server/kb/document-identifier-generation.mdx). * In this article: - * [Create new document](../../../studio/database/documents/create-new-document.mdx#create-new-document) - * [Create new document in current collection](../../../studio/database/documents/create-new-document.mdx#create-new-document-in-current-collection) - * [Clone an existing document](../../../studio/database/documents/create-new-document.mdx#clone-an-existing-document) - * [Document ID types - examples](../../../studio/database/documents/create-new-document.mdx#document-id-types---examples) + * [Create new document](#create-new-document) + * [Create new document in current collection](#create-new-document-in-current-collection) + * [Clone an existing document](#clone-an-existing-document) + * [Document ID types - examples](#document-id-types---examples) ## Create new document @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Figure 2. Edit the new document](./assets/create-new-document-2.png) -* 1 - **Enter document ID** - see the [examples](../../../studio/database/documents/create-new-document.mdx#document-id-types---examples) below. +* 1 - **Enter document ID** - see the [examples](#document-id-types---examples) below. * Any collection name can be entered as a prefix. * The collection name will be created if it doesn't exist yet. * If no collection name is specified, i.e. the ID string doesn't end with ( / ) or ( | ), @@ -68,7 +68,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 1 - **Enter document ID** * The current collection name is initially suggested. * Any other collection name of your choice can still be entered, - document creation will be handled as described above in [Create New Document](../../../studio/database/documents/create-new-document.mdx#create-new-document). + document creation will be handled as described above in [Create New Document](#create-new-document). * 2 - **Edit document content** * Edit the document fields. @@ -76,7 +76,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; then the initial document content showing will be those fields. (In the above example the fields are: _ID Type_ & _Name_) * If not all documents share the exact same fields, - then the initial document content will be just the initial template as in [Create New Document](../../../studio/database/documents/create-new-document.mdx#create-new-document). + then the initial document content will be just the initial template as in [Create New Document](#create-new-document). * 3 - Click **Save** when done. diff --git a/versioned_docs/version-6.2/studio/database/documents/document-view.mdx b/versioned_docs/version-6.2/studio/database/documents/document-view.mdx index 5b9d76594f..5032f1b714 100644 --- a/versioned_docs/version-6.2/studio/database/documents/document-view.mdx +++ b/versioned_docs/version-6.2/studio/database/documents/document-view.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions such as cloning the document, deleting, adding attachments, and much more can be performed. * In this page: - * [Document View](../../../studio/database/documents/document-view.mdx#the-document-view) - * [Documents View - Actions](../../../studio/database/documents/document-view.mdx#document-view---actions) + * [Document View](#the-document-view) + * [Documents View - Actions](#document-view---actions) ## The Document View diff --git a/versioned_docs/version-6.2/studio/database/documents/documents-and-collections.mdx b/versioned_docs/version-6.2/studio/database/documents/documents-and-collections.mdx index 5a5005cd41..2de518717b 100644 --- a/versioned_docs/version-6.2/studio/database/documents/documents-and-collections.mdx +++ b/versioned_docs/version-6.2/studio/database/documents/documents-and-collections.mdx @@ -35,7 +35,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [The Documents View](../../../studio/database/documents/documents-and-collections.mdx#the-documents-view) + * [The Documents View](#the-documents-view) * [The @hilo Collection](../../../studio/database/documents/documents-and-collections.mdx#the-@hilo-collection) * [The @empty Collection](../../../studio/database/documents/documents-and-collections.mdx#the-@empty-collection) diff --git a/versioned_docs/version-6.2/studio/database/documents/identities-view.mdx b/versioned_docs/version-6.2/studio/database/documents/identities-view.mdx index 1a7994fe08..8ac3dfb69a 100644 --- a/versioned_docs/version-6.2/studio/database/documents/identities-view.mdx +++ b/versioned_docs/version-6.2/studio/database/documents/identities-view.mdx @@ -21,10 +21,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Identities values can also be managed from the Client API, see [seed identity operation](../../../client-api/operations/maintenance/identities/seed-identity.mdx). * In this article: - * [What is an identity](../../../studio/database/documents/identities-view.mdx#what-is-an-identity) - * [The latest values](../../../studio/database/documents/identities-view.mdx#the-latest-values) - * [Edit identity value](../../../studio/database/documents/identities-view.mdx#edit-identity-value) - * [Add new identity](../../../studio/database/documents/identities-view.mdx#add-new-identity) + * [What is an identity](#what-is-an-identity) + * [The latest values](#the-latest-values) + * [Edit identity value](#edit-identity-value) + * [Add new identity](#add-new-identity) @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. **Document ID Prefix** * This string is the collection name for which an identity value was set: - either [via this view](../../../studio/database/documents/identities-view.mdx#add-new-identity), + either [via this view](#add-new-identity), or by creating a document with an identity ID as described [here](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities). * The string that shows is the collection name + a pipe suffix. diff --git a/versioned_docs/version-6.2/studio/database/documents/patch-view.mdx b/versioned_docs/version-6.2/studio/database/documents/patch-view.mdx index 8654661c9d..415ca5f02e 100644 --- a/versioned_docs/version-6.2/studio/database/documents/patch-view.mdx +++ b/versioned_docs/version-6.2/studio/database/documents/patch-view.mdx @@ -23,11 +23,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Patching a single document](../../../client-api/operations/patching/single-document.mdx) * [Set-based patch operations](../../../client-api/operations/patching/set-based.mdx) * In this article: - * [The patch view](../../../studio/database/documents/patch-view.mdx#the-patch-view) - * [The patch script](../../../studio/database/documents/patch-view.mdx#the-patch-script) - * [Patch configuration](../../../studio/database/documents/patch-view.mdx#patch-configuration) - * [Test patch](../../../studio/database/documents/patch-view.mdx#test-patch) - * [Apply patch](../../../studio/database/documents/patch-view.mdx#apply-patch) + * [The patch view](#the-patch-view) + * [The patch script](#the-patch-script) + * [Patch configuration](#patch-configuration) + * [Test patch](#test-patch) + * [Apply patch](#apply-patch) ## The patch view @@ -40,13 +40,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to view sample patch script syntax. More examples are available [here](../../../client-api/operations/patching/set-based.mdx#examples). 3. **Enter the patch script** - Enter your [Patch script](../../../studio/database/documents/patch-view.mdx#the-patch-script) in this input box. + Enter your [Patch script](#the-patch-script) in this input box. 4. **Apply the patch** Click to apply the patch to the documents selected by the query section of the patch script. - See [Apply patch](../../../studio/database/documents/patch-view.mdx#apply-patch) below. + See [Apply patch](#apply-patch) below. 5. **Test the patch** Click to test your patch without actually applying it to your documents. - See [Test patch](../../../studio/database/documents/patch-view.mdx#test-patch) below. + See [Test patch](#test-patch) below. diff --git a/versioned_docs/version-6.2/studio/database/indexes/create-map-index.mdx b/versioned_docs/version-6.2/studio/database/indexes/create-map-index.mdx index f2921b2800..7139d0e18f 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/create-map-index.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/create-map-index.mdx @@ -18,15 +18,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; that indicate how to index selected document fields, counters, and time series data. * In this page: - * [Edit Index View](../../../studio/database/indexes/create-map-index.mdx#edit-index-view) - * [Test Index](../../../studio/database/indexes/create-map-index.mdx#test-index) - * [Index Fields & Terms](../../../studio/database/indexes/create-map-index.mdx#index-fields--terms) - * [Index Field Options](../../../studio/database/indexes/create-map-index.mdx#index-field-options) - * [Add Compound Field](../../../studio/database/indexes/create-map-index.mdx#add-compound-field) - * [Configuration](../../../studio/database/indexes/create-map-index.mdx#configuration) - * [Additional Assemblies](../../../studio/database/indexes/create-map-index.mdx#additional-assemblies) - * [Additional Sources](../../../studio/database/indexes/create-map-index.mdx#additional-sources) - * [Spatial Field Options](../../../studio/database/indexes/create-map-index.mdx#spatial-field-options) + * [Edit Index View](#edit-index-view) + * [Test Index](#test-index) + * [Index Fields & Terms](#index-fields--terms) + * [Index Field Options](#index-field-options) + * [Add Compound Field](#add-compound-field) + * [Configuration](#configuration) + * [Additional Assemblies](#additional-assemblies) + * [Additional Sources](#additional-sources) + * [Spatial Field Options](#spatial-field-options) ## Edit Index View @@ -40,7 +40,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. Options available for an already saved index: **Copy C#** - Click to view and copy the C# class that defines the index as set in the Studio. **Query** - Click to go the the Query View and query this index. - **Terms** - Click to see the index terms, see [below](../../../studio/database/indexes/create-map-index.mdx#index-fields--terms). + **Terms** - Click to see the index terms, see [below](#index-fields--terms). **Advanced** - Click to dump the raw index or optimize it. **Delete** - Delete this index. @@ -175,7 +175,7 @@ modifications in the index maps and configuration. Hover over a term to Query the index by this term, Preview the term, or Copy the term to the clipboard. Terms are created from the value of the field that was requested to be indexed - by the specified [Field Options](../../../studio/database/indexes/create-map-index.mdx#index-field-options). + by the specified [Field Options](#index-field-options). @@ -190,7 +190,7 @@ modifications in the index maps and configuration. If the Corax search engine is used, compound fields can be added to optimize specific queries. This option is for **expert users only**. * Learn about Corax and compound fields [here](../../../indexes/search-engine/corax.mdx#compound-fields). - * Learn to add a compound field using Studio [below](../../../studio/database/indexes/create-map-index.mdx#add-compound-field). + * Learn to add a compound field using Studio [below](#add-compound-field). 3. **Add default field options** Use this option to set default field options for all indexed fields. @@ -228,7 +228,7 @@ modifications in the index maps and configuration. ask about (i.e. spelling errors). * [Spatial](../../../indexes/querying/spatial.mdx) - See [below](../../../studio/database/indexes/create-map-index.mdx#spatial-field-options) + See [below](#spatial-field-options) 6. **Advanced Options** Click to display or hide these advanced index field options: diff --git a/versioned_docs/version-6.2/studio/database/indexes/create-map-reduce-index.mdx b/versioned_docs/version-6.2/studio/database/indexes/create-map-reduce-index.mdx index 16ffbe6f64..8f2ab6f623 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/create-map-reduce-index.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/create-map-reduce-index.mdx @@ -35,15 +35,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Map-Reduce results can be visualized in the [Map-Reduce Visualizer](../../../studio/database/indexes/map-reduce-visualizer.mdx). * In this page: - * [The Map Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-map-stage) - * [The Reduce Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-reduce-stage) - * [Important Guidelines](../../../studio/database/indexes/create-map-reduce-index.mdx#important-guidelines) - * [Map-Reduce Query Results](../../../studio/database/indexes/create-map-reduce-index.mdx#map-reduce-query-results) - * [Multi-Map-Reduce](../../../studio/database/indexes/create-map-reduce-index.mdx#multi-map-reduce) + * [The Map Stage](#the-map-stage) + * [The Reduce Stage](#the-reduce-stage) + * [Important Guidelines](#important-guidelines) + * [Map-Reduce Query Results](#map-reduce-query-results) + * [Multi-Map-Reduce](#multi-map-reduce) * [Saving Map-Reduce Results into a Collection (Artificial Documents)](../../../studio/database/indexes/create-map-reduce-index.mdx#saving-map-reduce-results-in-a-collection-(artificial-documents)) - * [Artificial -vs- Regular Documents](../../../studio/database/indexes/create-map-reduce-index.mdx#artificial-documents--vs--regular-documents) - * [Artificial Documents Usage](../../../studio/database/indexes/create-map-reduce-index.mdx#artificial-documents-usage) - * [Artificial Documents Limitations](../../../studio/database/indexes/create-map-reduce-index.mdx#limitations) + * [Artificial -vs- Regular Documents](#artificial-documents--vs--regular-documents) + * [Artificial Documents Usage](#artificial-documents-usage) + * [Artificial Documents Limitations](#limitations) ## The Map Stage @@ -81,7 +81,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The accumulative value of this field will represent the total amount spent by a company on _all_ orders. 3. Next, click 'Add Reduction' to continue and add the 'Reduce' function. - See [The Reduce Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-reduce-stage). + See [The Reduce Stage](#the-reduce-stage). ## The Reduce Stage diff --git a/versioned_docs/version-6.2/studio/database/indexes/create-multi-map-index.mdx b/versioned_docs/version-6.2/studio/database/indexes/create-multi-map-index.mdx index 9b387992d8..0f3b85fb38 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/create-multi-map-index.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/create-multi-map-index.mdx @@ -22,8 +22,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Multi-Map indexes require that all the Map functions defined have the _same_ output structure. * In this page: - * [Define a Map Function](../../../studio/database/indexes/create-multi-map-index.mdx#define-a-map-function) - * [Add another Map Function](../../../studio/database/indexes/create-multi-map-index.mdx#add-another-map-function) + * [Define a Map Function](#define-a-map-function) + * [Add another Map Function](#add-another-map-function) ## Define a Map Function diff --git a/versioned_docs/version-6.2/studio/database/indexes/index-cleanup.mdx b/versioned_docs/version-6.2/studio/database/indexes/index-cleanup.mdx index 777309738b..7de49e6c57 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/index-cleanup.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/index-cleanup.mdx @@ -28,11 +28,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Merge indexes](../../../studio/database/indexes/index-cleanup.mdx#merge-indexes) - * [Remove sub-indexes](../../../studio/database/indexes/index-cleanup.mdx#remove-sub-indexes) - * [Remove unused indexes](../../../studio/database/indexes/index-cleanup.mdx#remove-unused-indexes) - * [Indexes that will not be merged](../../../studio/database/indexes/index-cleanup.mdx#indexes-that-will-not-be-merged) - * [Merge suggestions errors](../../../studio/database/indexes/index-cleanup.mdx#merge-suggestions-errors) + * [Merge indexes](#merge-indexes) + * [Remove sub-indexes](#remove-sub-indexes) + * [Remove unused indexes](#remove-unused-indexes) + * [Indexes that will not be merged](#indexes-that-will-not-be-merged) + * [Merge suggestions errors](#merge-suggestions-errors) ## Merge indexes diff --git a/versioned_docs/version-6.2/studio/database/indexes/index-history.mdx b/versioned_docs/version-6.2/studio/database/indexes/index-history.mdx index 879d008438..17e5c1c217 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/index-history.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/index-history.mdx @@ -17,7 +17,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * An index revision is created for any change made to the index definition. * By default 10 index revisions are kept. This number can be modified using - the [Database Settings view](../../../studio/database/indexes/index-history.mdx#view-and-update-number-of-index-revisions) + the [Database Settings view](#view-and-update-number-of-index-revisions) or through [configuration](../../../server/configuration/configuration-options.mdx). * The Index History dialog allows you to browse these revisions and revert @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can revert only the 'Map and Reduce' methods or the full index definition. * In this page: - * [Open Index History Dialog](../../../studio/database/indexes/index-history.mdx#open-index-history-dialog) - * [Index History Dialog](../../../studio/database/indexes/index-history.mdx#index-history-dialog) - * [Select and Load an Index Revision](../../../studio/database/indexes/index-history.mdx#select-and-load-an-index-revision) - * [View and Update Number of Index Revisions](../../../studio/database/indexes/index-history.mdx#view-and-update-number-of-index-revisions) + * [Open Index History Dialog](#open-index-history-dialog) + * [Index History Dialog](#index-history-dialog) + * [Select and Load an Index Revision](#select-and-load-an-index-revision) + * [View and Update Number of Index Revisions](#view-and-update-number-of-index-revisions) ## Open Index History Dialog diff --git a/versioned_docs/version-6.2/studio/database/indexes/indexes-list-view.mdx b/versioned_docs/version-6.2/studio/database/indexes/indexes-list-view.mdx index e588cc72c2..49d304475d 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/indexes-list-view.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/indexes-list-view.mdx @@ -20,11 +20,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; and more. * In this article: - * [Indexes list view](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view) - * [Indexes list view - Actions](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) - * [Indexes list view - Index errors](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---errors) - * [Indexes list view - Side by side indexing](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing) - * [Indexes list view - Rolling deployment](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---rolling-deployment) + * [Indexes list view](#indexes-list-view) + * [Indexes list view - Actions](#indexes-list-view---actions) + * [Indexes list view - Index errors](#indexes-list-view---errors) + * [Indexes list view - Side by side indexing](#indexes-list-view---side-by-side-indexing) + * [Indexes list view - Rolling deployment](#indexes-list-view---rolling-deployment) ## Indexes list view @@ -110,7 +110,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; By default, RavenDB prioritizes request processing over indexing to ensure responsiveness. * **Mode** Set the modification behavior (for static-indexes only): - * Unlocked - Changes to the index definition will be applied. See [Side by side indexing](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing). + * Unlocked - Changes to the index definition will be applied. See [Side by side indexing](#indexes-list-view---side-by-side-indexing). * Locked - Changes to the index definition will not be applied. No error is raised. * Locked(Error) - Changes to the index definition will not be applied, and an error is raised when attempting to modify the index. diff --git a/versioned_docs/version-6.2/studio/database/indexes/indexes-overview.mdx b/versioned_docs/version-6.2/studio/database/indexes/indexes-overview.mdx index 72431a3656..0d1346abe5 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/indexes-overview.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/indexes-overview.mdx @@ -29,19 +29,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Auto-indexes are generated by the server - see [Auto indexes](../../../indexes/creating-and-deploying.mdx#auto-indexes) * In this page: - * [Indexes - The General Concept](../../../studio/database/indexes/indexes-overview.mdx#indexes---the-general-concept) - * [Indexes - The Moving Parts](../../../studio/database/indexes/indexes-overview.mdx#indexes---the-moving-parts) : - * [Index Definition](../../../studio/database/indexes/indexes-overview.mdx#index-definition) - * [Indexing Process](../../../studio/database/indexes/indexes-overview.mdx#indexing-process) - * [Indexed Data](../../../studio/database/indexes/indexes-overview.mdx#indexed-data) - * [Index Types](../../../studio/database/indexes/indexes-overview.mdx#index-types) : - * [Auto Indexes -vs- Static Indexes](../../../studio/database/indexes/indexes-overview.mdx#auto-indexes--vs--static-indexes) - * [Map Indexes -vs- Map-Reduce Indexes](../../../studio/database/indexes/indexes-overview.mdx#map-indexes--vs--map-reduce-indexes) - * [Single-Collection Indexes -vs- Multi-Collection Indexes](../../../studio/database/indexes/indexes-overview.mdx#single-collection-indexes--vs--multi-collection-indexes) - * [Field Configuration Options](../../../studio/database/indexes/indexes-overview.mdx#field-configuration-options) - * [Modifying Index Definition](../../../studio/database/indexes/indexes-overview.mdx#modifying-index-definition) - * [Indexes in the Cluster](../../../studio/database/indexes/indexes-overview.mdx#indexes-in-the-cluster) - * [Indexing Errors](../../../studio/database/indexes/indexes-overview.mdx#indexing-errors) + * [Indexes - The General Concept](#indexes---the-general-concept) + * [Indexes - The Moving Parts](#indexes---the-moving-parts) : + * [Index Definition](#index-definition) + * [Indexing Process](#indexing-process) + * [Indexed Data](#indexed-data) + * [Index Types](#index-types) : + * [Auto Indexes -vs- Static Indexes](#auto-indexes--vs--static-indexes) + * [Map Indexes -vs- Map-Reduce Indexes](#map-indexes--vs--map-reduce-indexes) + * [Single-Collection Indexes -vs- Multi-Collection Indexes](#single-collection-indexes--vs--multi-collection-indexes) + * [Field Configuration Options](#field-configuration-options) + * [Modifying Index Definition](#modifying-index-definition) + * [Indexes in the Cluster](#indexes-in-the-cluster) + * [Indexing Errors](#indexing-errors) ## Indexes - The General Concept @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * After the first **indexing** run, the index will keep this map current _without_ re-processing the entire dataset - the index will only update the relevant indexed data when a document update happens in the database. -* Indexes in RavenDB are split across multiple axes (see more [below](../../../studio/database/indexes/indexes-overview.mdx#index-types)) +* Indexes in RavenDB are split across multiple axes (see more [below](#index-types)) * Auto Indexes -vs- Static Indexes * Map Indexes -vs- Map-Reduce Indexes diff --git a/versioned_docs/version-6.2/studio/database/indexes/indexing-performance.mdx b/versioned_docs/version-6.2/studio/database/indexes/indexing-performance.mdx index dbcb9386f6..ded03e4f96 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/indexing-performance.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/indexing-performance.mdx @@ -23,14 +23,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Indexing Performance View](../../../studio/database/indexes/indexing-performance.mdx#indexing-performance-view) -* [Types of Index Tracks](../../../studio/database/indexes/indexing-performance.mdx#types-of-index-tracks) -* [Index Statistics View](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view) -* [Common Indexing Issues](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) - - [Resource Exhaustion](../../../studio/database/indexes/indexing-performance.mdx#resource-exhaustion) - - [Low Memory](../../../studio/database/indexes/indexing-performance.mdx#low-memory) - - [Concurrent Processing of Too Many Indexes](../../../studio/database/indexes/indexing-performance.mdx#concurrent-processing-of-too-many-indexes) - - [LoadDocument Misuse](../../../studio/database/indexes/indexing-performance.mdx#loaddocument-misuse) +* [Indexing Performance View](#indexing-performance-view) +* [Types of Index Tracks](#types-of-index-tracks) +* [Index Statistics View](#index-statistics-view) +* [Common Indexing Issues](#common-indexing-issues) + - [Resource Exhaustion](#resource-exhaustion) + - [Low Memory](#low-memory) + - [Concurrent Processing of Too Many Indexes](#concurrent-processing-of-too-many-indexes) + - [LoadDocument Misuse](#loaddocument-misuse) ## Indexing Performance View ![Indexing Performance View](./assets/indexing-performance-overview.png) @@ -55,10 +55,10 @@ In this page: * The red area represents the area that is zoomed in below. Enlarge or shrink it to zoom in and out below. 9. **Auto/Orders/ByOrderedAt** (Expanded Track) * This is one of the various types of indexes that is tracked in time. - * Clicking the index title expands the track (as seen in the **Auto/Orders/ByOrderedAt** image above) to show index [batch process details](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view). + * Clicking the index title expands the track (as seen in the **Auto/Orders/ByOrderedAt** image above) to show index [batch process details](#index-statistics-view). * Varying index types have different processes and they may index different volumes of data, so the graphs are likely to differ from one another. * Each colored stripe shows the duration of a stage in the batch process. - * Hovering over each stripe shows [detailed statistics](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view) about each stage. + * Hovering over each stripe shows [detailed statistics](#index-statistics-view) about each stage. 10. **Vertical line** Each verticle purple line shows that there was a time-lapse in the timeline before a batch process started. @@ -152,7 +152,7 @@ Click the following links to learn more about defining indexes via the Studio: - **(Name of the method used to create a batch stop)** There are a number of configurations that break up large batch processes into smaller batches to prevent exhausting system resources. While these batch stops prevent system exhaustion, they also point to potential opportunities to optimize your indexes. - These situations are discussed in the section on [common indexing issues](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) + These situations are discussed in the section on [common indexing issues](#common-indexing-issues) 3. **Storage** stages The amount of time it took to read or write the data to disk. * If this stage takes a long time after the index is already built, it may reveal a hardware problem. @@ -176,16 +176,16 @@ While they prevent system exhaustion, batch stops also point to potential **oppo Batch stops break up processes into smaller batches when - - An index is processing a [dataset that is too large](../../../studio/database/indexes/indexing-performance.mdx#resource-exhaustion) for your system resources. + - An index is processing a [dataset that is too large](#resource-exhaustion) for your system resources. - The index definition requires a complex Linq process (in Java - Stream API process) that can exhaust your resources. - - [Low memory](../../../studio/database/indexes/indexing-performance.mdx#low-memory) resources for indexing process on local machines or burstable cloud instances. - - [Too many concurrent index processes](../../../studio/database/indexes/indexing-performance.mdx#concurrent-processing-of-too-many-indexes) are exhausting your system resources. - - The [LoadDocument](../../../studio/database/indexes/indexing-performance.mdx#loaddocument-misuse) method is misused. + - [Low memory](#low-memory) resources for indexing process on local machines or burstable cloud instances. + - [Too many concurrent index processes](#concurrent-processing-of-too-many-indexes) are exhausting your system resources. + - The [LoadDocument](#loaddocument-misuse) method is misused. #### Resource Exhaustion Some indexes are responsible for a huge dataset and/or have very complex, demanding definitions. To prevent resource exhaustion, RavenDB can break up large batches into smaller ones. -You can configure [batch stops](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) with the following methods: +You can configure [batch stops](#common-indexing-issues) with the following methods: - [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) Number of seconds after which mapping will end even if there is more to map. @@ -195,7 +195,7 @@ You can configure [batch stops](../../../studio/database/indexes/indexing-perfor Maximum number of documents to be processed by the index per indexing batch. #### Low Memory -* [Low Memory](../../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) resources can slow down your system and result in [batch stops](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues). +* [Low Memory](../../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) resources can slow down your system and result in [batch stops](#common-indexing-issues). * **On a local machine** * You can upgrade your hardware, divide the work onto more machines in a cluster, and/or optimize your indexes. * Until then, there are a number of [indexing configurations](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that you can configure diff --git a/versioned_docs/version-6.2/studio/database/indexes/map-reduce-visualizer.mdx b/versioned_docs/version-6.2/studio/database/indexes/map-reduce-visualizer.mdx index a5b4651d5f..88c9434e77 100644 --- a/versioned_docs/version-6.2/studio/database/indexes/map-reduce-visualizer.mdx +++ b/versioned_docs/version-6.2/studio/database/indexes/map-reduce-visualizer.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; by graphing the relations between the documents and the Map-Reduce results. * In this page: - * [Map-Reduce Visualizer Usage Flow](../../../studio/database/indexes/map-reduce-visualizer.mdx#map-reduce-visualizer-usage-flow) - * [Map-Reduce Visualizer for Big Data](../../../studio/database/indexes/map-reduce-visualizer.mdx#map-reduce-visualizer-for-big-data) + * [Map-Reduce Visualizer Usage Flow](#map-reduce-visualizer-usage-flow) + * [Map-Reduce Visualizer for Big Data](#map-reduce-visualizer-for-big-data) ## Map-Reduce Visualizer Usage Flow diff --git a/versioned_docs/version-6.2/studio/database/queries/query-view.mdx b/versioned_docs/version-6.2/studio/database/queries/query-view.mdx index 0423f08d16..04885f374b 100644 --- a/versioned_docs/version-6.2/studio/database/queries/query-view.mdx +++ b/versioned_docs/version-6.2/studio/database/queries/query-view.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query results can be saved/exported to a CSV file. * In this page: - * [Query View](../../../studio/database/queries/query-view.mdx#query-view) - * [Query Results](../../../studio/database/queries/query-view.mdx#query-results) - * [Select Visible Columns](../../../studio/database/queries/query-view.mdx#select-visible-columns) - * [Result Columns](../../../studio/database/queries/query-view.mdx#result-columns) - * [Additional Query Options](../../../studio/database/queries/query-view.mdx#additional-query-options) + * [Query View](#query-view) + * [Query Results](#query-results) + * [Select Visible Columns](#select-visible-columns) + * [Result Columns](#result-columns) + * [Additional Query Options](#additional-query-options) ## Query View @@ -72,7 +72,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 8. **Run Query** Click to run the query. 9. **Query Results** - The results area displays selected columns of results retrieved by your query (see [below](../../../studio/database/queries/query-view.mdx#query-results)). + The results area displays selected columns of results retrieved by your query (see [below](#query-results)). ## Query Results @@ -112,7 +112,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to expand or collapse the results view. ### Select Visible Columns -To modify the displayed result columns, open the Display drop-down dialog from the [Query Results](../../../studio/database/queries/query-view.mdx#query-results) view. +To modify the displayed result columns, open the Display drop-down dialog from the [Query Results](#query-results) view. Custom result columns can be added, edited and removed. ![Display Dialog](./assets/query-view-display-dialog.png) diff --git a/versioned_docs/version-6.2/studio/database/queries/spatial-queries-map-view.mdx b/versioned_docs/version-6.2/studio/database/queries/spatial-queries-map-view.mdx index 9db1b24bd8..41a4f0c3d3 100644 --- a/versioned_docs/version-6.2/studio/database/queries/spatial-queries-map-view.mdx +++ b/versioned_docs/version-6.2/studio/database/queries/spatial-queries-map-view.mdx @@ -29,13 +29,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Spatial data in documents](../../../studio/database/queries/spatial-queries-map-view.mdx#spatial-data-in-documents) - * [Running a dynamic spatial query](../../../studio/database/queries/spatial-queries-map-view.mdx#running-a-dynamic-spatial-query) - * [Spatial map view](../../../studio/database/queries/spatial-queries-map-view.mdx#spatial-map-view) - * [Examples](../../../studio/database/queries/spatial-queries-map-view.mdx#examples) - * [Circular region example](../../../studio/database/queries/spatial-queries-map-view.mdx#circular-region-example) - * [Polygonal region example](../../../studio/database/queries/spatial-queries-map-view.mdx#polygonal-region-example) - * [Mixed shapes intersection example](../../../studio/database/queries/spatial-queries-map-view.mdx#mixed-shapes-intersection-example) + * [Spatial data in documents](#spatial-data-in-documents) + * [Running a dynamic spatial query](#running-a-dynamic-spatial-query) + * [Spatial map view](#spatial-map-view) + * [Examples](#examples) + * [Circular region example](#circular-region-example) + * [Polygonal region example](#polygonal-region-example) + * [Mixed shapes intersection example](#mixed-shapes-intersection-example) ## Spatial data in documents diff --git a/versioned_docs/version-6.2/studio/database/settings/client-configuration-per-database.mdx b/versioned_docs/version-6.2/studio/database/settings/client-configuration-per-database.mdx index 43ccfcfdbe..5ac9df693b 100644 --- a/versioned_docs/version-6.2/studio/database/settings/client-configuration-per-database.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/client-configuration-per-database.mdx @@ -29,7 +29,7 @@ import Panel from '@site/src/components/Panel'; For example, adjusting load balancing behavior on the fly in response to changing system demands. * In this article: - * [Set the client configuration (for database)](../../../studio/database/settings/client-configuration-per-database.mdx#set-the-client-configuration-for-database) + * [Set the client configuration (for database)](#set-the-client-configuration-for-database) diff --git a/versioned_docs/version-6.2/studio/database/settings/conflict-resolution.mdx b/versioned_docs/version-6.2/studio/database/settings/conflict-resolution.mdx index a1da5dda08..83e548afca 100644 --- a/versioned_docs/version-6.2/studio/database/settings/conflict-resolution.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/conflict-resolution.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Conflicts that are created can be manually resolved in [Documents Conflicts View](../../../studio/database/documents/conflicts-view.mdx). * In this page: - * [The Conflicts Resolution View](../../../studio/database/settings/conflict-resolution.mdx#the-conflicts-resolution-view) - * [Script Examples](../../../studio/database/settings/conflict-resolution.mdx#script-examples) + * [The Conflicts Resolution View](#the-conflicts-resolution-view) + * [Script Examples](#script-examples) ## The Conflicts Resolution View diff --git a/versioned_docs/version-6.2/studio/database/settings/custom-analyzers.mdx b/versioned_docs/version-6.2/studio/database/settings/custom-analyzers.mdx index 4e4677017c..a231e737f1 100644 --- a/versioned_docs/version-6.2/studio/database/settings/custom-analyzers.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/custom-analyzers.mdx @@ -29,10 +29,10 @@ that come with RavenDB out of the box. It can then be selected when configuring [index field options](../../../studio/database/indexes/create-map-index.mdx#index-field-options). * These views allow you to write your own custom analyzers: - * [Database Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#database-custom-analyzer-view) - * [Server-Wide Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#server-wide-custom-analyzer-view) - * [Edit Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view) - * [Change the Default Analyzers](../../../studio/database/settings/custom-analyzers.mdx#change-the-default-analyzers) + * [Database Custom Analyzer View](#database-custom-analyzer-view) + * [Server-Wide Custom Analyzer View](#server-wide-custom-analyzer-view) + * [Edit Custom Analyzer View](#edit-custom-analyzer-view) + * [Change the Default Analyzers](#change-the-default-analyzers) ## Database Custom Analyzer View @@ -40,9 +40,9 @@ that come with RavenDB out of the box. It can then be selected when configuring ![Figure 1. Database Custom Analyzer View](./assets/custom-analyzer-1.png) -1. Create a new database custom analyzer. Takes you to the analyzer editing view, see [below](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view). +1. Create a new database custom analyzer. Takes you to the analyzer editing view, see [below](#edit-custom-analyzer-view). 2. Edit an existing analyzer. -3. Go to the Server-Wide Custom Analyzer View, see [below](../../../studio/database/settings/custom-analyzers.mdx#server-wide-custom-analyzer-view). +3. Go to the Server-Wide Custom Analyzer View, see [below](#server-wide-custom-analyzer-view). @@ -58,7 +58,7 @@ The database custom analyzer will be the one used by indexes of this database. 1. Create a new server-wide custom analyzer. Takes you to the analyzer editing view, see -[below](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view). +[below](#edit-custom-analyzer-view). 2. Edit an existing analyzer. diff --git a/versioned_docs/version-6.2/studio/database/settings/custom-sorters.mdx b/versioned_docs/version-6.2/studio/database/settings/custom-sorters.mdx index 3364680b36..cb8dd8e29f 100644 --- a/versioned_docs/version-6.2/studio/database/settings/custom-sorters.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/custom-sorters.mdx @@ -30,10 +30,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Once deployed, you can order your query results using the custom sorter. A query example is available [here](../../../client-api/session/querying/sort-query-results.mdx#custom-sorters). * In this page: - * [Database custom sorter view](../../../studio/database/settings/custom-sorters.mdx#database-custom-sorter-view) - * [Server-wide custom sorter view](../../../studio/database/settings/custom-sorters.mdx#server-wide-custom-sorter-view) - * [Add a custom sorter](../../../studio/database/settings/custom-sorters.mdx#add-a-custom-sorter) - * [Test the custom sorter](../../../studio/database/settings/custom-sorters.mdx#test-the-custom-sorter) + * [Database custom sorter view](#database-custom-sorter-view) + * [Server-wide custom sorter view](#server-wide-custom-sorter-view) + * [Add a custom sorter](#add-a-custom-sorter) + * [Test the custom sorter](#test-the-custom-sorter) ## Database custom sorter view @@ -45,12 +45,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Navigate to __Settings > Custom Sorters__. 2. Click to add a new database custom sorter. - See the sorter edit view [below](../../../studio/database/settings/custom-sorters.mdx#add-a-custom-sorter). + See the sorter edit view [below](#add-a-custom-sorter). 3. The custom sorters deployed for this __database__ are listed here. 4. Click to test this custom sorter. - See the test view [below](../../../studio/database/settings/custom-sorters.mdx#test-the-custom-sorter). + See the test view [below](#test-the-custom-sorter). 5. Click to edit this custom sorter. @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Navigate to __Manage Server > Server-Wide Sorters__. 2. Click to add a new server-wide custom sorter. - See the sorter edit view [below](../../../studio/database/settings/custom-sorters.mdx#add-a-custom-sorter). + See the sorter edit view [below](#add-a-custom-sorter). 3. The custom sorters deployed __server-wide__ are listed here. diff --git a/versioned_docs/version-6.2/studio/database/settings/database-record.mdx b/versioned_docs/version-6.2/studio/database/settings/database-record.mdx index 6864638db1..b036d427aa 100644 --- a/versioned_docs/version-6.2/studio/database/settings/database-record.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/database-record.mdx @@ -24,8 +24,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Database Record is Not editable * In this page: - * [The Database Record](../../../studio/database/settings/database-record.mdx#the-database-record) - * [The Database Record Fields](../../../studio/database/settings/database-record.mdx#the-database-record-fields) + * [The Database Record](#the-database-record) + * [The Database Record Fields](#the-database-record-fields) diff --git a/versioned_docs/version-6.2/studio/database/settings/database-settings.mdx b/versioned_docs/version-6.2/studio/database/settings/database-settings.mdx index 3266d35eb7..339f89a6dc 100644 --- a/versioned_docs/version-6.2/studio/database/settings/database-settings.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/database-settings.mdx @@ -20,17 +20,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; To edit a server-scope key follow any of the available options listed in the [Configuration overview](../../../server/configuration/configuration-options.mdx) article. * After editing & saving a configuration key, the change does not take effect - until the database is [reloaded](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + until the database is [reloaded](#how-to-reload-the-database). Do not modify the database settings unless you are an expert and know what you're doing. * In this page: - * [View Database Settings](../../../studio/database/settings/database-settings.mdx#view-database-settings) - * [Edit Database Settings](../../../studio/database/settings/database-settings.mdx#edit-database-settings) - * [Database Settings View with Pending Values](../../../studio/database/settings/database-settings.mdx#database-settings-view-with-pending-values) - * [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database) + * [View Database Settings](#view-database-settings) + * [Edit Database Settings](#edit-database-settings) + * [Database Settings View with Pending Values](#database-settings-view-with-pending-values) + * [How to Reload the Database](#how-to-reload-the-database) ## View Database Settings @@ -39,7 +39,7 @@ Do not modify the database settings unless you are an expert and know what you'r 1. Navigate to **Settings > Database Settings**. 2. Type a keyword here to filter the configuration keys. -3. Click on **Edit** to access the database setting editing view. [See next section](../../../studio/database/settings/database-settings.mdx#edit-database-settings). +3. Click on **Edit** to access the database setting editing view. [See next section](#edit-database-settings). 4. This column lists the **Configuration Keys**. * A 'yellow' entry is a key whose value was customized by the user. * A 'green' entry is a key holding a default value that was not modified. @@ -62,7 +62,7 @@ Do not modify the database settings unless you are an expert and know what you'r * Once you save the changes made in this view, all modifications are saved into the [database record](../../../studio/database/settings/database-record.mdx). However, in order for those changes to be in effect, the database must be reloaded. - See [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + See [How to Reload the Database](#how-to-reload-the-database). ![Figure 2: Edit Database Settings](./assets/database-settings-2.png) @@ -82,7 +82,7 @@ Do not modify the database settings unless you are an expert and know what you'r All changes will immediately be written to the database record. However, in this view, the changes will appear as pending and will not be in effect until the database is reloaded. - See [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + See [How to Reload the Database](#how-to-reload-the-database). ### Database Settings View with Pending Values diff --git a/versioned_docs/version-6.2/studio/database/settings/document-revisions.mdx b/versioned_docs/version-6.2/studio/database/settings/document-revisions.mdx index 2cdb259b9a..040f439807 100644 --- a/versioned_docs/version-6.2/studio/database/settings/document-revisions.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/document-revisions.mdx @@ -19,13 +19,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about revisions [here](../../../document-extensions/revisions/overview.mdx). * In this page: - * [Document revisions view](../../../studio/database/settings/document-revisions.mdx#document-revisions-view) - * [Revisions configuration](../../../studio/database/settings/document-revisions.mdx#revisions-configuration) - * [Define default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) - * [Define collection-specific configuration](../../../studio/database/settings/document-revisions.mdx#define-collection-specific-configuration) - * [Edit conflicting document defaults](../../../studio/database/settings/document-revisions.mdx#edit-conflicting-document-defaults) - * [Conflicting documents example](../../../studio/database/settings/document-revisions.mdx#conflicting-documents-example) - * [Enforce configuration](../../../studio/database/settings/document-revisions.mdx#enforce-configuration) + * [Document revisions view](#document-revisions-view) + * [Revisions configuration](#revisions-configuration) + * [Define default configuration](#define-default-configuration) + * [Define collection-specific configuration](#define-collection-specific-configuration) + * [Edit conflicting document defaults](#edit-conflicting-document-defaults) + * [Conflicting documents example](#conflicting-documents-example) + * [Enforce configuration](#enforce-configuration) @@ -50,7 +50,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Only documents are reverted. Other entities (such as ongoing tasks) are not modified by this process. 5. **Enforce Configuration** - Click to [enforce the revisions configuration](../../../studio/database/settings/document-revisions.mdx#enforce-configuration). + Click to [enforce the revisions configuration](#enforce-configuration). This operation may delete many revisions irrevocably and require substantial server resources. @@ -58,16 +58,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; 6. **Create document defaults** - Click to define [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) + Click to define [default configuration](#define-default-configuration) that will apply to documents in all collections that don't have a collection-specific configuration defined. 7. **Add a collection-specific configuration** - Click to create a [configuration for a specific collection](../../../studio/database/settings/document-revisions.mdx#define-collection-specific-configuration). + Click to create a [configuration for a specific collection](#define-collection-specific-configuration). If default settings were defined, the collection-specific configuration will override them for this collection. 8. **The defined Revisions configuration** - Read more [below](../../../studio/database/settings/document-revisions.mdx#revisions-configuration). + Read more [below](#revisions-configuration). @@ -86,7 +86,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Defined Configuration](./assets/defined-configuration.png) 1. **Document Defaults** - This is the [default revisions configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) that applies to all non-conflicting documents in all collections + This is the [default revisions configuration](#define-default-configuration) that applies to all non-conflicting documents in all collections that don't have a collection-specific configuration defined. These settings are optional and can be removed. @@ -95,7 +95,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; When enabled, a revision is created for each conflicting item. A revision is also created for the conflict resolution document. * The Conflicting Document Defaults configuration cannot be removed. - * You can [modify](../../../studio/database/settings/document-revisions.mdx#edit-conflicting-document-defaults) this configuration, + * You can [modify](#edit-conflicting-document-defaults) this configuration, or disable it if not interested in tracking document conflicts using revisions. * When "Document Defaults configuration" is defined, it __overrides__ these conflict defaults. * When a "Collection-specific configuration" is defined, @@ -177,7 +177,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Select Collection](./assets/select-collection.png) 3. **Configuration options** - These options are similar to those explained above for the [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration), + These options are similar to those explained above for the [default configuration](#define-default-configuration), the only difference is the configuration scope. 4. Click __OK__ to keep the configuration, or __Cancel__. @@ -198,7 +198,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Editing the Conflicting Document Defaults](./assets/edit-conflicting-docs-configuration.png) -* The settings options are similar to those explained above for the [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration). +* The settings options are similar to those explained above for the [default configuration](#define-default-configuration). * Note: the __Limit # of revisions to keep by age__ value is set to `45 Days` by default. This means that revisions created for conflicting documents will start to be purged after 45 days, diff --git a/versioned_docs/version-6.2/studio/database/settings/documents-compression.mdx b/versioned_docs/version-6.2/studio/database/settings/documents-compression.mdx index 9ae3e806f5..03b12fc031 100644 --- a/versioned_docs/version-6.2/studio/database/settings/documents-compression.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/documents-compression.mdx @@ -35,7 +35,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To see the contents and size details of your database storage go to the [Storage Report](../../../studio/database/stats/storage-report.mdx) view in the Studio. * In this page: - * [Set documents compression from Studio](../../../studio/database/settings/documents-compression.mdx#set-documents-compression-from-studio) + * [Set documents compression from Studio](#set-documents-compression-from-studio) ## Set documents compression from Studio diff --git a/versioned_docs/version-6.2/studio/database/settings/integrations.mdx b/versioned_docs/version-6.2/studio/database/settings/integrations.mdx index ba6ac46bea..1867f4fcc3 100644 --- a/versioned_docs/version-6.2/studio/database/settings/integrations.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/integrations.mdx @@ -22,7 +22,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Secure Server](../../../start/installation/setup-wizard/choose-security-option.mdx). * In this page: - * [Integrations View](../../../studio/database/settings/integrations.mdx#integrations-view) + * [Integrations View](#integrations-view) ## Integrations View diff --git a/versioned_docs/version-6.2/studio/database/settings/manage-database-group.mdx b/versioned_docs/version-6.2/studio/database/settings/manage-database-group.mdx index c90c832933..9fb4b730ea 100644 --- a/versioned_docs/version-6.2/studio/database/settings/manage-database-group.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/manage-database-group.mdx @@ -38,10 +38,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Note 2: Although not all nodes in the cluster belong to the Database Group, each node in the cluster _has_ a full copy of _all_ Database Group Topologies. * In this page: - * [Database Group Topology - View](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---view) - * [Database Group Topology - Actions](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---actions) - * [Database Group Topology - Add New Node](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---add-new-node) - * [Database Group Topology - Members Duties](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---members-duties) + * [Database Group Topology - View](#database-group-topology---view) + * [Database Group Topology - Actions](#database-group-topology---actions) + * [Database Group Topology - Add New Node](#database-group-topology---add-new-node) + * [Database Group Topology - Members Duties](#database-group-topology---members-duties) ## Database Group Topology - View @@ -72,7 +72,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The order of the nodes is relevant for the client, as it selects which node to contact from this list. Click this button to reorder the nodes order. -2. **Add a Node to the database group** - See [below](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---add-new-node) +2. **Add a Node to the database group** - See [below](#database-group-topology---add-new-node) 3. **Settings** Open settings to set ***Dynamic Database Distribution*** @@ -105,7 +105,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Check the 'Choose preferred mentor node manually' checkbox in order to specify which node will be the preferred mentor for the newly added node. If not checked, then any one of the already existing Member nodes in the group will become the mentor node. The preferred mentor will be responsible for updating the new node with all the database data and its state. - See [Members Duties](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---members-duties) + See [Members Duties](#database-group-topology---members-duties) diff --git a/versioned_docs/version-6.2/studio/database/settings/studio-configuration.mdx b/versioned_docs/version-6.2/studio/database/settings/studio-configuration.mdx index 396c05908c..97d3732f2a 100644 --- a/versioned_docs/version-6.2/studio/database/settings/studio-configuration.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/studio-configuration.mdx @@ -24,16 +24,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -[Studio Configuration - Single Database](../../../studio/database/settings/studio-configuration.mdx#studio-configuration---single-database) +[Studio Configuration - Single Database](#studio-configuration---single-database) -* [Database Studio Configuration View](../../../studio/database/settings/studio-configuration.mdx#database-studio-configuration-view) -* [Disabling Auto-Index Creation on Studio Queries or Patches](../../../studio/database/settings/studio-configuration.mdx#disabling-auto-index-creation-on-studio-queries-or-patches) - * [About Auto-Index Creation](../../../studio/database/settings/studio-configuration.mdx#about-auto-indexes-and-the-studio) +* [Database Studio Configuration View](#database-studio-configuration-view) +* [Disabling Auto-Index Creation on Studio Queries or Patches](#disabling-auto-index-creation-on-studio-queries-or-patches) + * [About Auto-Index Creation](#about-auto-indexes-and-the-studio) * [If Disabled, Temporarily Enable Auto-Index Creation](../../../studio/database/settings/studio-configuration.mdx#if-disabled,-temporarily-enable-auto-index-creation) -[Studio Configuration - Server-wide](../../../studio/database/settings/studio-configuration.mdx#studio-configuration---server-wide) +[Studio Configuration - Server-wide](#studio-configuration---server-wide) -* [Server Studio Configuration View](../../../studio/database/settings/studio-configuration.mdx#server-studio-configuration-view) +* [Server Studio Configuration View](#server-studio-configuration-view) diff --git a/versioned_docs/version-6.2/studio/database/settings/time-series-settings.mdx b/versioned_docs/version-6.2/studio/database/settings/time-series-settings.mdx index ed25bf6425..8cc2578835 100644 --- a/versioned_docs/version-6.2/studio/database/settings/time-series-settings.mdx +++ b/versioned_docs/version-6.2/studio/database/settings/time-series-settings.mdx @@ -36,11 +36,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; You can set a different retention period for each rollup so that you can delete the previous data after it has been summarized/aggregated. * In this page: - * [Rationale for Configuring Time Series Policies](../../../studio/database/settings/time-series-settings.mdx#rationale-for-configuring-time-series-policies) - * [Time Series Settings View](../../../studio/database/settings/time-series-settings.mdx#time-series-settings-view) - * [Defined Time Series Configurations](../../../studio/database/settings/time-series-settings.mdx#defined-time-series-configurations) - * [Add or Edit Time Series Configuration](../../../studio/database/settings/time-series-settings.mdx#add-or-edit-time-series-configuration) - * [Rollup Policies for Rollup Time Series](../../../studio/database/settings/time-series-settings.mdx#rollup-policies-for-rollup-time-series) + * [Rationale for Configuring Time Series Policies](#rationale-for-configuring-time-series-policies) + * [Time Series Settings View](#time-series-settings-view) + * [Defined Time Series Configurations](#defined-time-series-configurations) + * [Add or Edit Time Series Configuration](#add-or-edit-time-series-configuration) + * [Rollup Policies for Rollup Time Series](#rollup-policies-for-rollup-time-series) ## Rationale for Configuring Time Series Policies @@ -113,7 +113,7 @@ Here are the different levels of resolution that they want to see: 2 seconds will still be checked and executed every 8 seconds. 4. **Defined Time Series Configurations** - View and manage the time series configurations that were already defined (read more [below](../../../studio/database/settings/time-series-settings.mdx#defined-time-series-configurations)). + View and manage the time series configurations that were already defined (read more [below](#defined-time-series-configurations)). 5. **Add or Edit time series configurations** * Click the **Add a collection-specific configuration** button to create a new configuration. * Click a defined configuration **Edit** button to edit an existing configuration. @@ -130,11 +130,11 @@ Here are the different levels of resolution that they want to see: Check to select/deselect this configuration. Rollup and Retention policies for selected configurations can be enabled or disabled using the - [time series settings view](../../../studio/database/settings/time-series-settings.mdx#time-series-settings-view) **Set Status** button. + [time series settings view](#time-series-settings-view) **Set Status** button. 2. **Enable/Disable Configuration** Click to enable or disable Rollup and Retention policies for this configuration. 3. **Edit** - Click to [edit this configuration](../../../studio/database/settings/time-series-settings.mdx#add-or-edit-time-series-configuration). + Click to [edit this configuration](#add-or-edit-time-series-configuration). 4. **Remove** Click to remove this configuration. !["Defined Time Series Configurations - Info"](./assets/time-series-settings-04_per-collection-configuration-info.png) @@ -225,7 +225,7 @@ Here are the different levels of resolution that they want to see: Rollup policies can be defined both for **raw time series data** and for **rollup time series**. - Read more [here](../../../studio/database/settings/time-series-settings.mdx#rollup-policies-for-rollup-time-series). + Read more [here](#rollup-policies-for-rollup-time-series). In the above image, the rollup policy aggregates the **raw data** of the selected collection's time series, into **new** rollup time series. diff --git a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx index 8e933bbf46..c9d10f8c03 100644 --- a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The data shown in the graph will be either 'Outgoing' or 'Incoming', depending on whether the source or the target database is viewed. * In this page: - * [External Replication Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx#external-replication-stats-closed-view) - * [External Replication Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx#external-replication-stats-expanded-view) + * [External Replication Stats Closed View](#external-replication-stats-closed-view) + * [External Replication Stats Expanded View](#external-replication-stats-expanded-view) ## External Replication Stats diff --git a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx index 08a7036c11..970d62640d 100644 --- a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the OLAP ETL task [here](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx). * In this page: - * [OLAP ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx#olap-etl-stats-closed-view) - * [OLAP ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx#olap-etl-stats-expanded-view) + * [OLAP ETL Stats Closed View](#olap-etl-stats-closed-view) + * [OLAP ETL Stats Expanded View](#olap-etl-stats-expanded-view) ## OLAP ETL Stats diff --git a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/overview.mdx b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/overview.mdx index 8b8411c8af..530f4d3223 100644 --- a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/overview.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/overview.mdx @@ -23,13 +23,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Tasks activities are graphically displayed for selected time frames. * In this page: - * [Ongoing Tasks Stats View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#ongoing-tasks-stats-view) - * [The Timeline Ruler](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#the-timeline-ruler) - * [Task Rulers](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-rulers) - * [Closed View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-ruler-closed-view) - * [Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-ruler-expanded-view) - * [Time Grid](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-rulers-time-grid) - * [Active and Inactive Display](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#active-and-inactive-display) + * [Ongoing Tasks Stats View](#ongoing-tasks-stats-view) + * [The Timeline Ruler](#the-timeline-ruler) + * [Task Rulers](#task-rulers) + * [Closed View](#task-ruler-closed-view) + * [Expanded View](#task-ruler-expanded-view) + * [Time Grid](#task-rulers-time-grid) + * [Active and Inactive Display](#active-and-inactive-display) ## Ongoing Tasks Stats View @@ -127,10 +127,10 @@ during the time specified by the timeline ruler above. A grid of vertical time lines allows you to easily relate task events to their time of occurence. -Note that the [stats graph](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#stats-graph) +Note that the [stats graph](#stats-graph) displays **two different time grids**. -* The [Timeline ruler time grid](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#the-timeline-ruler) +* The [Timeline ruler time grid](#the-timeline-ruler) shows time points across the entire timeline ruler line. * The Task rulers time grid, discussed here, shows points of time **within the selected time frame**. diff --git a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx index 10b6447eb2..37a840d5ea 100644 --- a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the RavenDB ETL task [here](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx). * In this page: - * [RavenDB ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx#ravendb-etl-stats-closed-view) - * [RavenDB ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx#ravendb-etl-stats-expanded-view) + * [RavenDB ETL Stats Closed View](#ravendb-etl-stats-closed-view) + * [RavenDB ETL Stats Expanded View](#ravendb-etl-stats-expanded-view) ## RavenDB ETL Stats diff --git a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx index c06ff9c3a5..e15d463e7a 100644 --- a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the SQL ETL task [here](../../../../server/ongoing-tasks/etl/sql.mdx). * In this page: - * [SQL ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx#sql-etl-stats-closed-view) - * [SQL ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx#sql-etl-stats-expanded-view) + * [SQL ETL Stats Closed View](#sql-etl-stats-closed-view) + * [SQL ETL Stats Expanded View](#sql-etl-stats-expanded-view) ## SQL ETL Stats diff --git a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx index 620a09fb38..042a5f42c8 100644 --- a/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about data subscription tasks [here](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx). * In this page: - * [Subscription Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#subscription-stats-closed-view) - * [Subscription Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#subscription-stats-expanded-view) - * [Connection Event Indicators](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#connection-event-indicators) + * [Subscription Stats Closed View](#subscription-stats-closed-view) + * [Subscription Stats Expanded View](#subscription-stats-expanded-view) + * [Connection Event Indicators](#connection-event-indicators) ## Subscription Stats diff --git a/versioned_docs/version-6.2/studio/database/stats/storage-report.mdx b/versioned_docs/version-6.2/studio/database/stats/storage-report.mdx index 94ce706d38..0796fcaa19 100644 --- a/versioned_docs/version-6.2/studio/database/stats/storage-report.mdx +++ b/versioned_docs/version-6.2/studio/database/stats/storage-report.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Refresh the page to see the effect of [Documents Compression](../../../server/storage/documents-compression.mdx) and [Database Compaction](../../../client-api/operations/server-wide/compact-database.mdx). * In this page: - * [Database storage report](../../../studio/database/stats/storage-report.mdx#database-storage-report) + * [Database storage report](#database-storage-report) ## Database storage report diff --git a/versioned_docs/version-6.2/studio/database/tasks/backup-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/backup-task.mdx index b6e1889e24..3dc1d779b4 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/backup-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/backup-task.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; [restore](../../../studio/database/create-new-database/from-backup.mdx) your database from that point. Learn more in [Backup Overview](../../../server/ongoing-tasks/backup-overview.mdx). -* This Studio view enables you to create ongoing [periodic backup tasks](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation), +* This Studio view enables you to create ongoing [periodic backup tasks](#periodic-backup-creation), as well as one-time - [manual backups](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups), for a particular database. + [manual backups](#manually-creating-one-time-backups), for a particular database. It also enables **server-wide backups** which can back up all of the databases on one server/node. See [Studio: Server-Wide Backups](../../../studio/server/server-wide-backup.mdx) to learn more. @@ -31,22 +31,22 @@ import LanguageContent from "@site/src/components/LanguageContent"; Read about backups on a sharded database [in the section dedicated to it](../../../sharding/backup-and-restore/backup.mdx). * A backup is _not equivalent_ to replicating your data, as explained below in - [Backup -vs- Replication](../../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task). + [Backup -vs- Replication](#backup-task--vs--replication-task). * To check what data different backup types save, see the [backup overview article](../../../server/ongoing-tasks/backup-overview.mdx). * In this page: - * [Backups View](../../../studio/database/tasks/backup-task.mdx#backups-view) - * [Periodic Backup Creation](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation) - * [Scheduling Backups](../../../studio/database/tasks/backup-task.mdx#scheduling-backups) - * [Retention Policy](../../../studio/database/tasks/backup-task.mdx#retention-policy) - * [Backup Encryption](../../../studio/database/tasks/backup-task.mdx#backup-encryption) - * [Destination](../../../studio/database/tasks/backup-task.mdx#destination) - * [Periodic Backup Details](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details) - * [Manually Creating One-Time Backups](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups) - * [Delaying a Running Backup Task](../../../studio/database/tasks/backup-task.mdx#delaying-a-running-backup-task) - * [When the Cluster or Node is Down](../../../studio/database/tasks/backup-task.mdx#when-the-cluster-or-node-is-down) - * [Backup Task -vs- Replication Task](../../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task) + * [Backups View](#backups-view) + * [Periodic Backup Creation](#periodic-backup-creation) + * [Scheduling Backups](#scheduling-backups) + * [Retention Policy](#retention-policy) + * [Backup Encryption](#backup-encryption) + * [Destination](#destination) + * [Periodic Backup Details](#periodic-backup-details) + * [Manually Creating One-Time Backups](#manually-creating-one-time-backups) + * [Delaying a Running Backup Task](#delaying-a-running-backup-task) + * [When the Cluster or Node is Down](#when-the-cluster-or-node-is-down) + * [Backup Task -vs- Replication Task](#backup-task--vs--replication-task) ## Backups View @@ -56,9 +56,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. **Go to Studio Backups View** To back up your database or server, click on the **Tasks** tab then **Backups**. 2. **Create a Periodic Backup** - To schedule [automatic, recurrent backups](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation). + To schedule [automatic, recurrent backups](#periodic-backup-creation). 3. **Create a Manual Backup** - For a [one-time backup](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups). + For a [one-time backup](#manually-creating-one-time-backups). 4. **Restore a database from a backup** To [restore a database](../../../studio/database/create-new-database/from-backup.mdx) from a previously created backup. 5. **Go to Server Wide Tasks View** to [back up all of the databases](../../../studio/server/server-wide-backup.mdx) on this server. @@ -74,9 +74,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Periodic Backup View](./assets/Periodic-backup-task-view.png) 1. **Create a periodic backup task** - To schedule [automatic, recurrent backups](../../../studio/database/tasks/backup-task.mdx#creating-periodic-backups). - 2. [View Details of periodic backup](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details) tasks - * [Backup Now](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details) (e.g. before software updates) can be triggered in the 'View Details' interface. + To schedule [automatic, recurrent backups](#creating-periodic-backups). + 2. [View Details of periodic backup](#periodic-backup-details) tasks + * [Backup Now](#periodic-backup-details) (e.g. before software updates) can be triggered in the 'View Details' interface. 3. **Edit** this database backup task. To edit server/node-wide backup tasks, see button #5. 4. **Delete** this periodic backup task. 5. **Go to the server-wide backups view** to [back up all databases on the server](../../../studio/server/server-wide-backup.mdx). @@ -245,9 +245,9 @@ Make sure to save the destinations and credentials information so that your team ![Manual Backup View](./assets/manual-backup-task-view.png) - 1. Create a one-time [manual backup](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups). + 1. Create a one-time [manual backup](#manually-creating-one-time-backups). This can be vital before upgrading or whenever you want an unscheduled backup. - 2. Unscheduled backups (e.g. before upgrades) can also be done in the [periodic backup details view](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details). + 2. Unscheduled backups (e.g. before upgrades) can also be done in the [periodic backup details view](#periodic-backup-details). If you've selected 'manual backup', the following screen will open. @@ -256,7 +256,7 @@ If you've selected 'manual backup', the following screen will open. 1. **Backup Type**. * "Snapshot" saves the entire database and its indexes. * "Backup" saves the data, but only index definitions. -2. **Encryption** - See [Backup Encryption](../../../studio/database/tasks/backup-task.mdx#backup-encryption). +2. **Encryption** - See [Backup Encryption](#backup-encryption). 3. **Destination** for backup to be stored. Click **Backup Now** to finish the process. @@ -267,7 +267,7 @@ Manual backups have only some of the properties of periodic backups: * The backup can be _full_ or _snapshot_. * The backup can be encrypted or not. -* The backup must have a [destination](../../../studio/database/tasks/backup-task.mdx#destination). +* The backup must have a [destination](#destination). There are also some important differences: @@ -289,8 +289,8 @@ The execution of a running backup task can be **delayed** for a given time perio * All scheduled executions of the task during the delay period are cancelled. Delaying a running backup operation is only available for - [periodic backup tasks](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation). - A [one-time backup operation](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups) + [periodic backup tasks](#periodic-backup-creation). + A [one-time backup operation](#manually-creating-one-time-backups) cannot be delayed. * When the delay period has passed, the backup operation is executed diff --git a/versioned_docs/version-6.2/studio/database/tasks/create-sample-data.mdx b/versioned_docs/version-6.2/studio/database/tasks/create-sample-data.mdx index 27d2756ce8..fe5b17edf2 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/create-sample-data.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/create-sample-data.mdx @@ -23,8 +23,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; Creating it will enable you to play with the data as you use the documentation to familiarize yourself with RavenDB features. * In this page: - * [Create Sample Data](../../../studio/database/tasks/create-sample-data.mdx#create-sample-data) - * [The Data Generated - Documents View](../../../studio/database/tasks/create-sample-data.mdx#the-data-generated---documents-view) + * [Create Sample Data](#create-sample-data) + * [The Data Generated - Documents View](#the-data-generated---documents-view) * [The C# Entities](../../../studio/database/tasks/create-sample-data.mdx#the-c#-entities) ## Create Sample Data diff --git a/versioned_docs/version-6.2/studio/database/tasks/export-database.mdx b/versioned_docs/version-6.2/studio/database/tasks/export-database.mdx index 8191aa63bf..defd050465 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/export-database.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/export-database.mdx @@ -25,8 +25,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; [section dedicated to this operation](../../../sharding/import-and-export.mdx#export). * In this page: - * [Export Database View](../../../studio/database/tasks/export-database.mdx#export-database-view) - * [Advanced Export Options](../../../studio/database/tasks/export-database.mdx#advanced-export-options) + * [Export Database View](#export-database-view) + * [Advanced Export Options](#advanced-export-options) ## Export Database View @@ -65,7 +65,7 @@ and export it to a `.ravendbdump` file. ![Provide Encryption Key](./assets/export-encryption-key.png) 7. **Advanced** - Click to display [advanced export settings](../../../studio/database/tasks/export-database.mdx#advanced-export-options). + Click to display [advanced export settings](#advanced-export-options). 8. **Export Database** Click to export the selected data to a `.ravendbdump` file. diff --git a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-data-file.mdx b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-data-file.mdx index 5fdb844150..4ec77c769f 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-data-file.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-data-file.mdx @@ -26,12 +26,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Import data to destination server from file](../../../../studio/database/tasks/import-data/import-data-file.mdx#import-data-to-destination-server-from-file) -* [Import options](../../../../studio/database/tasks/import-data/import-data-file.mdx#import-options) -* [Advanced import options](../../../../studio/database/tasks/import-data/import-data-file.mdx#advanced-import-options) - * [Transform Script](../../../../studio/database/tasks/import-data/import-data-file.mdx#transform-script) - * [Customize Configuration and Ongoing Tasks](../../../../studio/database/tasks/import-data/import-data-file.mdx#customize-configuration-and-ongoing-tasks) - * [Copy command as PowerShell](../../../../studio/database/tasks/import-data/import-data-file.mdx#copy-command-as-powershell) +* [Import data to destination server from file](#import-data-to-destination-server-from-file) +* [Import options](#import-options) +* [Advanced import options](#advanced-import-options) + * [Transform Script](#transform-script) + * [Customize Configuration and Ongoing Tasks](#customize-configuration-and-ongoing-tasks) + * [Copy command as PowerShell](#copy-command-as-powershell) @@ -54,7 +54,7 @@ If you have already [exported a database](../export-database.mdx), follow these 5. **Select file** Select the `.ravendbdump` file that you previously exported from the source server. 6. **Documents and Extensions** - Select desired [options](../../tasks/import-data/import-data-file.mdx#import-options). + Select desired [options](#import-options). *If you encrypted while exporting* make sure to select **imported file is encrypted**. You will need to paste the encryption key that you saved when creating the encrypted database. 7. **Advanced** diff --git a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-csv.mdx b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-csv.mdx index 973593140d..e9f74bee9d 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-csv.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-csv.mdx @@ -22,9 +22,9 @@ Because some CSV files are formatted differently, the RavenDB Studio enables you In this page: -* [What is CSV](../../../../studio/database/tasks/import-data/import-from-csv.mdx#what-is-csv) -* [How should I format my documents as CSV](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-should-i-format-my-documents-as-csv) -* [How to Import a CSV via RavenDB Studio](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-to-import-a-csv-via-ravendb-studio) +* [What is CSV](#what-is-csv) +* [How should I format my documents as CSV](#how-should-i-format-my-documents-as-csv) +* [How to Import a CSV via RavenDB Studio](#how-to-import-a-csv-via-ravendb-studio) @@ -189,6 +189,6 @@ Now that we've got a valid CSV file we can import it to RavenDB. 8. Select **Import Collection** After importing the CSV file, the resulting .json document should look like the document -[above](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-should-i-format-my-documents-as-csv). +[above](#how-should-i-format-my-documents-as-csv). diff --git a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-other.mdx b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-other.mdx index c231b07fa6..67c9791759 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-other.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-other.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Download Raven.Migrator Tool](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool) - * [Import from MongoDB](../../../../studio/database/tasks/import-data/import-from-other.mdx#import-from-mongodb) - * [Import from CosmosDB](../../../../studio/database/tasks/import-data/import-from-other.mdx#import-from-cosmosdb) + * [Download Raven.Migrator Tool](#download-ravenmigrator-tool) + * [Import from MongoDB](#import-from-mongodb) + * [Import from CosmosDB](#import-from-cosmosdb) @@ -47,7 +47,7 @@ In the RavenDB Studio client on the left side, select `Tasks` -> `Import Data ![Figure 1.](./assets/mongodb-1.png) 1. **Migrator Path** - * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** @@ -79,7 +79,7 @@ In the RavenDB Studio client on the left side, select `Tasks` -> `Import Data 1. **Migrator Path** - * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** diff --git a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-ravendb.mdx b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-ravendb.mdx index bcbad4f4e9..926ead1387 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-ravendb.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-ravendb.mdx @@ -147,7 +147,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; - [Include Identities](../../../../client-api/document-identifiers/working-with-document-identifiers.mdx) - [Include Compare Exchange](../../../../client-api/operations/compare-exchange/overview.mdx) - [Include Subscriptions](../../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) - - [Include Configuration and OngoingTasks](../../../../studio/database/tasks/import-data/import-from-ravendb.mdx#customize-configuration-and-ongoing-tasks) + - [Include Configuration and OngoingTasks](#customize-configuration-and-ongoing-tasks) diff --git a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-sql.mdx b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-sql.mdx index 9ac241e99b..935e5f24e8 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-sql.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/import-data/import-from-sql.mdx @@ -33,16 +33,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; Changes made while preparing the data model maintain data integrity and cohesion. * In this page: - * [Import Data From SQL Source](../../../../studio/database/tasks/import-data/import-from-sql.mdx#import-data-from-sql-source) - * [Create a New Import Configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) - * [Advanced Import Options](../../../../studio/database/tasks/import-data/import-from-sql.mdx#advanced-import-options) - * [Run an Existing Import Configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration) - * [SQL Migration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#sql-migration) - * [Data Conversion: General Settings](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) - * [Data Conversion: Table/Collection Settings](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-tablecollection-settings) - * [Filtering and Transforming Documents](../../../../studio/database/tasks/import-data/import-from-sql.mdx#filtering-and-transforming-documents) - * [Handling Relationships](../../../../studio/database/tasks/import-data/import-from-sql.mdx#handling-relationships) - * [Data integrity Helpers](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-integrity-helpers) + * [Import Data From SQL Source](#import-data-from-sql-source) + * [Create a New Import Configuration](#create-a-new-import-configuration) + * [Advanced Import Options](#advanced-import-options) + * [Run an Existing Import Configuration](#run-an-existing-import-configuration) + * [SQL Migration](#sql-migration) + * [Data Conversion: General Settings](#data-conversion-general-settings) + * [Data Conversion: Table/Collection Settings](#data-conversion-tablecollection-settings) + * [Filtering and Transforming Documents](#filtering-and-transforming-documents) + * [Handling Relationships](#handling-relationships) + * [Data integrity Helpers](#data-integrity-helpers) ## Import Data From SQL Source @@ -54,15 +54,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to import data. 3. **From SQL** Click to import data from an SQL source. -4. [Create new import configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) +4. [Create new import configuration](#create-a-new-import-configuration) Create a new import configuration from scratch. The configuration can be exported and reused. -5. [Continue existing migration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration) +5. [Continue existing migration](#run-an-existing-import-configuration) Run an existing import configuration. ### Create a New Import Configuration Use this option to enter a new import configuration. -The configuration can then be exported and [reused](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration). +The configuration can then be exported and [reused](#run-an-existing-import-configuration). ![Create New Import Configuration](./assets/sql-migration-create-new-import.png) @@ -82,10 +82,10 @@ The configuration can then be exported and [reused](../../../../studio/database/ Click the **Syntax** caption to display valid connection strings for the different SQL sources. -3. [Advanced](../../../../studio/database/tasks/import-data/import-from-sql.mdx#advanced-import-options) +3. [Advanced](#advanced-import-options) Click for advanced import options. -4. [Create new import](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +4. [Create new import](#data-conversion-general-settings) Click to connect the SQL source and import the database schema and data. 5. **Test Connection** @@ -127,7 +127,7 @@ you can locate and run it here. ![Use Existing Import Configuration](./assets/sql-migration-use-existing-configuration.png) 1. Click to locate an existing import configuration on the file system. -2. Click to [run the selected configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +2. Click to [run the selected configuration](#data-conversion-general-settings) and migrate data from the SQL source. @@ -145,7 +145,7 @@ In _NoSQL_, this can be modeled as a list of foreign object IDs and requires no ### Data Conversion: General Settings -When an [import configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) +When an [import configuration](#create-a-new-import-configuration) is executed RavenDB connects the SQL source, obtains information about database tables and keys, and displays the following view to allow the user to alter the migration and target documents structure. @@ -188,7 +188,7 @@ target documents structure. Please note that limiting the migration may break links between documents. -7. [Table/Collection Conversion Tuning](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-tablecollection-settings) +7. [Table/Collection Conversion Tuning](#data-conversion-tablecollection-settings) Specific details related to the transfer of each table can be altered as well. See additional details below. ### Data Conversion: Table/Collection Settings @@ -210,7 +210,7 @@ target documents structure. Click for details regarding each relationship, and to select whether to skip each relationship or embed it in the document. -5. [Filter/Transform](../../../../studio/database/tasks/import-data/import-from-sql.mdx#filtering-and-transforming-documents) +5. [Filter/Transform](#filtering-and-transforming-documents) Click to alter the **filter query** executed over the source database, and/or the **transform script** used to shape the imported data. @@ -240,7 +240,7 @@ Filtering the read data is gained by altering the query RavenDB runs over the SQL server to fetch the data. transforming written documents is done using a transform script through which all incoming data passes. -Learn [here](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +Learn [here](#data-conversion-general-settings) how to connect the source database and open the filter/transform dialog. ![Filter and Transform](./assets/sql-migration-filter-and-export-I.png) diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx index 7c717ee525..607320ad25 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx @@ -30,11 +30,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx) how to define an Azure Queue Storage ETL task using the Client API. * In this page: - * [Open Azure Queue Storage ETL task view](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#open-azure-queue-storage-etl-task-view) - * [Define Azure Queue Storage ETL task](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#define-azure-queue-storage-etl-task) - * [Authentication method](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#authentication-method) - * [Options per queue](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#options-per-queue) - * [Add transformation script](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#add-transformation-script) + * [Open Azure Queue Storage ETL task view](#open-azure-queue-storage-etl-task-view) + * [Define Azure Queue Storage ETL task](#define-azure-queue-storage-etl-task) + * [Authentication method](#authentication-method) + * [Options per queue](#options-per-queue) + * [Add transformation script](#add-transformation-script) ## Open Azure Queue Storage ETL task view @@ -72,7 +72,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Toggle OFF to select an existing connection string from the list, or toggle ON to create a new one. * **Name** - Enter a name for the connection string. * **Authentication method** - Select the authentication method by which to connect to an Azure storage account. - Learn more about the available authentication methods [below](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#authentication-method). + Learn more about the available authentication methods [below](#authentication-method). 5. **Test Connection** After defining the connection string, click to test the connection to the Azure storage account. @@ -82,7 +82,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to add a transformation script. 7. **Advanced** - Click to open the [advanced section](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#options-per-queue) where you can configure the deletion of RavenDB documents per queue. + Click to open the [advanced section](#options-per-queue) where you can configure the deletion of RavenDB documents per queue. diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx index 04625ff7ee..8820ac0d7d 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx @@ -24,14 +24,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; the client API in [Ongoing Tasks: Elasticsearch ETL](../../../../server/ongoing-tasks/etl/elasticsearch.mdx) * In this page: - * [Navigate to the Elasticsearch ETL Task View](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#navigate-to-the-elasticsearch-etl-task-view) - * [Define the Elasticsearch ETL Task](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#define-the-elasticsearch-etl-task) - * [Elasticsearch Indexes](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) - * [Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#transformation-script) - * [Add Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#add-transformation-script) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#edit-transformation-script) - * [Test Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#test-transformation-script) - * [Test Results](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#test-results) + * [Navigate to the Elasticsearch ETL Task View](#navigate-to-the-elasticsearch-etl-task-view) + * [Define the Elasticsearch ETL Task](#define-the-elasticsearch-etl-task) + * [Elasticsearch Indexes](#elasticsearch-indexes) + * [Transformation Script](#transformation-script) + * [Add Transformation Script](#add-transformation-script) + * [Edit Transformation Script](#edit-transformation-script) + * [Test Transformation Script](#test-transformation-script) + * [Test Results](#test-results) ## Navigate to the Elasticsearch ETL Task View @@ -179,7 +179,7 @@ Elasticsearch destination per RavenDB document from the selected collections. * Make sure that one of the properties of the document object is given the value `id(this)`. - The ETL task will use this property [to identify](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#document-id-property-name) + The ETL task will use this property [to identify](#document-id-property-name) documents that reside on the Elasticsearch destination by their source RavenDB document ID. @@ -201,10 +201,10 @@ Elasticsearch destination per RavenDB document from the selected collections. specified collections** the first time the task runs. * When this option is **disabled**: The script will be executed **only over new and modified documents**. - * If [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + * If [Insert Only](#elasticsearch-indexes) is **enabled**: RavenDB documents will be appended to Elasticsearch **without deleting documents from Elasticsearch first**. - * If [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + * If [Insert Only](#elasticsearch-indexes) is **disabled**: Documents will be **deleted from Elasticsearch first**, and then appended to it from RavenDB. @@ -244,7 +244,7 @@ The test results view displays a **preview** of the tested document, and the **c 3. [_delete_by_query](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html) Segment The delete POST command with a list of IDs by which Elasticsearch would locate and remove existing documents. - Deleting existing document versions is **optional**, enable [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + Deleting existing document versions is **optional**, enable [Insert Only](#elasticsearch-indexes) to prevent the task from sending `_delete_by_query` commands. 4. [_bulk ](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html) Segment The bulk POST command with a list of document objects, each with data extracted from RavenDB and an ID that Elasticsearch stores it by. diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/external-replication-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/external-replication-task.mdx index 4210f07382..1e7b8d6cb7 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/external-replication-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/external-replication-task.mdx @@ -26,7 +26,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; such as filtration and two-way (master-master) replication, consider [Hub/Sink Replication](../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx). * To replicate between two separate, secure RavenDB servers, - you need to [pass a client certificate](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#step-by-step-guide) from the source server to the destination. + you need to [pass a client certificate](#step-by-step-guide) from the source server to the destination. * External replication can be a comfortable means of data migration into a [sharded](../../../../sharding/overview.mdx) database. You can read more about this option in the sharding documentation [external replication](../../../../sharding/external-replication.mdx) and [migration](../../../../sharding/migration.mdx) sections. @@ -35,11 +35,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; See more in [Backup -vs- Replication](../../../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task) * In this page: - * [General Information about External Replication Task](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#general-information-about-external-replication-task) - * [Step-by-Step Guide](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#step-by-step-guide) - * [Definition](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition) - * [Details in Tasks List View](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#details-in-tasks-list-view) - * [Offline Behavior](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#offline-behavior) + * [General Information about External Replication Task](#general-information-about-external-replication-task) + * [Step-by-Step Guide](#step-by-step-guide) + * [Definition](#definition) + * [Details in Tasks List View](#details-in-tasks-list-view) + * [Offline Behavior](#offline-behavior) @@ -102,7 +102,7 @@ To explore this concept further, refer to the [Data Ownership in a Distributed S be sure that the target database is as well. ![Encrypted Logo](./assets/encrypted-logo.png) 3. **Define External Replication Task in the Source Database** - Learn more about [defining the task](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition) in the dedicated section. + Learn more about [defining the task](#definition) in the dedicated section. * **Optional Parameters** - Task Name - Delay Time @@ -167,7 +167,7 @@ f. Click **External Replication** to access the following interface. You can set multiple connection strings to multiple different nodes on different machines so that if one is down, the other can keep the destination updated. - See [Offline Behavior - When the destination node is down](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#offline-behavior). + See [Offline Behavior - When the destination node is down](#offline-behavior). If you define only one node's connection string, RavenDB will wait until that node is online and will then update any missing information. diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/general-info.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/general-info.mdx index 07b0e47cc4..b60f37891d 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/general-info.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/general-info.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and its responsible node executes the defined task work whenever relevant data changes occur. * In this page: - * [The ongoing tasks](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks) - * [The ongoing tasks list - View](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks-list---view) - * [The ongoing tasks list - Actions](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks-list---actions) + * [The ongoing tasks](#the-ongoing-tasks) + * [The ongoing tasks list - View](#the-ongoing-tasks-list---view) + * [The ongoing tasks list - Actions](#the-ongoing-tasks-list---actions) ## The ongoing tasks diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx index 99bba649c4..91e5ece3ad 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx @@ -25,22 +25,22 @@ and Sink replication tasks. * The connection is always initiated by the Sink, but you can choose whether to replicate data from *Hub to Sink* and/or from *Sink to Hub*. -* Replication can be [filtered](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) +* Replication can be [filtered](#filtered-replication) by both the Hub and the Sink, and for both *incoming* and *outgoing* documents, using wildcards and document IDs, to select the documents that would be replicated. -* The connection between Hub and Sink tasks is [secure](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#accesses-and-certificates), +* The connection between Hub and Sink tasks is [secure](#accesses-and-certificates), requiring a secure RavenDB cluster setup. A secure cluster can be raised using RavenDB's [setup wizard](../../../../../start/installation/setup-wizard/choose-security-option.mdx). * In this page: * [What is Hub/Sink Replication for?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-is-hub/sink-replication-for?) * [What is and is not replicated?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-is-and-is-not-replicated?) - * [Accesses and Certificates](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#accesses-and-certificates) - * [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) + * [Accesses and Certificates](#accesses-and-certificates) + * [Filtered Replication](#filtered-replication) * [What does the replication include?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-does-the-replication-include?) - * [Failover](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#failover) - * [Backward Compatibility](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#backward-compatibility) + * [Failover](#failover) + * [Backward Compatibility](#backward-compatibility) ## What is Hub/Sink Replication for? diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx index 9744353a68..57a0148c84 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx @@ -26,12 +26,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) to choose which documents are to be replicated * In this page: - * [Create an Ongoing Replication Hub Task](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#create-an-ongoing-replication-hub-task) - * [Hub Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#hub-configuration) - * [Access Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#access-configuration) - * [Viewing and Editing Existing Accesses](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#viewing-and-editing-existing-accesses) - * [Defining Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#defining-filtered-replication) - * [Ongoing Tasks View](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#ongoing-tasks-view) + * [Create an Ongoing Replication Hub Task](#create-an-ongoing-replication-hub-task) + * [Hub Configuration](#hub-configuration) + * [Access Configuration](#access-configuration) + * [Viewing and Editing Existing Accesses](#viewing-and-editing-existing-accesses) + * [Defining Filtered Replication](#defining-filtered-replication) + * [Ongoing Tasks View](#ongoing-tasks-view) ## Create an Ongoing Replication Hub Task diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx index bb5bf8fea2..8d6190e23c 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx @@ -26,12 +26,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) to choose which documents are to be replicated * In this page: - * [Create an Ongoing Replication Sink Task](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#create-an-ongoing-replication-sink-task) - * [Import Configuration From Hub](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#import-configuration-from-hub) - * [Sink Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#sink-configuration) - * [Access Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#access-configuration) - * [Definining Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#defining-filtered-replication) - * [Ongoing Tasks View](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#ongoing-tasks-view) + * [Create an Ongoing Replication Sink Task](#create-an-ongoing-replication-sink-task) + * [Import Configuration From Hub](#import-configuration-from-hub) + * [Sink Configuration](#sink-configuration) + * [Access Configuration](#access-configuration) + * [Definining Filtered Replication](#defining-filtered-replication) + * [Ongoing Tasks View](#ongoing-tasks-view) ## Create an Ongoing Replication Sink Task @@ -112,7 +112,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. **Certificate Source** Choose a source for the Sink certificate. - ([Import Hub configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#import-configuration-from-hub) + ([Import Hub configuration](#import-configuration-from-hub) to save yourself the need to redefine these details.) * **Provide your own certificate** Use this option to import a certificate of your own, e.g. one diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx index d9d4aeac41..832855d924 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx @@ -33,17 +33,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx) how to define a Kafka ETL task using code. * In this article: - * [Setup workflow](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#setup-workflow) - * [Creating a Kafka ETL task](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#creating-a-kafka-etl-task) - * [Open Kafka ETL Task View](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#open-kafka-etl-task-view) - * [Define Kafka ETL Task](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#define-kafka-etl-task) - * [Use RavenDB Certificate](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#use-ravendb-certificate) - * [Options Per Topic](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#options-per-topic) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#edit-transformation-script) - * [Prerequisites for a secure Kafka server](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#prerequisites-for-a-secure-kafka-server) - * [What needs to be granted](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#what-needs-to-be-granted) - * [Reading the transactional IDs from Studio](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#reading-the-transactional-ids-from-studio) - * [Entering the grants on the Kafka cluster](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#entering-the-grants-on-the-kafka-cluster) + * [Setup workflow](#setup-workflow) + * [Creating a Kafka ETL task](#creating-a-kafka-etl-task) + * [Open Kafka ETL Task View](#open-kafka-etl-task-view) + * [Define Kafka ETL Task](#define-kafka-etl-task) + * [Use RavenDB Certificate](#use-ravendb-certificate) + * [Options Per Topic](#options-per-topic) + * [Edit Transformation Script](#edit-transformation-script) + * [Prerequisites for a secure Kafka server](#prerequisites-for-a-secure-kafka-server) + * [What needs to be granted](#what-needs-to-be-granted) + * [Reading the transactional IDs from Studio](#reading-the-transactional-ids-from-studio) + * [Entering the grants on the Kafka cluster](#entering-the-grants-on-the-kafka-cluster) @@ -135,7 +135,7 @@ extension that permits acting as a TLS client) or a separate certificate that RavenDB issues from the server certificate's key pair. Enabling **Use RavenDB Certificate** replaces the security options you would -otherwise enter via [Add new connection option](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#define-kafka-etl-task). +otherwise enter via [Add new connection option](#define-kafka-etl-task). diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx index ab51120abc..8d1a052f2a 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx @@ -31,10 +31,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn how to define a Kafka queue sink using the API [here](../../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#add-a-database-task) - * [Define a Kafka Sink Task](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-a-kafka-sink-task) - * [Define and Test Task Scripts](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-and-test-task-scripts) - * [Task Statistics](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#task-statistics) + * [Add a Database Task](#add-a-database-task) + * [Define a Kafka Sink Task](#define-a-kafka-sink-task) + * [Define and Test Task Scripts](#define-and-test-task-scripts) + * [Task Statistics](#task-statistics) ## Add a Database Task diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx index a25b92d18e..29c0c600de 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx @@ -29,14 +29,14 @@ learn more about OLAP ETL tasks, and how to create one using the client API, see [Ongoing Tasks: OLAP ETL](../../../../server/ongoing-tasks/etl/olap.mdx). * In this page: - * [Navigate to the OLAP ETL View](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#navigate-to-the-olap-etl-view) - * [Define an OLAP ETL Task](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#define-an-olap-etl-task) - * [Custom Partition Value](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#custom-partition-value) - * [Run Frequency](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#run-frequency) - * [OLAP Connection String](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#olap-connection-string) - * [OLAP ETL Destinations](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#olap-etl-destinations) - * [Transform Scripts](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#transform-scripts) - * [Override ID column](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#override-id-column) + * [Navigate to the OLAP ETL View](#navigate-to-the-olap-etl-view) + * [Define an OLAP ETL Task](#define-an-olap-etl-task) + * [Custom Partition Value](#custom-partition-value) + * [Run Frequency](#run-frequency) + * [OLAP Connection String](#olap-connection-string) + * [OLAP ETL Destinations](#olap-etl-destinations) + * [Transform Scripts](#transform-scripts) + * [Override ID column](#override-id-column) ## Create an OLAP ETL Task @@ -66,7 +66,7 @@ To begin creating your OLAP ETL task: * A custom partition can be defined to differentiate parquet file locations when using the same connection string in multiple OLAP ETL tasks. -* The custom partition **name** is defined inside the [transformation scripts](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#transform-scripts). +* The custom partition **name** is defined inside the [transformation scripts](#transform-scripts). * The custom partition **value** is defined in the input box above. * The custom partition value is referenced in the transform script as `$customPartitionValue`. @@ -154,7 +154,7 @@ aren't specified in the script: * `_id` Contains the source document ID. The default name used for this column is `_id`. You can override this name in the task definition - see more - [below](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#override-id-column). + [below](#override-id-column). * `_lastModifiedTime` The value of the `last-modified` field in a document's metadata. Represented in unix time. diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx index 3f39791a90..5413018967 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx @@ -29,10 +29,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx) how to define a RabbitMQ ETL task using code. * In this page: - * [Open RabbitMQ ETL Task View](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#open-rabbitmq-etl-task-view) - * [Define RabbitMQ ETL Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#define-rabbitmq-etl-task) - * [Options Per Exchange](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#options-per-exchange) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#edit-transformation-script) + * [Open RabbitMQ ETL Task View](#open-rabbitmq-etl-task-view) + * [Define RabbitMQ ETL Task](#define-rabbitmq-etl-task) + * [Options Per Exchange](#options-per-exchange) + * [Edit Transformation Script](#edit-transformation-script) ## Open RabbitMQ ETL Task View diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx index 1e182ceb72..5fb27cb8f8 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx @@ -33,10 +33,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn how to define a RabbitMQ queue sink using the API [here](../../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#add-a-database-task) - * [Define a RabbitMQ Sink Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-a-rabbitmq-sink-task) - * [Define and Test Task Scripts](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-and-test-task-scripts) - * [Task Statistics](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#task-statistics) + * [Add a Database Task](#add-a-database-task) + * [Define a RabbitMQ Sink Task](#define-a-rabbitmq-sink-task) + * [Define and Test Task Scripts](#define-and-test-task-scripts) + * [Task Statistics](#task-statistics) ## Add a Database Task diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx index 5aa4515926..1201b7364e 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx @@ -23,19 +23,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more about the RavenDB ETL task options in [Ongoing Tasks: RavenDB ETL](../../../../server/ongoing-tasks/etl/raven.mdx). * RavenDB ETL is different from External Replication, - see [RavenDB ETL task -vs- External Replication task](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task--vs--external-replication-task) + see [RavenDB ETL task -vs- External Replication task](#ravendb-etl-task--vs--external-replication-task) * On secure servers, the destination cluster must trust the source, - see [Passing certificate between secure clusters](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#passing-certificate-between-secure-clusters). + see [Passing certificate between secure clusters](#passing-certificate-between-secure-clusters). * In this article: - * [RavenDB ETL task - definition](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-definition) - * [RavenDB ETL task - transform scripts](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-transform-scripts) - * [RavenDB ETL task - test script](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-test-script) - * [RavenDB ETL task - details in tasks list view](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-details-in-tasks-list-view) - * [RavenDB ETL task - offline behavior](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-offline-behavior) - * [RavenDB ETL task -vs- External Replication task](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-vs-external-replication-task) - * [Passing certificate between secure clusters](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#passing-certificate-between-secure-clusters) + * [RavenDB ETL task - definition](#ravendb-etl-task-definition) + * [RavenDB ETL task - transform scripts](#ravendb-etl-task-transform-scripts) + * [RavenDB ETL task - test script](#ravendb-etl-task-test-script) + * [RavenDB ETL task - details in tasks list view](#ravendb-etl-task-details-in-tasks-list-view) + * [RavenDB ETL task - offline behavior](#ravendb-etl-task-offline-behavior) + * [RavenDB ETL task -vs- External Replication task](#ravendb-etl-task-vs-external-replication-task) + * [Passing certificate between secure clusters](#passing-certificate-between-secure-clusters) diff --git a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/subscription-task.mdx b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/subscription-task.mdx index 9c8b07b31d..3a979a39a5 100644 --- a/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/subscription-task.mdx +++ b/versioned_docs/version-6.2/studio/database/tasks/ongoing-tasks/subscription-task.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page explains how to create a subscription task on the server side using the Studio. * In this page: - * [Subscription Task Definition](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#subscription-task-definition) - * [Testing Subscriptions](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#testing) - * [Details in Task List View](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#details-in-task-list-view) + * [Subscription Task Definition](#subscription-task-definition) + * [Testing Subscriptions](#testing) + * [Details in Task List View](#details-in-task-list-view) ## Subscription Task Definition diff --git a/versioned_docs/version-6.2/studio/overview.mdx b/versioned_docs/version-6.2/studio/overview.mdx index 130d620db1..1dcc78c2b1 100644 --- a/versioned_docs/version-6.2/studio/overview.mdx +++ b/versioned_docs/version-6.2/studio/overview.mdx @@ -33,14 +33,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; and much more. * In this page: - * [Accessing Studio After Setup](../studio/overview.mdx#accessing-studio-after-setup) - * [Connecting to an Unsecure server](../studio/overview.mdx#connecting-to-an-unsecure-server) - * [Connecting to a Secure server](../studio/overview.mdx#connecting-to-a-secure-server) - * [Where should the certificate be located](../studio/overview.mdx#where-should-the-certificate-be-located) - * [The Cluster Dashboard](../studio/overview.mdx#the-cluster-dashboard) - * [Manage Your Server](../studio/overview.mdx#manage-your-server) - * [Manage Your Databases](../studio/overview.mdx#manage-your-databases) - * [Header and Footer Areas](../studio/overview.mdx#header-and-footer-areas) + * [Accessing Studio After Setup](#accessing-studio-after-setup) + * [Connecting to an Unsecure server](#connecting-to-an-unsecure-server) + * [Connecting to a Secure server](#connecting-to-a-secure-server) + * [Where should the certificate be located](#where-should-the-certificate-be-located) + * [The Cluster Dashboard](#the-cluster-dashboard) + * [Manage Your Server](#manage-your-server) + * [Manage Your Databases](#manage-your-databases) + * [Header and Footer Areas](#header-and-footer-areas) ## Accessing Studio After Setup diff --git a/versioned_docs/version-6.2/studio/server/certificates/read-only-access-level.mdx b/versioned_docs/version-6.2/studio/server/certificates/read-only-access-level.mdx index 04e61a0163..dfd105fe66 100644 --- a/versioned_docs/version-6.2/studio/server/certificates/read-only-access-level.mdx +++ b/versioned_docs/version-6.2/studio/server/certificates/read-only-access-level.mdx @@ -32,7 +32,7 @@ that make it clear to the user what they can and can't do. * In this page: - * [Create a Client Certificate with Read Only Access](../../../studio/server/certificates/read-only-access-level.mdx#create-a-client-certificate-with-read-only-access) + * [Create a Client Certificate with Read Only Access](#create-a-client-certificate-with-read-only-access) * [The Studio in "Read Only" Mode](../../../studio/server/certificates/read-only-access-level.mdx#the-studio-in-"read-only"-mode) diff --git a/versioned_docs/version-6.2/studio/server/certificates/server-management-certificates-view.mdx b/versioned_docs/version-6.2/studio/server/certificates/server-management-certificates-view.mdx index ffd59c215a..0a36bdeac5 100644 --- a/versioned_docs/version-6.2/studio/server/certificates/server-management-certificates-view.mdx +++ b/versioned_docs/version-6.2/studio/server/certificates/server-management-certificates-view.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use the **Certificates** view to create, customize, import and export certificates. * In this article: - * [The certificates view](../../../studio/server/certificates/server-management-certificates-view.mdx#the-certificates-view) - * [View and edit certificates](../../../studio/server/certificates/server-management-certificates-view.mdx#view-and-edit-certificates) - * [Generate a client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#generate-a-client-certificate) - * [Enable communication between secure servers](../../../studio/server/certificates/server-management-certificates-view.mdx#enable-communication-between-secure-servers) - * [Upload an existing client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate) - * [Export server certificates](../../../studio/server/certificates/server-management-certificates-view.mdx#export-server-certificates) - * [Certificate collections](../../../studio/server/certificates/server-management-certificates-view.mdx#certificate-collections) + * [The certificates view](#the-certificates-view) + * [View and edit certificates](#view-and-edit-certificates) + * [Generate a client certificate](#generate-a-client-certificate) + * [Enable communication between secure servers](#enable-communication-between-secure-servers) + * [Upload an existing client certificate](#upload-an-existing-client-certificate) + * [Export server certificates](#export-server-certificates) + * [Certificate collections](#certificate-collections) ## The certificates view @@ -149,7 +149,7 @@ While uploading the client certificate you can modify its settings. ![Modify uploaded certificate settings](./assets/upload-settings.png) -See the [Generate a client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#generate-a-client-certificate) +See the [Generate a client certificate](#generate-a-client-certificate) section to learn about the available settings. ### Export server certificates diff --git a/versioned_docs/version-6.2/studio/server/client-configuration.mdx b/versioned_docs/version-6.2/studio/server/client-configuration.mdx index bd08f36641..efc648f77f 100644 --- a/versioned_docs/version-6.2/studio/server/client-configuration.mdx +++ b/versioned_docs/version-6.2/studio/server/client-configuration.mdx @@ -32,7 +32,7 @@ import Panel from '@site/src/components/Panel'; see: [Client configuration (for database)](../../studio/database/settings/client-configuration-per-database.mdx) * In this article: - * [Set the client configuration (server-wide)](../../studio/server/client-configuration.mdx#set-the-client-configuration-server-wide) + * [Set the client configuration (server-wide)](#set-the-client-configuration-server-wide) diff --git a/versioned_docs/version-6.2/studio/server/debug/admin-js-console.mdx b/versioned_docs/version-6.2/studio/server/debug/admin-js-console.mdx index 57d5ec0cc5..4c0f845639 100644 --- a/versioned_docs/version-6.2/studio/server/debug/admin-js-console.mdx +++ b/versioned_docs/version-6.2/studio/server/debug/admin-js-console.mdx @@ -28,9 +28,9 @@ Incorrect usage may crash the server, corrupt data, or cause irreversible change --- * In this article: - * [Admin JS Console view](../../../studio/server/debug/admin-js-console.mdx#admin-js-console-view) - * [Context objects in scripts](../../../studio/server/debug/admin-js-console.mdx#context-objects-in-scripts) - * [Console methods](../../../studio/server/debug/admin-js-console.mdx#console-methods) + * [Admin JS Console view](#admin-js-console-view) + * [Context objects in scripts](#context-objects-in-scripts) + * [Console methods](#console-methods) diff --git a/versioned_docs/version-6.2/studio/server/debug/advanced/cluster-observer.mdx b/versioned_docs/version-6.2/studio/server/debug/advanced/cluster-observer.mdx index c69097bdc1..598b471b23 100644 --- a/versioned_docs/version-6.2/studio/server/debug/advanced/cluster-observer.mdx +++ b/versioned_docs/version-6.2/studio/server/debug/advanced/cluster-observer.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; If there is no Leader, no Database Group Topology decisions can be made. * In this page: - * [The Observer Log](../../../../studio/server/debug/advanced/cluster-observer.mdx#the-observer-log) - * [Observer Log Data](../../../../studio/server/debug/advanced/cluster-observer.mdx#observer-log-data) - * [States Flow](../../../../studio/server/debug/advanced/cluster-observer.mdx#states-flow) + * [The Observer Log](#the-observer-log) + * [Observer Log Data](#observer-log-data) + * [States Flow](#states-flow) diff --git a/versioned_docs/version-6.2/studio/server/manage-server.mdx b/versioned_docs/version-6.2/studio/server/manage-server.mdx index 39fa72507e..743b67abcb 100644 --- a/versioned_docs/version-6.2/studio/server/manage-server.mdx +++ b/versioned_docs/version-6.2/studio/server/manage-server.mdx @@ -17,9 +17,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use the **Manage Server** menu to access your server's configuration and debugging options. * In this page: - * [Manage Server menu](../../studio/server/manage-server.mdx#manage-server-menu) - * [Configuration options](../../studio/server/manage-server.mdx#manage-server-configuration-options) - * [Debug options](../../studio/server/manage-server.mdx#debug-debugging-and-statistics-options) + * [Manage Server menu](#manage-server-menu) + * [Configuration options](#manage-server-configuration-options) + * [Debug options](#debug-debugging-and-statistics-options) ## Manage Server menu diff --git a/versioned_docs/version-6.2/studio/server/server-settings.mdx b/versioned_docs/version-6.2/studio/server/server-settings.mdx index e31a2a9545..0b54eac714 100644 --- a/versioned_docs/version-6.2/studio/server/server-settings.mdx +++ b/versioned_docs/version-6.2/studio/server/server-settings.mdx @@ -24,7 +24,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings.mdx) view. * In this page: - * [Server Settings View](../../studio/server/server-settings.mdx#server-settings-view) + * [Server Settings View](#server-settings-view) ## Server Settings View diff --git a/versioned_docs/version-6.2/studio/server/server-wide-backup.mdx b/versioned_docs/version-6.2/studio/server/server-wide-backup.mdx index 217812950a..ff2f7db769 100644 --- a/versioned_docs/version-6.2/studio/server/server-wide-backup.mdx +++ b/versioned_docs/version-6.2/studio/server/server-wide-backup.mdx @@ -32,10 +32,10 @@ _-or-_ files locally or in a variety of remote locations. * In this page: - * [Scheduling a Server-Wide Backup Task](../../studio/server/server-wide-backup.mdx#scheduling-a-server-wide-backup-task) - * [Restoring a Database From a Server-Wide Backup](../../studio/server/server-wide-backup.mdx#restoring-a-database-from-a-server-wide-backup) - * [Server-Wide Backup Tasks in the Database Tasks View](../../studio/server/server-wide-backup.mdx#server-wide-backup-tasks-in-the-database-tasks-view) - * [The Responsible Node](../../studio/server/server-wide-backup.mdx#the-responsible-node) + * [Scheduling a Server-Wide Backup Task](#scheduling-a-server-wide-backup-task) + * [Restoring a Database From a Server-Wide Backup](#restoring-a-database-from-a-server-wide-backup) + * [Server-Wide Backup Tasks in the Database Tasks View](#server-wide-backup-tasks-in-the-database-tasks-view) + * [The Responsible Node](#the-responsible-node) ## Scheduling a Server-Wide Backup Task @@ -77,7 +77,7 @@ The settings are similar to those of a [regular backup task](../../studio/databa See below. 7. **Destination** - See [below](../../studio/server/server-wide-backup.mdx#destination). + See [below](#destination). * If you use an [Amazon S3](https://aws.amazon.com/s3/) custom host: ![ForcePathStyle](./assets/studio-force-path-style.png) * a- **Use a custom S3 host** @@ -124,7 +124,7 @@ Backup files are created in a separate child folder per database, under a common ## Restoring a Database From a Server-Wide Backup There is no difference between restoring a database from a backup file created by the -[Server-Wide procedure](../../studio/server/server-wide-backup.mdx#scheduling-a-server-wide-backup-task) +[Server-Wide procedure](#scheduling-a-server-wide-backup-task) and a [separately created backup](../../studio/database/tasks/backup-task.mdx#backup-task). In both cases, you can restore the database by [Creating a New Database from Backup](../../studio/database/create-new-database/from-backup.mdx). @@ -162,7 +162,7 @@ To edit or modify a Server-Wide task, navigate back to the [Server-Wide Backup v ## The Responsible Node * When defining a Server-Wide backup, the user is not given the option to select a - [responsible node](../../studio/server/server-wide-backup.mdx#the-responsible-node) manually, + [responsible node](#the-responsible-node) manually, since the responsible node can differ per database depending on the nodes the database resides on (the [Database Group](../../studio/database/settings/manage-database-group.mdx#database-group)). For each database, the responsible node for the task is set by the cluster to one of the database group nodes. diff --git a/versioned_docs/version-6.2/users-issues/recovering-from-voron-errors.mdx b/versioned_docs/version-6.2/users-issues/recovering-from-voron-errors.mdx index 307921d198..77ba676119 100644 --- a/versioned_docs/version-6.2/users-issues/recovering-from-voron-errors.mdx +++ b/versioned_docs/version-6.2/users-issues/recovering-from-voron-errors.mdx @@ -28,7 +28,7 @@ If such errors happen, they need to be reported as soon as possible to [RavenDB * Such exceptions are caused by the corruption of a Voron _data file_, which could occur due to a few reasons: * Hardware failure of hard-drive or memory - * In compliance‏ with RavenDB [hardware and OS requirements](../users-issues/recovering-from-voron-errors.mdx#ravendb-hardware-and-os-requirements) + * In compliance‏ with RavenDB [hardware and OS requirements](#ravendb-hardware-and-os-requirements) * Critical bug in `Voron` diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_configuration.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_configuration.mdx index 41a9c01fcd..f49ab7444a 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_configuration.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_configuration.mdx @@ -28,10 +28,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Learn about configuring RavenDB](../../server/configuration/configuration-options.mdx). * On this page: - * [Ai.Agent.Tools.TokenUsageThreshold](../../ai-integration/ai-agents/ai-agents_configuration.mdx#aiagenttoolstokenusagethreshold) - * [Ai.Agent.Trimming.Summarization.SummarizationResultPrefix](../../ai-integration/ai-agents/ai-agents_configuration.mdx#aiagenttrimmingsummarizationsummarizationresultprefix) - * [Ai.Agent.Trimming.Summarization.SummarizationTaskBeginningPrompt](../../ai-integration/ai-agents/ai-agents_configuration.mdx#aiagenttrimmingsummarizationsummarizationtaskbeginningprompt) - * [Ai.Agent.Trimming.Summarization.SummarizationTaskEndPrompt](../../ai-integration/ai-agents/ai-agents_configuration.mdx#aiagenttrimmingsummarizationsummarizationtaskendprompt) + * [Ai.Agent.Tools.TokenUsageThreshold](#aiagenttoolstokenusagethreshold) + * [Ai.Agent.Trimming.Summarization.SummarizationResultPrefix](#aiagenttrimmingsummarizationsummarizationresultprefix) + * [Ai.Agent.Trimming.Summarization.SummarizationTaskBeginningPrompt](#aiagenttrimmingsummarizationsummarizationtaskbeginningprompt) + * [Ai.Agent.Trimming.Summarization.SummarizationTaskEndPrompt](#aiagenttrimmingsummarizationsummarizationtaskendprompt) diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_security-concerns.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_security-concerns.mdx index f4f85fa4d2..1202f830d3 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_security-concerns.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/ai-agents_security-concerns.mdx @@ -17,11 +17,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; This page covers potential security concerns related to AI agents and the mitigation strategies for these concerns. * On this page: - * [Unauthorized database access](../../ai-integration/ai-agents/ai-agents_security-concerns.mdx#unauthorized-database-access) - * [Data compromise during transit](../../ai-integration/ai-agents/ai-agents_security-concerns.mdx#data-compromise-during-transit) - * [Untraceable malicious or unexpected actions](../../ai-integration/ai-agents/ai-agents_security-concerns.mdx#untraceable-malicious-or-unexpected-actions) - * [AI model data memorization](../../ai-integration/ai-agents/ai-agents_security-concerns.mdx#ai-model-data-memorization) - * [Validation or injection attacks via user input](../../ai-integration/ai-agents/ai-agents_security-concerns.mdx#validation-or-injection-attacks-via-user-input) + * [Unauthorized database access](#unauthorized-database-access) + * [Data compromise during transit](#data-compromise-during-transit) + * [Untraceable malicious or unexpected actions](#untraceable-malicious-or-unexpected-actions) + * [AI model data memorization](#ai-model-data-memorization) + * [Validation or injection attacks via user input](#validation-or-injection-attacks-via-user-input) diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx index 93523aa4b0..01cc48c7b2 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx @@ -16,28 +16,28 @@ import Panel from "@site/src/components/Panel"; * This page provides a step-by-step guide to creating an AI agent and interacting with it using the Client API. * In this article: - * [Creating a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) - * [Defining an agent configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration) - * [Set the agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-the-agent-id) - * [Define a response object](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#define-a-response-object) - * [Add agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#add-agent-parameters) - * [Set maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-maximum-number-of-iterations) - * [Set chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-chat-trimming-configuration) - * [Adding agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools) - * [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) - * [Initial-context queries](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#initial-context-queries) - * [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools) - * [Creating the Agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent) - * [Retrieving existing agent configurations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations) - * [Managing conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations) - * [Setting a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) - * [Processing action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests) - * [Action-tool Handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - * [Action-tool Receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers) - * [Conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response) - * [Setting user prompt and running the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) - * [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) - * [Full Example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example) + * [Creating a connection string](#creating-a-connection-string) + * [Defining an agent configuration](#defining-an-agent-configuration) + * [Set the agent ID](#set-the-agent-id) + * [Define a response object](#define-a-response-object) + * [Add agent parameters](#add-agent-parameters) + * [Set maximum number of iterations](#set-maximum-number-of-iterations) + * [Set chat trimming configuration](#set-chat-trimming-configuration) + * [Adding agent tools](#adding-agent-tools) + * [Query tools](#query-tools) + * [Initial-context queries](#initial-context-queries) + * [Action tools](#action-tools) + * [Creating the Agent](#creating-the-agent) + * [Retrieving existing agent configurations](#retrieving-existing-agent-configurations) + * [Managing conversations](#managing-conversations) + * [Setting a conversation](#setting-a-conversation) + * [Processing action-tool requests](#processing-action-tool-requests) + * [Action-tool Handlers](#action-tool-handlers) + * [Action-tool Receivers](#action-tool-receivers) + * [Conversation response](#conversation-response) + * [Setting user prompt and running the conversation](#setting-user-prompt-and-running-the-conversation) + * [Stream LLM responses](#stream-llm-responses) + * [Full Example](#full-example) @@ -162,7 +162,7 @@ Start by creating a new `AiAgentConfiguration` instance. While creating the instance, pass its constructor: - The agent's Name -- The [connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) you created +- The [connection string](#creating-a-connection-string) you created - A System prompt The agent will send the system prompt you define here to the LLM to define its basic characteristics, including its role, purpose, behavior, and the tools it can use. @@ -312,7 +312,7 @@ agent.OutputSchema = "{" + ### Add agent parameters -Agent parameters are parameters that can be used by [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) when the agent queries the database on behalf of the LLM. +Agent parameters are parameters that can be used by [query tools](#query-tools) when the agent queries the database on behalf of the LLM. Values for agent parameters are provided by the client, or by a user through the client, when a chat is started. When the agent is requested to use a query tool that uses agent parameters, it replaces these parameters with the values provided by the user before running the query. @@ -358,7 +358,7 @@ agent tools in response to a single user prompt. Use `MaxModelIterationsPerCall` Note that you can improve the TTFB (Time To First Byte) by getting the LLM's response in chunks using streaming. -Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses). +Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). @@ -795,7 +795,7 @@ You can also retrieve the configurations of **all existing agents** using `GetAg | Property | Type | Description | |----------|------|-------------| | agentId | `string` | The agent unique ID | - | conversationId | `string` | The [conversation ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) | + | conversationId | `string` | The [conversation ID](#setting-a-conversation) | | creationOptions | `AiConversationCreationOptions` | Conversation creation options (see class definition below) | | changeVector | `string` | Optional change vector for concurrency control | @@ -842,7 +842,7 @@ During the conversation, the LLM can request the agent to trigger action tools. The agent will pass a requested action tool's name and parameters to the client, and it is then up to the client to process the request. -The client can process an action-tool request using a [handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) or a [receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers). +The client can process an action-tool request using a [handler](#action-tool-handlers) or a [receiver](#action-tool-receivers). #### Action-tool Handlers A **handler** is created for a specific action tool and registered with the server using the `Handle` method. @@ -1058,7 +1058,7 @@ Set the user prompt using the `SetUserPrompt` method, and run the conversation u `RunAsync` method. You can also use `StreamAsync` to **stream** the LLM's response as it is generated. -Learn how to do this in the [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) section. +Learn how to do this in the [Stream LLM responses](#stream-llm-responses) section. ```csharp @@ -1075,14 +1075,14 @@ if (LLMResponse.Status == AiConversationResult.Done) } ``` -See the full example [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example). +See the full example [below](#full-example). -You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `StreamAsync` method, instead of using [RunAsync](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. +You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `StreamAsync` method, instead of using [RunAsync](#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. Streaming the response allows the client to start processing it before it is complete, which can improve the application's responsiveness. diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx index 210ad6aabc..fa8306ca24 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx @@ -17,24 +17,24 @@ import Panel from "@site/src/components/Panel"; To create an AI agent from Studio, see [Creating AI agents - Studio](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx). * In this article: - * [Create a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) - * [Define the agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration) - * [Add agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools) - * [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) - * [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools) - * [Create the agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent) - * [Manage conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations) - * [Create a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) - * [Process action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests) - * [Action-tool handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - * [Action-tool receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers) - * [Set user prompt and RUN the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) - * [Handle the conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response) - * [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) - * [Full example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example) - * [Retrieve existing agents](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations) - * [Delete agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#delete-agent) - * [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) + * [Create a connection string](#creating-a-connection-string) + * [Define the agent](#defining-an-agent-configuration) + * [Add agent tools](#adding-agent-tools) + * [Query tools](#query-tools) + * [Action tools](#action-tools) + * [Create the agent](#creating-the-agent) + * [Manage conversations](#managing-conversations) + * [Create a conversation](#setting-a-conversation) + * [Process action-tool requests](#processing-action-tool-requests) + * [Action-tool handlers](#action-tool-handlers) + * [Action-tool receivers](#action-tool-receivers) + * [Set user prompt and RUN the conversation](#setting-user-prompt-and-running-the-conversation) + * [Handle the conversation response](#conversation-response) + * [Stream LLM responses](#stream-llm-responses) + * [Full example](#full-example) + * [Retrieve existing agents](#retrieving-existing-agent-configurations) + * [Delete agent](#delete-agent) + * [Syntax](#syntax) @@ -158,14 +158,14 @@ See the dedicated syntax sections in the following articles for full configurati * Then populate the object with your system prompt, agent settings, and tools. The following sections explain how to configure each component of the agent: - * [System prompt](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#system-prompt) - * [Agent name](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-name) - * [Agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-id) - * [Connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#connection-string) - * [Expected response format](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#expected-response-format) - * [Agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-parameters) - * [Maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#maximum-number-of-iterations) - * [Chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#chat-trimming-configuration) + * [System prompt](#system-prompt) + * [Agent name](#agent-name) + * [Agent ID](#agent-id) + * [Connection string](#connection-string) + * [Expected response format](#expected-response-format) + * [Agent parameters](#agent-parameters) + * [Maximum number of iterations](#maximum-number-of-iterations) + * [Chat trimming configuration](#chat-trimming-configuration) --- @@ -220,7 +220,7 @@ agentConfiguration.identifier = "reward-productive-employee"; ### Connection string -Provide the name of the connection string you created above in [Create a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string). +Provide the name of the connection string you created above in [Create a connection string](#creating-a-connection-string). ```js agentConfiguration.connectionStringName = connectionString.name; @@ -301,9 +301,9 @@ agent.OutputSchema = outputSchema: JSON.stringify({ Agent parameters let you define named placeholders for values used in queries inside query tools. At configuration time, you define the parameter name (e.g. `country`), -which you can then use in the RQL of your [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) as a placeholder (e.g. `$country`). +which you can then use in the RQL of your [query tools](#query-tools) as a placeholder (e.g. `$country`). The values for these parameters are Not set by the LLM - -you must provide the actual value at [conversation startup](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation). +you must provide the actual value at [conversation startup](#setting-a-conversation). When the agent is requested to execute a query that references an agent parameter, it replaces each placeholder with the corresponding value you supplied at chat startup, before running the query. @@ -334,7 +334,7 @@ agentConfiguration.maxModelIterationsPerCall = 3; * Note that you can reduce Time To First Byte (TTFB) by streaming the LLM response as it's being generated. This allows the LLM to return selected fields in chunks before the full response is complete. * Find more about streaming in [Streaming LLM responses - overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) - and in [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) below. + and in [Stream LLM responses](#stream-llm-responses) below. @@ -389,13 +389,13 @@ agentConfiguration.chatTrimming = { * **RQL** - an [RQL query](../../../../client-api/session/querying/what-is-rql.mdx) that defines what data to retrieve. * To run a query tool at agent startup and provide initial context to the LLM **before** the conversation begins, - see: [Initial-context queries](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#initial-context-queries) below. + see: [Initial-context queries](#initial-context-queries) below. * **Passing values to a query tool** The RQL in the query tool may include parameter placeholders prefixed with `$` (e.g. `$country`). Both the user and the LLM can pass values to these parameters. * **Passing values from the user**: - Users can pass values to queries through [Agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-parameters). + Users can pass values to queries through [Agent parameters](#agent-parameters). If agent parameters are defined in the agent configuration - * The client must provide values for them when initiating a conversation with the agent. * Before executing the query, the agent will replace the placeholders with the provided values. @@ -602,7 +602,7 @@ agentConfiguration.chatTrimming = { * Conversation creation options - including values for any agent parameters, if defined. * The object returned by `conversation` is used to run the chat. - See [Set user prompt and run the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation). + See [Set user prompt and run the conversation](#setting-user-prompt-and-running-the-conversation). * **Example** @@ -645,8 +645,8 @@ agentConfiguration.chatTrimming = { When this happens, the agent forwards the tool’s name and parameters to the client - and it’s up to the client to handle the request. -* The client can process an action-tool request using either a [Handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - or a [Receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers). +* The client can process an action-tool request using either a [Handler](#action-tool-handlers) + or a [Receiver](#action-tool-receivers). --- @@ -808,7 +808,7 @@ if (response.status === "Done") { Instead of `run`, you can use `stream` to **stream** the LLM's response as it is generated. -See [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses). +See [Stream LLM responses](#stream-llm-responses). diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx index 6dd6c334d5..ab3391b665 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx @@ -16,30 +16,30 @@ import Panel from "@site/src/components/Panel"; * This page provides a step-by-step guide to creating an AI agent and interacting with it using the Client API. * In this article: - * [Creating a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) - * [Defining an agent configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration) - * [Set the agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-the-agent-id) - * [Define a response object](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#define-a-response-object) - * [Add agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#add-agent-parameters) - * [Set maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-maximum-number-of-iterations) - * [Set chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#set-chat-trimming-configuration) - * [Adding agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools) - * [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) + * [Creating a connection string](#creating-a-connection-string) + * [Defining an agent configuration](#defining-an-agent-configuration) + * [Set the agent ID](#set-the-agent-id) + * [Define a response object](#define-a-response-object) + * [Add agent parameters](#add-agent-parameters) + * [Set maximum number of iterations](#set-maximum-number-of-iterations) + * [Set chat trimming configuration](#set-chat-trimming-configuration) + * [Adding agent tools](#adding-agent-tools) + * [Query tools](#query-tools) - * [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools) - * [Creating the Agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent) - * [Retrieving existing agent configurations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations) - * [Managing conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations) - * [Setting a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) - * [Processing action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests) - * [Action-tool Handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) - * [Action-tool Receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers) - * [Conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response) - * [Setting user prompt and running the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) - * [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) - * [Full Example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example) + * [Action tools](#action-tools) + * [Creating the Agent](#creating-the-agent) + * [Retrieving existing agent configurations](#retrieving-existing-agent-configurations) + * [Managing conversations](#managing-conversations) + * [Setting a conversation](#setting-a-conversation) + * [Processing action-tool requests](#processing-action-tool-requests) + * [Action-tool Handlers](#action-tool-handlers) + * [Action-tool Receivers](#action-tool-receivers) + * [Conversation response](#conversation-response) + * [Setting user prompt and running the conversation](#setting-user-prompt-and-running-the-conversation) + * [Stream LLM responses](#stream-llm-responses) + * [Full Example](#full-example) @@ -160,7 +160,7 @@ Start by creating a new `AiAgentConfiguration` instance. While creating the instance, pass its constructor: - The agent's Name -- The [connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string) you created +- The [connection string](#creating-a-connection-string) you created - A System prompt The agent will send the system prompt you define here to the LLM to define its basic characteristics, including its role, purpose, behavior, and the tools it can use. @@ -320,7 +320,7 @@ agent.output_schema = """ ### Add agent parameters -Agent parameters are parameters that can be used by [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) when the agent queries the database on behalf of the LLM. +Agent parameters are parameters that can be used by [query tools](#query-tools) when the agent queries the database on behalf of the LLM. Values for agent parameters are provided by the client, or by a user through the client, when a chat is started. When the agent is requested to use a query tool that uses agent parameters, it replaces these parameters with the values provided by the user before running the query. @@ -371,7 +371,7 @@ agent tools in response to a single user prompt. Use `max_model_iterations_per_c Note that you can improve the TTFB (Time To First Byte) by getting the LLM's response in chunks using streaming. -Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses). +Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). @@ -775,7 +775,7 @@ You can retrieve the configuration of **existing agents** using `get_agents`. | Property | Type | Description | |----------|------|-------------| | agent_id | `str` | The agent unique ID | - | conversation_id | `str` | The [conversation ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation) | + | conversation_id | `str` | The [conversation ID](#setting-a-conversation) | | creation_options | `AiConversationCreationOptions` | Conversation creation options (see class definition below) | | change_vector | `str` | Optional change vector for concurrency control | @@ -820,7 +820,7 @@ During the conversation, the LLM can request the agent to trigger action tools. The agent will pass a requested action tool's name and parameters to the client, and it is then up to the client to process the request. -The client can process an action-tool request using a [handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers) or a [receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers). +The client can process an action-tool request using a [handler](#action-tool-handlers) or a [receiver](#action-tool-receivers). #### Action-tool Handlers A **handler** is created for a specific action tool and registered with the server using the `handle` method. @@ -1042,7 +1042,7 @@ The LLM response is returned by the agent to the client in an `AiAnswer` object, Set the user prompt using the `set_user_prompt` method, and run the conversationusing `chat.run`. You can also use `chat.stream` to stream the LLM's response as it is generated. -Learn how to do this in the [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) section. +Learn how to do this in the [Stream LLM responses](#stream-llm-responses) section. ```python @@ -1059,14 +1059,14 @@ if llm_response.status == AiConversationStatus.DONE: ``` -See the full example [below](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example). +See the full example [below](#full-example). -You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `chat.stream` method, instead of using [chat.run](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. +You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `chat.stream` method, instead of using [chat.run](#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. Streaming the response allows the client to start processing it before it is complete, which can improve the application's responsiveness. diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx index bc64aa4e4e..67d42e065a 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx @@ -15,20 +15,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: - * [Create AI Agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#create-ai-agent) - * [Configure basic settings](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-basic-settings) - * [Set agent parameters](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#set-agent-parameters) - * [Define agent tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#define-agent-tools) - * [Add query tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#add-query-tools) - * [Add action tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#add-action-tools) - * [Configure chat trimming](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-chat-trimming) - * [Save and Run your agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#save-and-run-your-agent) - * [Start new chat](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#start-new-chat) - * [Agent interaction](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#agent-interaction) - * [Action tool dialog](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#action-tool-dialog) - * [Agent results](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#agent-results) - * [Test your agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#test-your-agent) - * [Runtime view and Test results](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#runtime-view-and-test-results) + * [Create AI Agent](#create-ai-agent) + * [Configure basic settings](#configure-basic-settings) + * [Set agent parameters](#set-agent-parameters) + * [Define agent tools](#define-agent-tools) + * [Add query tools](#add-query-tools) + * [Add action tools](#add-action-tools) + * [Configure chat trimming](#configure-chat-trimming) + * [Save and Run your agent](#save-and-run-your-agent) + * [Start new chat](#start-new-chat) + * [Agent interaction](#agent-interaction) + * [Action tool dialog](#action-tool-dialog) + * [Agent results](#agent-results) + * [Test your agent](#test-your-agent) + * [Runtime view and Test results](#runtime-view-and-test-results) diff --git a/versioned_docs/version-7.1/ai-integration/ai-agents/overview.mdx b/versioned_docs/version-7.1/ai-integration/ai-agents/overview.mdx index 380727c6c8..e282f3098b 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-agents/overview.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-agents/overview.mdx @@ -14,7 +14,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # AI agents: Overview -* An AI agent is a highly customizable [mediation component](../../ai-integration/ai-agents/overview.mdx#ai-agent-usage-flowchart) that an authorized client can tailor to its needs and install on the server. The agent serves the client by facilitating communication between the client, an LLM, and a RavenDB database. +* An AI agent is a highly customizable [mediation component](#ai-agent-usage-flowchart) that an authorized client can tailor to its needs and install on the server. The agent serves the client by facilitating communication between the client, an LLM, and a RavenDB database. * Clients can use AI agents to automate complex workflows by leveraging LLM capabilities such as data analysis, decision-making, and natural language processing. @@ -25,14 +25,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Delegating the communication with the LLM to an AI agent can significantly reduce client code complexity and development overhead. * In this article: - * [Defining and running AI agents](../../ai-integration/ai-agents/overview.mdx#defining-and-running-an-ai-agent) - * [The main stages in defining an AI agent](../../ai-integration/ai-agents/overview.mdx#the-main-stages-in-defining-an-ai-agent) - * [What is a conversation](../../ai-integration/ai-agents/overview.mdx#what-is-a-conversation) - * [Initiating a conversation](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation) - * [AI agent usage flowchart](../../ai-integration/ai-agents/overview.mdx#ai-agent-usage-flowchart) - * [Streaming LLM responses](../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) - * [Reducing throughput and expediting LLM response](../../ai-integration/ai-agents/overview.mdx#reducing-throughput-and-expediting-llm-response) - * [Common use cases](../../ai-integration/ai-agents/overview.mdx#common-use-cases) + * [Defining and running AI agents](#defining-and-running-an-ai-agent) + * [The main stages in defining an AI agent](#the-main-stages-in-defining-an-ai-agent) + * [What is a conversation](#what-is-a-conversation) + * [Initiating a conversation](#initiating-a-conversation) + * [AI agent usage flowchart](#ai-agent-usage-flowchart) + * [Streaming LLM responses](#streaming-llm-responses) + * [Reducing throughput and expediting LLM response](#reducing-throughput-and-expediting-llm-response) + * [Common use cases](#common-use-cases) @@ -76,7 +76,7 @@ To define an AI agent, the client needs to specify - The LLM will be able to invoke query tools freely to retrieve data from the database. * **Read-only operations** Query tools can apply **read operations** only. - To make changes in the database, use [action tools](../../ai-integration/ai-agents/overview.mdx#action-tools). + To make changes in the database, use [action tools](#action-tools). Note that actions can be performed only by the client. The LLM can just request the client to perform actions on its behalf. @@ -100,7 +100,7 @@ To define an AI agent, the client needs to specify - ### What is a conversation: A conversation is a communication session between the client, the agent, and the LLM that maintains the history of messages exchanged between these participants since the conversation began. -* The conversation starts when the client invokes the agent and provides it with an [initial context](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation). +* The conversation starts when the client invokes the agent and provides it with an [initial context](#initiating-a-conversation). * The conversation may include multiple "turns" of message exchanges between the client and the LLM, mediated by the agent. * Each turn starts with a new **user prompt** from the client. * During the turn, the LLM can trigger the agent to run queries or request the client to perform actions, using [defined query and action tools](../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools). @@ -116,12 +116,12 @@ A conversation is a communication session between the client, the agent, and the ### Initiating a conversation: To start a conversation with the LLM, the agent will send it an **initial context** that includes - -* The pre-defined [agent configuration](../../ai-integration/ai-agents/overview.mdx#the-main-stages-in-defining-an-ai-agent) (automatically sent by the agent) with: +* The pre-defined [agent configuration](#the-main-stages-in-defining-an-ai-agent) (automatically sent by the agent) with: * The system prompt * A response object that defines the layout for the LLM response * Optional agent parameters * Optional Query tools - (and if any query tool is configured as an [initial-context query](../../ai-integration/ai-agents/overview.mdx#initial-context-queries) - results for this query) + (and if any query tool is configured as an [initial-context query](#initial-context-queries) - results for this query) * Optional Action tools * **Values for agent parameters** @@ -162,7 +162,7 @@ The flowchart below illustrates interactions between the User, RavenDB client, A The client can interact with the database directly, either by its own initiative or as a result of AI agent action requests (query requests are handled by the agent). 3. **Client`<->`Agent** flow - * To invoke an agent, the client needs to provide it with an [initial context](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation). + * To invoke an agent, the client needs to provide it with an [initial context](#initiating-a-conversation). * During the conversation, the agent may send to the client action requests on behalf of the LLM. * When the LLM provides the agent with its final response, the agent will provide it to the client. The client does not need to reply to this message. @@ -176,7 +176,7 @@ The flowchart below illustrates interactions between the User, RavenDB client, A * When the agent is requested to run a query that includes _LLM parameters_, it will replace these parameters with values provided by the LLM before running the query. 5. **Agent`<->`Model** flow - * **When a conversation is started**, the agent needs to provide the AI model with an [initial context](../../ai-integration/ai-agents/overview.mdx#initiating-a-conversation), partly defined by the agent configuration and partly by the client. + * **When a conversation is started**, the agent needs to provide the AI model with an [initial context](#initiating-a-conversation), partly defined by the agent configuration and partly by the client. * **During the conversation**, the AI model can respond to the agent with - * Requests for queries. If a query includes LLM parameters, the LLM will include values for them, and the agent will replace the parameters with these values, run the query, and return its results to the LLM. diff --git a/versioned_docs/version-7.1/ai-integration/ai-tasks-list-view.mdx b/versioned_docs/version-7.1/ai-integration/ai-tasks-list-view.mdx index ebd199714b..647d03ac5b 100644 --- a/versioned_docs/version-7.1/ai-integration/ai-tasks-list-view.mdx +++ b/versioned_docs/version-7.1/ai-integration/ai-tasks-list-view.mdx @@ -26,7 +26,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; create new tasks, edit existing ones, or delete them as needed. * In this article: - * [AI Tasks - list view](../ai-integration/ai-tasks-list-view.mdx#ai-tasks---list-view) + * [AI Tasks - list view](#ai-tasks---list-view) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx index 672c2c2352..c5edfb3bdd 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -70,7 +70,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Deployment Name_, and _Model_ name. * One additional setting is specific to chat models: _Temperature_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx index 0c201049fb..a66cece148 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-nodejs.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -70,7 +70,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Deployment Name_, and _Model_ name. * One additional setting is specific to chat models: _Temperature_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-python.mdx index 92bcb37863..6c7ac607a8 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_azure-open-ai-python.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string---from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/azure-open-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) @@ -66,7 +66,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/azure-open-ai.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Deployment Name_, and _Model_ name. * One additional setting is specific to chat models: _Temperature_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-csharp.mdx index d46702d5c9..690d8ced66 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-csharp.mdx @@ -15,9 +15,9 @@ import Panel from '@site/src/components/Panel'; depending on your workload and usage patterns. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/embedded.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-nodejs.mdx index d60dac3714..8167c90558 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-nodejs.mdx @@ -15,9 +15,9 @@ import Panel from '@site/src/components/Panel'; depending on your workload and usage patterns. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/embedded.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-python.mdx index 96d85e28a5..ffe8d6016b 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_embedded-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; depending on your workload and usage patterns. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/embedded.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/embedded.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-csharp.mdx index 016de1fa7a..3fcb762070 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-csharp.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/google-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-nodejs.mdx index 1653b8e909..85e756c021 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-nodejs.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/google-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-python.mdx index d3fa0fa196..74f8e04298 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_google-ai-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/google-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/google-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-csharp.mdx index 4e98139012..efb6154fa4 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-csharp.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/hugging-face.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx index 41a832e388..04ea40133a 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-nodejs.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/hugging-face.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-python.mdx index d23ae6bd8a..f7e42145b7 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_hugging-face-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/hugging-face.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/hugging-face.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx index 72e86d7f40..26f0691050 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-csharp.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/mistral-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx index 638f5c4d32..9cfecfeabd 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-nodejs.mdx @@ -14,9 +14,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/mistral-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-python.mdx index d4e64d5308..80c1885291 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_mistral-ai-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/mistral-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/mistral-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-csharp.mdx index d96a0903ea..9ba1319062 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/ollama.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -58,7 +58,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _URI_, and _Model_ name. * In addition, two fields are specific to chat models: _Temperature_ and _Thinking mode_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-nodejs.mdx index c8fd1aca3d..36721e9b5f 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-nodejs.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/ollama.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -58,7 +58,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _URI_, and _Model_ name. * In addition, two fields are specific to chat models: _Temperature_ and _Thinking mode_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-python.mdx index bcc06c8dbf..4ec155873e 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_ollama-python.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; [Gen AI tasks](../../../ai-integration/gen-ai-integration/overview.mdx), and [AI agents](../../../ai-integration/ai-agents/overview.mdx). * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string---from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/ollama.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/ollama.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) @@ -54,7 +54,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/ollama.mdx#configuring-a-text-embedding-model), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-model), including the connection string _Name_, optional _Identifier_, _URI_, and _Model_ name. * In addition, two fields are specific to chat models: _Temperature_ and _Thinking mode_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-csharp.mdx index 726ac3fe75..7ed9f9d0fb 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-csharp.mdx @@ -15,11 +15,11 @@ import Panel from '@site/src/components/Panel'; As long as the provider follows the OpenAI API format, RavenDB will be able to use it for Embeddings generation, Gen AI tasks, and chat-based agent interactions. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-mode), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-mode), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Model_ name, _Organization ID_, and _Project ID_. * One additional setting is specific to chat models: _Temperature_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-nodejs.mdx index d022718b5d..bc35ad101d 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-nodejs.mdx @@ -15,11 +15,11 @@ import Panel from '@site/src/components/Panel'; As long as the provider follows the OpenAI API format, RavenDB will be able to use it for Embeddings generation, Gen AI tasks, and chat-based agent interactions. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-mode), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-mode), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Model_ name, _Organization ID_, and _Project ID_. * One additional setting is specific to chat models: _Temperature_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-python.mdx index 20c52d28c1..e1108111a4 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_open-ai-python.mdx @@ -13,11 +13,11 @@ import CodeBlock from '@theme/CodeBlock'; As long as the provider follows the OpenAI API format, RavenDB will be able to use it for Embeddings generation, Gen AI tasks, and chat-based agent interactions. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string---from-studio) - * [Configuring a text embedding model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-model) - * [Configuring a chat model](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-chat-model) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/open-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/open-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Configuring a text embedding model](#configuring-a-text-embedding-model) + * [Configuring a chat model](#configuring-a-chat-model) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) @@ -80,7 +80,7 @@ import CodeBlock from '@theme/CodeBlock'; ### Configuring a chat model -* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](../../../ai-integration/connection-strings/open-ai.mdx#configuring-a-text-embedding-mode), +* When configuring a chat model, the UI displays the same base fields as those used for [text embedding models](#configuring-a-text-embedding-mode), including the connection string _Name_, optional _Identifier_, _API Key_, _Endpoint_, _Model_ name, _Organization ID_, and _Project ID_. * One additional setting is specific to chat models: _Temperature_. diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx index b223ea7037..4219f6d737 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-csharp.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/vertex-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx index c70b6ad20b..5636c14e7d 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-nodejs.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string-from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/vertex-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string-from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string-from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-python.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-python.mdx index 33d2450e10..0bfb17da8c 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/content/_vertex-ai-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Chat models are not supported through this integration. * In this article: - * [Define the connection string - from Studio](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string---from-studio) - * [Define the connection string - from the Client API](../../../ai-integration/connection-strings/vertex-ai.mdx#define-the-connection-string---from-the-client-api) - * [Syntax](../../../ai-integration/connection-strings/vertex-ai.mdx#syntax) + * [Define the connection string - from Studio](#define-the-connection-string---from-studio) + * [Define the connection string - from the Client API](#define-the-connection-string---from-the-client-api) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/connection-strings/overview.mdx b/versioned_docs/version-7.1/ai-integration/connection-strings/overview.mdx index 3a648745ac..c7aa520081 100644 --- a/versioned_docs/version-7.1/ai-integration/connection-strings/overview.mdx +++ b/versioned_docs/version-7.1/ai-integration/connection-strings/overview.mdx @@ -48,8 +48,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; --- * In this article: - * [The AI Connection Strings view](../../ai-integration/connection-strings/overview.mdx#the-ai-connection-strings-view) - * [Creating an AI connection string (from Studio)](../../ai-integration/connection-strings/overview.mdx#creating-an-ai-connection-string-from-studio) + * [The AI Connection Strings view](#the-ai-connection-strings-view) + * [Creating an AI connection string (from Studio)](#creating-an-ai-connection-string-from-studio) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx index 45b92702a0..657853dabf 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-csharp.mdx @@ -21,7 +21,7 @@ import Panel from "@site/src/components/Panel"; 5. And finally, runs a user-defined script that potentially acts upon the results. * The main steps in defining a GenAI task are: - * Defining a [Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) + * Defining a [Connection string](#defining-a-connection-string) to the AI model * Defining a [Context generation script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) * Defining a [Prompt](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt) @@ -29,9 +29,9 @@ import Panel from "@site/src/components/Panel"; * Defining an [Update script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) * In this article: - * [Defining a Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) - * [Defining the GenAI task](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-the-genai-task) - * [Full example](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#full-example) + * [Defining a Connection string](#defining-a-connection-string) + * [Defining the GenAI task](#defining-the-genai-task) + * [Full example](#full-example) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx index 82581fa7c7..739c9a56c5 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-nodejs.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; 5. Runs a user-defined script that may act on those results. * The main steps in defining a GenAI task are: - * Defining a [Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#define-a-connection-string) + * Defining a [Connection string](#define-a-connection-string) to the AI model * Defining a [Context generation script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) * Defining a [Prompt](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt) @@ -28,10 +28,10 @@ import Panel from "@site/src/components/Panel"; * Defining an [Update script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) * In this article: - * [Define a connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#define-a-connection-string) - * [Define the GenAI task](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#define-the-genai-task) - * [Full example](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#full-example) - * [Syntax](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#syntax) + * [Define a connection string](#define-a-connection-string) + * [Define the GenAI task](#define-the-genai-task) + * [Full example](#full-example) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx index 450f12c126..2eb10acf59 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/content/_create-gen-ai-task_api-python.mdx @@ -21,7 +21,7 @@ import Panel from "@site/src/components/Panel"; 5. And finally, runs a user-defined script that potentially acts upon the results. * The main steps in defining a GenAI task are: - * Defining a [Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) + * Defining a [Connection string](#defining-a-connection-string) to the AI model * Defining a [Context generation script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) * Defining a [Prompt](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt) @@ -29,9 +29,9 @@ import Panel from "@site/src/components/Panel"; * Defining an [Update script](../../../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) * In this article: - * [Defining a Connection string](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-a-connection-string) - * [Defining the GenAI task](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#defining-the-genai-task) - * [Full example](../../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#full-example) + * [Defining a Connection string](#defining-a-connection-string) + * [Defining the GenAI task](#defining-the-genai-task) + * [Full example](#full-example) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx index 2258a6b74e..57d95c9cbd 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx @@ -15,13 +15,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: - * [The GenAI Task wizard](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#the-genai-task-wizard) - * [Add a GenAI Task](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#add-a-genai-task) - * [Configure basic settings](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#configure-basic-settings) - * [Generate context objects](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#generate-context-objects) - * [Define Prompt and JSON schema](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#define-prompt-and-json-schema) - * [Provide update script](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#provide-update-script) - * [Review configuration and Save task](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#review-configuration-and-save-task) + * [The GenAI Task wizard](#the-genai-task-wizard) + * [Add a GenAI Task](#add-a-genai-task) + * [Configure basic settings](#configure-basic-settings) + * [Generate context objects](#generate-context-objects) + * [Define Prompt and JSON schema](#define-prompt-and-json-schema) + * [Provide update script](#provide-update-script) + * [Review configuration and Save task](#review-configuration-and-save-task) @@ -170,7 +170,7 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * **Select a document from the source collection** Select a document to test your context generation script on. * To use the same sample document we're using to demonstrate the process, - add [posts/1](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#sample-data) and select it here. + add [posts/1](#sample-data) and select it here. * Or if you prefer it, click `enter a document manually` and enter the sample document content yourself. * To run the test, click the **Test context** button. If all works well, you will see a list of context objects created by your script, one for each comment. @@ -181,7 +181,7 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Configure basic settings](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#configure-basic-settings). + Click to return to the previous step, [Configure basic settings](#configure-basic-settings). * **Test Context** Click to test your context generation script on the document selected/entered in the playground area. * You do not have to use the playground; you'll be able to define and save your task without testing @@ -189,7 +189,7 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * However, running the test here will allow you to use the generated result set in the playground of the next wizard step. * **Next** - Click to advance to the next step, [Define prompt & JSON schema](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#define-prompt-and-json-schema). + Click to advance to the next step, [Define prompt & JSON schema](#define-prompt-and-json-schema).
@@ -288,12 +288,12 @@ To add a new GenAI task, open: **AI Hub** > **AI Tasks** > **Add AI Task** * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Generate context objects](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#generate-context-objects). + Click to return to the previous step, [Generate context objects](#generate-context-objects). * **Test Context** Click to test the prompt and JSON schema you define above, on the context objects generated from the document you provided. * **Next** - Click to advance to the next step, [Provide update script](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#provide-update-script). + Click to advance to the next step, [Provide update script](#provide-update-script).
@@ -339,14 +339,14 @@ The update script set in this step, determines what actions should be taken on t * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Define Prompt and JSON schema](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#define-prompt-and-json-schema). + Click to return to the previous step, [Define Prompt and JSON schema](#define-prompt-and-json-schema). * **Test Context** Click to test the update script you define above. Note that even though in our case we remove comments from existing documents, the update script can leave the original document unchanged, create new documents, and so on - as you choose. * **Next** - Click to advance to the next step, [Review configuration and Save task](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#review-configuration-and-save-task). + Click to advance to the next step, [Review configuration and Save task](#review-configuration-and-save-task).
@@ -372,7 +372,7 @@ If your task is enabled, it will start running when you save it. * **Cancel** Click to cancel any changes made in the task. * **Back** - Click to return to the previous step, [Provide update script](../../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#provide-update-script). + Click to return to the previous step, [Provide update script](#provide-update-script). * **Save** Click to save your task. If enabled, saving the task will start its execution. diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx index 291d2be553..29b971a4a3 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx @@ -19,7 +19,7 @@ regarding the safety of data sent to an AI model through the task and the security of the database while running such tasks. * In this article: - * [Security measures](../../ai-integration/gen-ai-integration/gen-ai-security-concerns.mdx#security-measures) + * [Security measures](#security-measures) ## Security measures diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx index 23f713eeaa..4fe32ed6c5 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-csharp.mdx @@ -16,8 +16,8 @@ import Panel from "@site/src/components/Panel"; See the examples below to learn how to extract the `TaskID` and use it to register the modified task configuration. * In this article: - * [Modify task configuration](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#modify-task-configuration) - * [Syntax](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#syntax) + * [Modify task configuration](#modify-task-configuration) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx index 0e72ee03af..ae23735217 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-nodejs.mdx @@ -25,8 +25,8 @@ import Panel from "@site/src/components/Panel"; See the examples below to learn how to extract the _taskID_ and use it to register the modified task configuration. * In this article: - * [Modify task configuration](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#modify-task-configuration) - * [Syntax](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#syntax) + * [Modify task configuration](#modify-task-configuration) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx index ee32e1433c..54c43d957e 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/modify-gen-ai-task/content/_modify-gen-ai-task_api-python.mdx @@ -16,8 +16,8 @@ import Panel from "@site/src/components/Panel"; See the examples below to learn how to extract the `task_id` and use it to register the modified task configuration. * In this article: - * [Modify task configuration](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#modify-task-configuration) - * [Syntax](../../../../ai-integration/gen-ai-integration/modify-gen-ai-task/modify-gen-ai-task_api.mdx#syntax) + * [Modify task configuration](#modify-task-configuration) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/overview.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/overview.mdx index 17fcada6e1..3030cb8779 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/overview.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/overview.mdx @@ -21,20 +21,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; While creating a GenAI task via Studio, a smart interactive **test environment** is provided, allowing each phase of the task to be tested in a secluded playground, freely and without changing your data, while at the same time producing a result set that can be tried out by the next phase. * A task can be built in minutes, e.g. to generate automated responses to frequently asked questions, escalate support tickets, summarize lengthy documents, enhance data security by detecting anomalies, or numerous other applications. - See a few additional examples in the [common use cases](../../ai-integration/gen-ai-integration/overview.mdx#common-use-cases) section below. + See a few additional examples in the [common use cases](#common-use-cases) section below. * You can use local and remote AI models, e.g. a local `Ollama llama3.2` service during a development phase that requires speed and no additional costs, and a remote `OpenAI gpt-4o-mini` when you need a live service with advanced capabilities. * In this article: - * [RavenDB GenAI tasks](../../ai-integration/gen-ai-integration/overview.mdx#ravendb-genai-tasks) - * [The flow](../../ai-integration/gen-ai-integration/overview.mdx#the-flow) - * [The elements](../../ai-integration/gen-ai-integration/overview.mdx#the-elements) - * [How to create and run a GenAI task](../../ai-integration/gen-ai-integration/overview.mdx#how-to-create-and-run-a-genai-task) - * [Runtime](../../ai-integration/gen-ai-integration/overview.mdx#runtime) - * [Tracking of processed document parts](../../ai-integration/gen-ai-integration/overview.mdx#tracking-of-processed-document-parts) - * [Licensing](../../ai-integration/gen-ai-integration/overview.mdx#licensing) - * [Supported services](../../ai-integration/gen-ai-integration/overview.mdx#supported-services) - * [Common use cases](../../ai-integration/gen-ai-integration/overview.mdx#common-use-cases) + * [RavenDB GenAI tasks](#ravendb-genai-tasks) + * [The flow](#the-flow) + * [The elements](#the-elements) + * [How to create and run a GenAI task](#how-to-create-and-run-a-genai-task) + * [Runtime](#runtime) + * [Tracking of processed document parts](#tracking-of-processed-document-parts) + * [Licensing](#licensing) + * [Supported services](#supported-services) + * [Common use cases](#common-use-cases) @@ -51,18 +51,18 @@ Let's put the stages described above in order. 1. A GenAI task continuously monitors the collection it is associated with. 2. When a document is added or modified, the task retrieves it. 3. The task generates context objects based on the source document data. - To generate these objects, the task applies a user-defined [context generation script](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_context-objects) + To generate these objects, the task applies a user-defined [context generation script](#the-elements_context-objects) that runs through the source document and generates context objects based on the document data. 4. The task sends each context object to a GenAI model for processing. * The task is associated with a [Connection string](../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_studio.mdx#studio_connection-string) that defines how to connect to the AI model. * Each context object is sent via a separate connection to the AI model. (note that the number of concurrent connections to the AI model is configurable via the [MaxConcurrency](../../ai-integration/gen-ai-integration/create-gen-ai-task/create-gen-ai-task_api.mdx#genaiconfiguration) setting.) - * Each context object is sent along with a user-defined [Prompt](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_prompt), + * Each context object is sent along with a user-defined [Prompt](#the-elements_prompt), that instructs the AI model what to do with the data, and - a user-defined [JSON schema](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_json-schema) + a user-defined [JSON schema](#the-elements_json-schema) that instructs the AI model how to shape its response. -5. When the AI model returns its response, a user-defined [Update script](../../ai-integration/gen-ai-integration/overview.mdx#the-elements_update-script) +5. When the AI model returns its response, a user-defined [Update script](#the-elements_update-script) is applied to handle the results. ### The elements: diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx index 27adbb822c..4a487b8ba6 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-csharp.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; PDF files are sent to the LLM in base64-encoded strings. * In this article: - * [Sending attachments to the LLM](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_api.mdx#sending-attachments-to-the-llm) + * [Sending attachments to the LLM](#sending-attachments-to-the-llm) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx index 4c105ba21d..df05388ee2 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-nodejs.mdx @@ -24,7 +24,7 @@ import Panel from "@site/src/components/Panel"; is available in [Processing attachments: Studio](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx). * In this article: - * [Sending attachments to the LLM - via the Client API](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_api.mdx#sending-attachments-to-the-llm) + * [Sending attachments to the LLM - via the Client API](#sending-attachments-to-the-llm) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx index 5acf7b92da..715da967c6 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/content/_processing-attachments_api-python.mdx @@ -20,7 +20,7 @@ import Panel from "@site/src/components/Panel"; PDF files are sent to the LLM in base64-encoded strings. * In this article: - * [Sending attachments to the LLM](../../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_api.mdx#sending-attachments-to-the-llm) + * [Sending attachments to the LLM](#sending-attachments-to-the-llm) diff --git a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx index b0b2705962..d979c2e4d2 100644 --- a/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx +++ b/versioned_docs/version-7.1/ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx @@ -30,13 +30,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; E.g., to process image files you can use OpenAI's `gpt-4.1-mini` model. * In this article: - * [Include attachments in the Context generation script](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#include-attachments-in-the-context-generation-script) - * [Conditional attachment](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#conditional-attachment) - * [Multiple attachments](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#multiple-attachments) - * [Embedding base64-encoded images in the context object](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#embedding-base64-encoded-images-in-the-context-object) - * [Embedding text in the context object](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#embedding-text-in-the-context-object) - * [Set task Prompt and JSON schema](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#set-task-prompt-and-json-schema) - * [Set task Update script](../../../ai-integration/gen-ai-integration/process-attachments/processing-attachments_studio.mdx#set-task-update-script) + * [Include attachments in the Context generation script](#include-attachments-in-the-context-generation-script) + * [Conditional attachment](#conditional-attachment) + * [Multiple attachments](#multiple-attachments) + * [Embedding base64-encoded images in the context object](#embedding-base64-encoded-images-in-the-context-object) + * [Embedding text in the context object](#embedding-text-in-the-context-object) + * [Set task Prompt and JSON schema](#set-task-prompt-and-json-schema) + * [Set task Update script](#set-task-update-script) diff --git a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx index b17d84e2f1..d4f6804bf1 100644 --- a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-csharp.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; to understand the embeddings generation process flow. * In this article: - * [Configuring an embeddings generation task - from the Studio](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-studio) - * [Configuring an embeddings generation task - from the Client API](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-client-api) - * [Define source using PATHS](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-paths) - * [Define source using SCRIPT](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) - * [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) - * [Syntax](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#syntax) + * [Configuring an embeddings generation task - from the Studio](#configuring-an-embeddings-generation-task-from-the-studio) + * [Configuring an embeddings generation task - from the Client API](#configuring-an-embeddings-generation-task-from-the-client-api) + * [Define source using PATHS](#configure-an-embeddings-generation-task---define-source-using-paths) + * [Define source using SCRIPT](#configure-an-embeddings-generation-task---define-source-using-script) + * [Chunking methods and tokens](#chunking-methods-and-tokens) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; Enter the property name from the document that contains the text for embedding generation. * **Chunking method** Select the method for splitting the source text into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). * **Overlap tokens** @@ -104,7 +104,7 @@ import Panel from '@site/src/components/Panel'; 1. **Embeddings source** Select `Script` to define the source content and chunking methods using a JavaScript script. 2. **Script** - Refer to section [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) for available JavaScript methods. + Refer to section [Chunking methods and tokens](#chunking-methods-and-tokens) for available JavaScript methods. 3. **Default chunking method** The selected chunking method will be used by default when no method is specified in the script. e.g., when the script contains: `Name: this.Name`. @@ -146,7 +146,7 @@ import Panel from '@site/src/components/Panel'; generated by the task for **search terms in vector search queries**. 2. **Chunking method** Select the method for splitting the search term into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). 3. **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). 4. **Overlap tokens** @@ -265,7 +265,7 @@ var addAiIntegrationTaskResult = store.Maintenance.Send(addEmbeddingsGenerationT Each KEY in the object represents a document field, and the VALUE is a text-splitting function that processes the field's content before generating embeddings. * These methods ensure that the text chunks derived from document fields stay within the token limits required by the provider, preventing request rejection. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * For example: diff --git a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx index b221455abd..b8bc4d4505 100644 --- a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_embeddings-generation-task-nodejs.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; to understand the embeddings generation process flow. * In this article: - * [Configuring an embeddings generation task - from the Studio](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-studio) - * [Configuring an embeddings generation task - from the Client API](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task-from-the-client-api) - * [Define source using PATHS](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-paths) - * [Define source using SCRIPT](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configure-an-embeddings-generation-task---define-source-using-script) - * [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) - * [Syntax](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#syntax) + * [Configuring an embeddings generation task - from the Studio](#configuring-an-embeddings-generation-task-from-the-studio) + * [Configuring an embeddings generation task - from the Client API](#configuring-an-embeddings-generation-task-from-the-client-api) + * [Define source using PATHS](#configure-an-embeddings-generation-task---define-source-using-paths) + * [Define source using SCRIPT](#configure-an-embeddings-generation-task---define-source-using-script) + * [Chunking methods and tokens](#chunking-methods-and-tokens) + * [Syntax](#syntax) @@ -84,7 +84,7 @@ import Panel from '@site/src/components/Panel'; Enter the property name from the document that contains the text for embedding generation. * **Chunking method** Select the method for splitting the source text into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). * **Overlap tokens** @@ -104,7 +104,7 @@ import Panel from '@site/src/components/Panel'; 1. **Embeddings source** Select `Script` to define the source content and chunking methods using a JavaScript script. 2. **Script** - Refer to section [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens) for available JavaScript methods. + Refer to section [Chunking methods and tokens](#chunking-methods-and-tokens) for available JavaScript methods. 3. **Default chunking method** The selected chunking method will be used by default when no method is specified in the script. e.g., when the script contains: `Name: this.Name`. @@ -146,7 +146,7 @@ import Panel from '@site/src/components/Panel'; generated by the task for **search terms in vector search queries**. 2. **Chunking method** Select the method for splitting the search term into chunks. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). 3. **Max tokens per chunk** Enter the maximum number of tokens allowed per chunk (this depends on the service provider). 4. **Overlap tokens** @@ -255,7 +255,7 @@ const addAiIntegrationTaskResult = Each KEY in the object represents a document field, and the VALUE is a text-splitting function that processes the field's content before generating embeddings. * These methods ensure that the text chunks derived from document fields stay within the token limits required by the provider, preventing request rejection. - Learn more in [Chunking methods and tokens](../../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#chunking-methods-and-tokens). + Learn more in [Chunking methods and tokens](#chunking-methods-and-tokens). * For example: diff --git a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-csharp.mdx b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-csharp.mdx index 65e864a516..c5cba755d6 100644 --- a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-csharp.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; **embeddings generation tasks** using external service providers, as explained below. * In this article: - * [Embeddings generation - overview](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation-overview) - * [Embeddings generation - process flow](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---process-flow) - * [Supported providers](../../../ai-integration/generating-embeddings/overview.mdx#supported-providers) - * [Creating an embeddings generation task](../../../ai-integration/generating-embeddings/overview.mdx#creating-an-embeddings-generation-task) - * [Monitoring the tasks](../../../ai-integration/generating-embeddings/overview.mdx#monitoring-the-tasks) - * [Get embeddings generation task details](../../../ai-integration/generating-embeddings/overview.mdx#get-embeddings-generation-task-details) + * [Embeddings generation - overview](#embeddings-generation-overview) + * [Embeddings generation - process flow](#embeddings-generation---process-flow) + * [Supported providers](#supported-providers) + * [Creating an embeddings generation task](#creating-an-embeddings-generation-task) + * [Monitoring the tasks](#monitoring-the-tasks) + * [Get embeddings generation task details](#get-embeddings-generation-task-details) diff --git a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-nodejs.mdx index 5d4ddd0ad4..91e345dd0c 100644 --- a/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/generating-embeddings/content/_overview-nodejs.mdx @@ -16,12 +16,12 @@ import Panel from '@site/src/components/Panel'; **embeddings generation tasks** using external service providers, as explained below. * In this article: - * [Embeddings generation - overview](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation-overview) - * [Embeddings generation - process flow](../../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---process-flow) - * [Supported providers](../../../ai-integration/generating-embeddings/overview.mdx#supported-providers) - * [Creating an embeddings generation task](../../../ai-integration/generating-embeddings/overview.mdx#creating-an-embeddings-generation-task) - * [Monitoring the tasks](../../../ai-integration/generating-embeddings/overview.mdx#monitoring-the-tasks) - * [Get embeddings generation task details](../../../ai-integration/generating-embeddings/overview.mdx#get-embeddings-generation-task-details) + * [Embeddings generation - overview](#embeddings-generation-overview) + * [Embeddings generation - process flow](#embeddings-generation---process-flow) + * [Supported providers](#supported-providers) + * [Creating an embeddings generation task](#creating-an-embeddings-generation-task) + * [Monitoring the tasks](#monitoring-the-tasks) + * [Get embeddings generation task details](#get-embeddings-generation-task-details) diff --git a/versioned_docs/version-7.1/ai-integration/generating-embeddings/embedding-collections.mdx b/versioned_docs/version-7.1/ai-integration/generating-embeddings/embedding-collections.mdx index 69d40d8d32..d10ac65361 100644 --- a/versioned_docs/version-7.1/ai-integration/generating-embeddings/embedding-collections.mdx +++ b/versioned_docs/version-7.1/ai-integration/generating-embeddings/embedding-collections.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; It is recommended to first refer to this [Overview](../../ai-integration/generating-embeddings/overview.mdx#embeddings-generation---overview) to understand the embeddings generation process flow. * In this article: - * [The embeddings collections](../../ai-integration/generating-embeddings/embedding-collections.mdx#the-embeddings-collections) - * [The embeddings cache collection](../../ai-integration/generating-embeddings/embedding-collections.mdx#the-embeddings-cache-collection) + * [The embeddings collections](#the-embeddings-collections) + * [The embeddings cache collection](#the-embeddings-cache-collection) ## The embeddings collections diff --git a/versioned_docs/version-7.1/ai-integration/start.mdx b/versioned_docs/version-7.1/ai-integration/start.mdx index d27b45dbb0..8adcd59060 100644 --- a/versioned_docs/version-7.1/ai-integration/start.mdx +++ b/versioned_docs/version-7.1/ai-integration/start.mdx @@ -23,7 +23,7 @@ Ship AI-powered features faster with RavenDB’s native tools. ### Native AI features that create intelligent applications RavenDB is equipped with a set of powerful native AI features that can be used independently or in conjunction with each other, allowing you to easily integrate advanced AI capabilities into your applications. -These features include [AI agents](../ai-integration/start.mdx#ai-agents), [GenAI tasks](../ai-integration/start.mdx#genai-tasks), [Embeddings generation](../ai-integration/start.mdx#embeddings-generation), and [Vector search](../ai-integration/start.mdx#vector-search). +These features include [AI agents](#ai-agents), [GenAI tasks](#genai-tasks), [Embeddings generation](#embeddings-generation), and [Vector search](#vector-search). ### Use cases RavenDB AI features help you ship any AI-related scenario quickly, including: diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx index dedd319a35..1e980239a4 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-csharp.mdx @@ -14,10 +14,10 @@ import Panel from '@site/src/components/Panel'; Learn more in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). * In this article: - * [Supported data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#supported-data-types-for-vector-search) - * [Textual data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#textual-data) - * [Numerical data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#numerical-data) - * [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) + * [Supported data types for vector search](#supported-data-types-for-vector-search) + * [Textual data](#textual-data) + * [Numerical data](#numerical-data) + * [RavenVector](#ravenvector) @@ -41,7 +41,7 @@ import Panel from '@site/src/components/Panel'; * Ensure that all vectors within this field across all documents in the collection are generated by the **same model** and model version and have the **same dimensions**. * Consistency in both dimensionality and model source is crucial for meaningful comparisons in the vector space. -* In addition to the native types described below, we highly recommended using [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) +* In addition to the native types described below, we highly recommended using [RavenVector](#ravenvector) for efficient storage and fast queries when working with numerical embeddings. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx index af637aa673..d671308e85 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_data-types-for-vector-search-nodejs.mdx @@ -14,10 +14,10 @@ import Panel from '@site/src/components/Panel'; Learn more in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). * In this article: - * [Supported data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#supported-data-types-for-vector-search) - * [Textual data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#textual-data) - * [Numerical data](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#numerical-data) - * [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) + * [Supported data types for vector search](#supported-data-types-for-vector-search) + * [Textual data](#textual-data) + * [Numerical data](#numerical-data) + * [RavenVector](#ravenvector) @@ -41,7 +41,7 @@ import Panel from '@site/src/components/Panel'; * Ensure that all vectors within this field across all documents in the collection are generated by the **same model** and model version and have the **same dimensions**. * Consistency in both dimensionality and model source is crucial for meaningful comparisons in the vector space. -* In addition to the native types described below, we highly recommended using [RavenVector](../../../ai-integration/vector-search/data-types-for-vector-search.mdx#ravenvector) +* In addition to the native types described below, we highly recommended using [RavenVector](#ravenvector) for efficient storage and fast queries when working with numerical embeddings. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx index 86b063916a..6d982a5ef0 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; indexing a vector field. * In this article: - * [Overview](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#overview) - * [Indexing TEXT attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-text-attachments) - * [Indexing NUMERICAL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-numerical-attachments) - * [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) - * [JS index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#js-index) - * [Indexing ALL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-all-attachments) + * [Overview](#overview) + * [Indexing TEXT attachments](#indexing-text-attachments) + * [Indexing NUMERICAL attachments](#indexing-numerical-attachments) + * [LINQ index](#linq-index) + * [JS index](#js-index) + * [Indexing ALL attachments](#indexing-all-attachments) @@ -601,7 +601,7 @@ where vector.search(VectorFromAttachment, $queryVector) ### JS index -* The following is the JavaScript index format equivalent to the [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) shown above. +* The following is the JavaScript index format equivalent to the [LINQ index](#linq-index) shown above. * The main difference is that JavaScript indexes do Not support `getContentAsStream()` on attachment objects: * Because of this, embedding vectors must be stored in attachments as **Base64-encoded strings**. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx index 7de16bcde6..7b28ee24a7 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; indexing a vector field. * In this article: - * [Overview](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#overview) - * [Indexing TEXT attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-text-attachments) - * [Indexing NUMERICAL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-numerical-attachments) - * [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) - * [JS index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#js-index) - * [Indexing ALL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-all-attachments) + * [Overview](#overview) + * [Indexing TEXT attachments](#indexing-text-attachments) + * [Indexing NUMERICAL attachments](#indexing-numerical-attachments) + * [LINQ index](#linq-index) + * [JS index](#js-index) + * [Indexing ALL attachments](#indexing-all-attachments) diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx index 68d4ee3719..f3247127d9 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_indexing-attachments-for-vector-search-python.mdx @@ -11,12 +11,12 @@ import TabItem from '@theme/TabItem'; indexing a vector field. * In this article: - * [Overview](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#overview) - * [Indexing TEXT attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-text-attachments) - * [Indexing NUMERICAL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-numerical-attachments) - * [LINQ index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#linq-index) - * [JS index](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#js-index) - * [Indexing ALL attachments](../../../ai-integration/vector-search/indexing-attachments-for-vector-search.mdx#indexing-all-attachments) + * [Overview](#overview) + * [Indexing TEXT attachments](#indexing-text-attachments) + * [Indexing NUMERICAL attachments](#indexing-numerical-attachments) + * [LINQ index](#linq-index) + * [JS index](#js-index) + * [Indexing ALL attachments](#indexing-all-attachments) diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx index f7adb8ceed..7855a9619e 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-csharp.mdx @@ -9,23 +9,23 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to run a vector search using a static-index, see [vector search using a static-index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx). * In this article: - * [What is a vector search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#what-is-a-vector-search) - * [Dynamic vector search - query overview](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---query-overview) - * [Creating embeddings for the auto-index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#creating-embeddings-for-the-auto-index) - * [Retrieving results](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#retrieving-results) - * [The dynamic query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) - * [Corax auto-indexes](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) - * [Dynamic vector search - querying TEXT](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - * [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text) - * [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks) - * [Dynamic vector search - querying NUMERICAL content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content) - * [Dynamic vector search - querying for similar documents](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents) - * [Dynamic vector search - exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) - * [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) - * [Querying vector fields and regular data in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-vector-fields-and-regular-data-in-the-same-query) - * [How filtered vector search works](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#how-filtered-vector-search-works) - * [Combining multiple vector searches in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#combining-multiple-vector-searches-in-the-same-query) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#syntax) + * [What is a vector search](#what-is-a-vector-search) + * [Dynamic vector search - query overview](#dynamic-vector-search---query-overview) + * [Creating embeddings for the auto-index](#creating-embeddings-for-the-auto-index) + * [Retrieving results](#retrieving-results) + * [The dynamic query parameters](#the-dynamic-query-parameters) + * [Corax auto-indexes](#corax-auto-indexes) + * [Dynamic vector search - querying TEXT](#dynamic-vector-search---querying-text) + * [Querying raw text](#querying-raw-text) + * [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks) + * [Dynamic vector search - querying NUMERICAL content](#dynamic-vector-search---querying-numerical-content) + * [Dynamic vector search - querying for similar documents](#dynamic-vector-search---querying-for-similar-documents) + * [Dynamic vector search - exact search](#dynamic-vector-search---exact-search) + * [Quantization options](#quantization-options) + * [Querying vector fields and regular data in the same query](#querying-vector-fields-and-regular-data-in-the-same-query) + * [How filtered vector search works](#how-filtered-vector-search-works) + * [Combining multiple vector searches in the same query](#combining-multiple-vector-searches-in-the-same-query) + * [Syntax](#syntax) @@ -51,7 +51,7 @@ import CodeBlock from '@theme/CodeBlock'; * Note: Vector search queries cannot be used with [Subscription queries](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query). -* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) to process the query, +* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](#corax-auto-indexes) to process the query, and the results are retrieved from that index. * To make a **dynamic vector search query**: @@ -71,17 +71,17 @@ import CodeBlock from '@theme/CodeBlock'; Embeddings can be created from textual content in your documents by defining [Tasks that generate embeddings](../../../ai-integration/generating-embeddings/overview.mdx). When performing a dynamic vector search query over textual data and explicitly specifying the task, results will be retrieved by comparing your search term against the embeddings previously generated by that task. - A query example is available in: [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks). + A query example is available in: [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks). * **Default embeddings generation**: When querying textual data without specifying a task, RavenDB generates an embedding vector for the specified document field in each document of the queried collection, using the built-in [bge-micro-v2](https://huggingface.co/TaylorAI/bge-micro-v2) sentence-transformer model. - A query example is available in: [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). + A query example is available in: [Querying raw text](#querying-raw-text). * **Creating embeddings from NUMERICAL arrays**: When querying over pre-made numerical arrays that are already in vector format, RavenDB will index them without transformation (unless further quantization is applied). - A query example is available in: [Vector search on numerical content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + A query example is available in: [Vector search on numerical content](#dynamic-vector-search---querying-numerical-content). To avoid index errors, ensure that the dimensionality of these numerical arrays (i.e., their length) is consistent across all your source documents for the field you are querying. @@ -91,7 +91,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Quantizing the embeddings**: The embeddings are quantized based on the parameters specified in the query. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Indexing the embeddings**: RavenDB indexes the embeddings on the server using the [HNSW algorithm](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world). @@ -107,7 +107,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Processing the query**: To ensure consistent comparisons, the **search term** is transformed into an embedding vector using the same method as the document fields. The server will search for the most similar vectors in the indexed vector space, - taking into account all the [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) described below. + taking into account all the [query parameters](#the-dynamic-query-parameters) described below. The documents that correspond to the resulting vectors are then returned to the client. * **Search results**: @@ -127,7 +127,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Target quantization** You can specify the quantization encoding for the embeddings that will be created from source data. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Minimum similarity** You can specify the minimum similarity to use when searching for related vectors. @@ -155,7 +155,7 @@ import CodeBlock from '@theme/CodeBlock'; * _Exact search_: Perform a thorough scan of the vectors to find the actual closest vectors, offering better accuracy but at a higher computational cost. - Learn more in [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search). + Learn more in [Exact search](#dynamic-vector-search---exact-search). @@ -201,7 +201,7 @@ import CodeBlock from '@theme/CodeBlock'; * Since this query does not specify a target quantization format, the generated embedding vectors will be encoded in the default _Single_ format (single-precision floating-point). - Refer to [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) for examples that specify the destination quantization. + Refer to [Quantization options](#quantization-options) for examples that specify the destination quantization. @@ -440,10 +440,10 @@ where vector.search(embedding.text(Name, ai.task('id-for-task-open-ai')), $searc numerical vector searches require your source data to already be in an embedding vector format. * If your raw data is in a _float_ format, you can request further quantization of the embeddings that will be indexed in the auto-index. - See an example of this in: [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + See an example of this in: [Quantization options](#quantization-options). * Raw data that is already formatted as _Int8_ or _Binary_ **cannot** be quantized to lower-form (e.g. Int8 -> Int1). - When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#vectorquanitzer). + When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](#vectorquanitzer). #### Sample data: @@ -778,8 +778,8 @@ where vector.search(TagsEmbeddedAsBase64, $queryVectorBase64) ## Dynamic vector search - querying for similar documents * In the above examples, to find documents with similar content, the query was given an arbitrary input - - either a [raw textual search term](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - or a [numerical query vector](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + either a [raw textual search term](#dynamic-vector-search---querying-text) + or a [numerical query vector](#dynamic-vector-search---querying-numerical-content). * RavenDB also allows you to search for documents whose content is similar to an **existing document**: @@ -1431,9 +1431,9 @@ RavenDB first evaluates the filter to determine how many documents match and the * The filter match count is **below** the scanning threshold (default: `1024`). Can be customized via the [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) configuration key. - * An [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) is explicitly requested. + * An [Exact search](#dynamic-vector-search---exact-search) is explicitly requested. * The requested _number of candidates_ exceeds half the filter match count. - Learn about the _number of candidates_ param in [The query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + Learn about the _number of candidates_ param in [The query parameters](#the-dynamic-query-parameters). In this mode, an exact search is performed over **only** the documents that match the filter. @@ -1601,7 +1601,7 @@ or * Each vector search clause is evaluated independently - the search algorithm runs separately for each vector field. * Each clause retrieves a limited number of candidates, determined by the _NumberOfCandidates_ parameter. - * You can explicitly set this value in the query clause, see [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + * You can explicitly set this value in the query clause, see [query parameters](#the-dynamic-query-parameters). * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key (default is 16). * **The final result set** is computed by applying the logical operators (and, or) between these independently retrieved sets. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx index 9778f8fe25..28f7794248 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-nodejs.mdx @@ -9,23 +9,23 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to run a vector search using a static-index, see [vector search using a static-index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx). * In this article: - * [What is a vector search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#what-is-a-vector-search) - * [Dynamic vector search - query overview](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---query-overview) - * [Creating embeddings for the auto-index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#creating-embeddings-for-the-auto-index) - * [Retrieving results](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#retrieving-results) - * [The dynamic query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) - * [Corax auto-indexes](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) - * [Dynamic vector search - querying TEXT](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - * [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text) - * [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks) - * [Dynamic vector search - querying NUMERICAL content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content) - * [Dynamic vector search - querying for similar documents](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents) - * [Dynamic vector search - exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) - * [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) - * [Querying vector fields and regular data in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-vector-fields-and-regular-data-in-the-same-query) - * [How filtered vector search works](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#how-filtered-vector-search-works) - * [Combining multiple vector searches in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#combining-multiple-vector-searches-in-the-same-query) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#syntax) + * [What is a vector search](#what-is-a-vector-search) + * [Dynamic vector search - query overview](#dynamic-vector-search---query-overview) + * [Creating embeddings for the auto-index](#creating-embeddings-for-the-auto-index) + * [Retrieving results](#retrieving-results) + * [The dynamic query parameters](#the-dynamic-query-parameters) + * [Corax auto-indexes](#corax-auto-indexes) + * [Dynamic vector search - querying TEXT](#dynamic-vector-search---querying-text) + * [Querying raw text](#querying-raw-text) + * [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks) + * [Dynamic vector search - querying NUMERICAL content](#dynamic-vector-search---querying-numerical-content) + * [Dynamic vector search - querying for similar documents](#dynamic-vector-search---querying-for-similar-documents) + * [Dynamic vector search - exact search](#dynamic-vector-search---exact-search) + * [Quantization options](#quantization-options) + * [Querying vector fields and regular data in the same query](#querying-vector-fields-and-regular-data-in-the-same-query) + * [How filtered vector search works](#how-filtered-vector-search-works) + * [Combining multiple vector searches in the same query](#combining-multiple-vector-searches-in-the-same-query) + * [Syntax](#syntax) @@ -51,7 +51,7 @@ import CodeBlock from '@theme/CodeBlock'; * Note: Vector search queries cannot be used with [Subscription queries](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query). -* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) to process the query, +* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](#corax-auto-indexes) to process the query, and the results are retrieved from that index. * To make a **dynamic vector search query**: @@ -71,17 +71,17 @@ import CodeBlock from '@theme/CodeBlock'; Embeddings can be created from textual content in your documents by defining [Tasks that generate embeddings](../../../ai-integration/generating-embeddings/overview.mdx). When performing a dynamic vector search query over textual data and explicitly specifying the task, results will be retrieved by comparing your search term against the embeddings previously generated by that task. - A query example is available in: [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks). + A query example is available in: [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks). * **Default embeddings generation**: When querying textual data without specifying a task, RavenDB generates an embedding vector for the specified document field in each document of the queried collection, using the built-in [bge-micro-v2](https://huggingface.co/TaylorAI/bge-micro-v2) sentence-transformer model. - A query example is available in: [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). + A query example is available in: [Querying raw text](#querying-raw-text). * **Creating embeddings from NUMERICAL arrays**: When querying over pre-made numerical arrays that are already in vector format, RavenDB will index them without transformation (unless further quantization is applied). - A query example is available in: [Vector search on numerical content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + A query example is available in: [Vector search on numerical content](#dynamic-vector-search---querying-numerical-content). To avoid index errors, ensure that the dimensionality of these numerical arrays (i.e., their length) is consistent across all your source documents for the field you are querying. @@ -91,7 +91,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Quantizing the embeddings**: The embeddings are quantized based on the parameters specified in the query. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Indexing the embeddings**: RavenDB indexes the embeddings on the server using the [HNSW algorithm](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world). @@ -107,7 +107,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Processing the query**: To ensure consistent comparisons, the **search term** is transformed into an embedding vector using the same method as the document fields. The server will search for the most similar vectors in the indexed vector space, - taking into account all the [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) described below. + taking into account all the [query parameters](#the-dynamic-query-parameters) described below. The documents that correspond to the resulting vectors are then returned to the client. * **Search results**: @@ -127,7 +127,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Target quantization** You can specify the quantization encoding for the embeddings that will be created from source data. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Minimum similarity** You can specify the minimum similarity to use when searching for related vectors. @@ -155,7 +155,7 @@ import CodeBlock from '@theme/CodeBlock'; * _Exact search_: Perform a thorough scan of the vectors to find the actual closest vectors, offering better accuracy but at a higher computational cost. - Learn more in [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search). + Learn more in [Exact search](#dynamic-vector-search---exact-search). @@ -201,7 +201,7 @@ import CodeBlock from '@theme/CodeBlock'; * Since this query does not specify a target quantization format, the generated embedding vectors will be encoded in the default _Single_ format (single-precision floating-point). - Refer to [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) for examples that specify the destination quantization. + Refer to [Quantization options](#quantization-options) for examples that specify the destination quantization. @@ -341,10 +341,10 @@ where vector.search(embedding.text(Name, ai.task('id-for-task-open-ai')), $searc numerical vector searches require your source data to already be in an embedding vector format. * If your raw data is in a _float_ format, you can request further quantization of the embeddings that will be indexed in the auto-index. - See an example of this in: [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + See an example of this in: [Quantization options](#quantization-options). * Raw data that is already formatted as _Int8_ or _Binary_ **cannot** be quantized to lower-form (e.g. Int8 -> Int1). - When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#vectorquanitzer). + When storing data in these formats in your documents, you should use [RavenDB’s `vectorQuantizer` methods](#vectorquanitzer). #### Sample data: @@ -585,8 +585,8 @@ where vector.search(tagsEmbeddedAsBase64, $queryVectorBase64) ## Dynamic vector search - querying for similar documents * In the above examples, to find documents with similar content, the query was given an arbitrary input - - either a [raw textual search term](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - or a [numerical query vector](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + either a [raw textual search term](#dynamic-vector-search---querying-text) + or a [numerical query vector](#dynamic-vector-search---querying-numerical-content). * RavenDB also allows you to search for documents whose content is similar to an **existing document**: @@ -978,9 +978,9 @@ RavenDB first evaluates the filter to determine how many documents match and the * The filter match count is **below** the scanning threshold (default: `1024`). Can be customized via the [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) configuration key. - * An [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) is explicitly requested. + * An [Exact search](#dynamic-vector-search---exact-search) is explicitly requested. * The requested _number of candidates_ exceeds half the filter match count. - Learn about the _number of candidates_ param in [The query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + Learn about the _number of candidates_ param in [The query parameters](#the-dynamic-query-parameters). In this mode, an exact search is performed over **only** the documents that match the filter. @@ -1098,7 +1098,7 @@ or * Each vector search clause is evaluated independently - the search algorithm runs separately for each vector field. * Each clause retrieves a limited number of candidates, determined by the _NumberOfCandidates_ parameter. - * You can explicitly set this value in the query clause, see [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + * You can explicitly set this value in the query clause, see [query parameters](#the-dynamic-query-parameters). * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key (default is 16). * **The final result set** is computed by applying the logical operators (and, or) between these independently retrieved sets. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx index 05f41a4669..b236554bb7 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-dynamic-query-python.mdx @@ -9,23 +9,23 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to run a vector search using a static-index, see [vector search using a static-index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx). * In this article: - * [What is a vector search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#what-is-a-vector-search) - * [Dynamic vector search - query overview](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---query-overview) - * [Creating embeddings for the auto-index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#creating-embeddings-for-the-auto-index) - * [Retrieving results](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#retrieving-results) - * [The dynamic query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) - * [Corax auto-indexes](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) - * [Dynamic vector search - querying TEXT](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - * [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text) - * [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks) - * [Dynamic vector search - querying NUMERICAL content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content) - * [Dynamic vector search - querying for similar documents](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents) - * [Dynamic vector search - exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) - * [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) - * [Querying vector fields and regular data in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-vector-fields-and-regular-data-in-the-same-query) - * [How filtered vector search works](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#how-filtered-vector-search-works) - * [Combining multiple vector searches in the same query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#combining-multiple-vector-searches-in-the-same-query) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#syntax) + * [What is a vector search](#what-is-a-vector-search) + * [Dynamic vector search - query overview](#dynamic-vector-search---query-overview) + * [Creating embeddings for the auto-index](#creating-embeddings-for-the-auto-index) + * [Retrieving results](#retrieving-results) + * [The dynamic query parameters](#the-dynamic-query-parameters) + * [Corax auto-indexes](#corax-auto-indexes) + * [Dynamic vector search - querying TEXT](#dynamic-vector-search---querying-text) + * [Querying raw text](#querying-raw-text) + * [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks) + * [Dynamic vector search - querying NUMERICAL content](#dynamic-vector-search---querying-numerical-content) + * [Dynamic vector search - querying for similar documents](#dynamic-vector-search---querying-for-similar-documents) + * [Dynamic vector search - exact search](#dynamic-vector-search---exact-search) + * [Quantization options](#quantization-options) + * [Querying vector fields and regular data in the same query](#querying-vector-fields-and-regular-data-in-the-same-query) + * [How filtered vector search works](#how-filtered-vector-search-works) + * [Combining multiple vector searches in the same query](#combining-multiple-vector-searches-in-the-same-query) + * [Syntax](#syntax) @@ -51,7 +51,7 @@ import CodeBlock from '@theme/CodeBlock'; * Note: Vector search queries cannot be used with [Subscription queries](../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query). -* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#corax-auto-indexes) to process the query, +* When executing a dynamic vector search query, RavenDB creates a [Corax Auto-Index](#corax-auto-indexes) to process the query, and the results are retrieved from that index. * To make a **dynamic vector search query**: @@ -71,17 +71,17 @@ import CodeBlock from '@theme/CodeBlock'; Embeddings can be created from textual content in your documents by defining [Tasks that generate embeddings](../../../ai-integration/generating-embeddings/overview.mdx). When performing a dynamic vector search query over textual data and explicitly specifying the task, results will be retrieved by comparing your search term against the embeddings previously generated by that task. - A query example is available in: [Querying pre-made embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-pre-made-embeddings-generated-by-tasks). + A query example is available in: [Querying pre-made embeddings generated by tasks](#querying-pre-made-embeddings-generated-by-tasks). * **Default embeddings generation**: When querying textual data without specifying a task, RavenDB generates an embedding vector for the specified document field in each document of the queried collection, using the built-in [bge-micro-v2](https://huggingface.co/TaylorAI/bge-micro-v2) sentence-transformer model. - A query example is available in: [Querying raw text](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). + A query example is available in: [Querying raw text](#querying-raw-text). * **Creating embeddings from NUMERICAL arrays**: When querying over pre-made numerical arrays that are already in vector format, RavenDB will index them without transformation (unless further quantization is applied). - A query example is available in: [Vector search on numerical content](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + A query example is available in: [Vector search on numerical content](#dynamic-vector-search---querying-numerical-content). To avoid index errors, ensure that the dimensionality of these numerical arrays (i.e., their length) is consistent across all your source documents for the field you are querying. @@ -91,7 +91,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Quantizing the embeddings**: The embeddings are quantized based on the parameters specified in the query. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Indexing the embeddings**: RavenDB indexes the embeddings on the server using the [HNSW algorithm](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world). @@ -107,7 +107,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Processing the query**: To ensure consistent comparisons, the **search term** is transformed into an embedding vector using the same method as the document fields. The server will search for the most similar vectors in the indexed vector space, - taking into account all the [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters) described below. + taking into account all the [query parameters](#the-dynamic-query-parameters) described below. The documents that correspond to the resulting vectors are then returned to the client. * **Search results**: @@ -127,7 +127,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Target quantization** You can specify the quantization encoding for the embeddings that will be created from source data. - Learn more about quantization in [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + Learn more about quantization in [Quantization options](#quantization-options). * **Minimum similarity** You can specify the minimum similarity to use when searching for related vectors. @@ -155,7 +155,7 @@ import CodeBlock from '@theme/CodeBlock'; * _Exact search_: Perform a thorough scan of the vectors to find the actual closest vectors, offering better accuracy but at a higher computational cost. - Learn more in [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search). + Learn more in [Exact search](#dynamic-vector-search---exact-search). @@ -201,7 +201,7 @@ import CodeBlock from '@theme/CodeBlock'; * Since this query does not specify a target quantization format, the generated embedding vectors will be encoded in the default _Single_ format (single-precision floating-point). - Refer to [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options) for examples that specify the destination quantization. + Refer to [Quantization options](#quantization-options) for examples that specify the destination quantization. @@ -306,10 +306,10 @@ where vector.search(embedding.text(Name, ai.task('id-for-task-open-ai')), $searc numerical vector searches require your source data to already be in an embedding vector format. * If your raw data is in a _float_ format, you can request further quantization of the embeddings that will be indexed in the auto-index. - See an example of this in: [Quantization options](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#quantization-options). + See an example of this in: [Quantization options](#quantization-options). * Raw data that is already formatted as _Int8_ or _Binary_ **cannot** be quantized to lower-form (e.g. Int8 -> Int1). - When storing data in these formats in your documents, you should use [RavenDB’s `VectorQuantizer` methods](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#vectorquantizer). + When storing data in these formats in your documents, you should use [RavenDB’s `VectorQuantizer` methods](#vectorquantizer). #### Sample data: @@ -529,8 +529,8 @@ where vector.search(tags_embedded_as_base_64, $queryVectorBase64) ## Dynamic vector search - querying for similar documents * In the above examples, to find documents with similar content, the query was given an arbitrary input - - either a [raw textual search term](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-text) - or a [numerical query vector](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-numerical-content). + either a [raw textual search term](#dynamic-vector-search---querying-text) + or a [numerical query vector](#dynamic-vector-search---querying-numerical-content). * RavenDB also allows you to search for documents whose content is similar to an **existing document**: @@ -836,9 +836,9 @@ RavenDB first evaluates the filter to determine how many documents match and the * The filter match count is **below** the scanning threshold (default: `1024`). Can be customized via the [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) configuration key. - * An [Exact search](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---exact-search) is explicitly requested. + * An [Exact search](#dynamic-vector-search---exact-search) is explicitly requested. * The requested _number of candidates_ exceeds half the filter match count. - Learn about the _number of candidates_ param in [The query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + Learn about the _number of candidates_ param in [The query parameters](#the-dynamic-query-parameters). In this mode, an exact search is performed over **only** the documents that match the filter. @@ -946,7 +946,7 @@ or * Each vector search clause is evaluated independently - the search algorithm runs separately for each vector field. * Each clause retrieves a limited number of candidates, determined by the _NumberOfCandidates_ parameter. - * You can explicitly set this value in the query clause, see [query parameters](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). + * You can explicitly set this value in the query clause, see [query parameters](#the-dynamic-query-parameters). * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key (default is 16). * **The final result set** is computed by applying the logical operators (and, or) between these independently retrieved sets. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx index 06981c3146..0dc75743db 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-csharp.mdx @@ -16,28 +16,28 @@ import ContentFrame from "@site/src/components/ContentFrame"; * The vector search feature is only supported by indexes that use the [Corax search engine](../../../indexes/search-engine/corax.mdx). * Vector fields are **not** supported in Map-Reduce indexes. - See [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + See [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) for a workaround that uses two separate indexes. * In this article: - * [Indexing a vector field - Overview](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-a-vector-field---overview) - * [Defining a vector field in a static index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#defining-a-vector-field-in-a-static-index) - * [Parameters defined in the index definition](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-in-the-index-definition) - * [Behavior during indexing](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#behavior-during-indexing) - * [Parameters used at query time](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-used-at-query-time) - * [Behavior when documents are deleted](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#vector-behavior-when-documents-are-deleted) - * [Indexing vector data - TEXT](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) - * [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text) - * [Indexing text-embeddings generated by tasks - from current document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document) - * [Indexing text-embeddings generated by tasks - from related document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-related-document) - * [Indexing vector data - NUMERICAL](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---numerical) - * [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input) - * [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input) - * [Indexing multiple field types](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-multiple-field-types) - * [Querying the static index for similar documents](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#querying-the-static-index-for-similar-documents) - * [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio) - * [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) - * [Syntax](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#syntax) + * [Indexing a vector field - Overview](#indexing-a-vector-field---overview) + * [Defining a vector field in a static index](#defining-a-vector-field-in-a-static-index) + * [Parameters defined in the index definition](#parameters-defined-in-the-index-definition) + * [Behavior during indexing](#behavior-during-indexing) + * [Parameters used at query time](#parameters-used-at-query-time) + * [Behavior when documents are deleted](#vector-behavior-when-documents-are-deleted) + * [Indexing vector data - TEXT](#indexing-vector-data---text) + * [Indexing raw text](#indexing-raw-text) + * [Indexing text-embeddings generated by tasks - from current document](#indexing-text-embeddings-generated-by-tasks---from-current-document) + * [Indexing text-embeddings generated by tasks - from related document](#indexing-text-embeddings-generated-by-tasks---from-related-document) + * [Indexing vector data - NUMERICAL](#indexing-vector-data---numerical) + * [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input) + * [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input) + * [Indexing multiple field types](#indexing-multiple-field-types) + * [Querying the static index for similar documents](#querying-the-static-index-for-similar-documents) + * [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio) + * [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) + * [Syntax](#syntax) @@ -54,16 +54,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; use the `LoadVector()` method in your index definition. The embeddings can be loaded either from the document currently being indexed or from a [related document](../../../indexes/indexing-related-documents.mdx#what-are-related-documents). Examples are available in: - [Indexing text-embeddings generated by tasks - from current document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document) - [Indexing text-embeddings generated by tasks - from related document](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-related-document) + [Indexing text-embeddings generated by tasks - from current document](#indexing-text-embeddings-generated-by-tasks---from-current-document) + [Indexing text-embeddings generated by tasks - from related document](#indexing-text-embeddings-generated-by-tasks---from-related-document) **`CreateVector()`**: When indexing **your own data** (textual or numerical) that was Not generated by the [Embeddings generation tasks](../../../ai-integration/generating-embeddings/overview.mdx), use the `CreateVector()` method in your index definition. - An example is available in [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). + An example is available in [Indexing raw text](#indexing-raw-text). * **From the Studio**: - See [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio). + See [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio). The **source data types** that can be used for vector search are detailed in [Data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx). @@ -189,7 +189,7 @@ In addition, you can apply any of the 'order by' methods to your query, as expla ### Indexing raw text The index in this example indexes data from raw text. -For an index that indexes pre-made text-embeddings see [this example below](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document). +For an index that indexes pre-made text-embeddings see [this example below](#indexing-text-embeddings-generated-by-tasks---from-current-document). The following index defines a **vector field** named `VectorfromText`. It indexes embeddings generated from the raw textual data in the `Name` field of all _Product_ documents. @@ -684,7 +684,7 @@ where exact(vector.search(VectorFromTextEmbeddings, $p0, 0.75, 20)) ### Indexing text-embeddings generated by tasks - from related document -The [previous example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-text-embeddings-generated-by-tasks---from-current-document) +The [previous example](#indexing-text-embeddings-generated-by-tasks---from-current-document) indexed pre-made embeddings that were generated from the **document currently being indexed**. However, you can also index pre-made embeddings that were generated from a **related document**. @@ -963,7 +963,7 @@ where vector.search(CategoryVectorFromTextEmbeddings, $searchTerm, 0.75, 20) * **Query using a numerical embedding (direct vector)**: You provide a numerical array as the search term, and RavenDB compares it directly against the indexed embeddings. - See [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input). + See [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input). * **Query using a text input**: You provide a text string as the search term and specify an existing [Embedding generation task](../../../ai-integration/generating-embeddings/overview.mdx) that will convert this text into a vector embedding. @@ -976,7 +976,7 @@ where vector.search(CategoryVectorFromTextEmbeddings, $searchTerm, 0.75, 20) This hybrid approach allows you to index custom embeddings (e.g., externally generated image vectors) while still benefiting from RavenDB’s ability to perform semantic text search, as long as the same model was used for both. - See [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input). + See [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input). * The examples in this section use the [sample data provided in the dynamic query article](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#sample-data). @@ -1953,7 +1953,7 @@ or vector.search(VectorFromText, $searchTerm2, 0.8) * Similar to [querying for similar documents using a dynamic query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents), you can **query a static-index for similar documents** by specifying a document ID in the vector search. -* The following example queries the static-index defined in [this example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) above. +* The following example queries the static-index defined in [this example](#indexing-vector-data---text) above. The document for which we want to find similar documents is specified by the document ID passed to the `ForDocument` method. * RavenDB retrieves the embedding that was indexed for the queried field in the specified document and uses it as the query vector for the similarity comparison. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx index 53974ffe74..abb9d094dd 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-nodejs.mdx @@ -16,26 +16,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; * The vector search feature is only supported by indexes that use the [Corax search engine](../../../indexes/search-engine/corax.mdx). * Vector fields are **not** supported in Map-Reduce indexes. - See [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + See [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) for a workaround that uses two separate indexes. * In this article: - * [Indexing a vector field - Overview](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-a-vector-field---overview) - * [Defining a vector field in a static index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#defining-a-vector-field-in-a-static-index) - * [Parameters defined in the index definition](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-in-the-index-definition) - * [Behavior during indexing](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#behavior-during-indexing) - * [Parameters used at query time](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-used-at-query-time) - * [Behavior when documents are deleted](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#vector-behavior-when-documents-are-deleted) - * [Indexing vector data - TEXT](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) - * [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text) - * [Indexing pre-made text-embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks) - * [Indexing vector data - NUMERICAL](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---numerical) - * [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input) - * [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input) - * [Indexing multiple field types](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-multiple-field-types) - * [Querying the static index for similar documents](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#querying-the-static-index-for-similar-documents) - * [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio) - * [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + * [Indexing a vector field - Overview](#indexing-a-vector-field---overview) + * [Defining a vector field in a static index](#defining-a-vector-field-in-a-static-index) + * [Parameters defined in the index definition](#parameters-defined-in-the-index-definition) + * [Behavior during indexing](#behavior-during-indexing) + * [Parameters used at query time](#parameters-used-at-query-time) + * [Behavior when documents are deleted](#vector-behavior-when-documents-are-deleted) + * [Indexing vector data - TEXT](#indexing-vector-data---text) + * [Indexing raw text](#indexing-raw-text) + * [Indexing pre-made text-embeddings generated by tasks](#indexing-pre-made-text-embeddings-generated-by-tasks) + * [Indexing vector data - NUMERICAL](#indexing-vector-data---numerical) + * [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input) + * [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input) + * [Indexing multiple field types](#indexing-multiple-field-types) + * [Querying the static index for similar documents](#querying-the-static-index-for-similar-documents) + * [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio) + * [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) @@ -52,15 +52,15 @@ To define a vector index-field in your static-index definition: **`loadVector()`**: When indexing **pre-made text-embeddings** generated by RavenDB's [Embeddings generation tasks](../../../ai-integration/generating-embeddings/overview.mdx), use the `loadVector()` method in your index definition. - An example is available in [Indexing pre-made text-embeddings](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). + An example is available in [Indexing pre-made text-embeddings](#indexing-pre-made-text-embeddings-generated-by-tasks). **`createVector()`**: When indexing **your own data** (textual or numerical) that was not generated by these tasks, use the `createVector()` method in your index definition. - An example is available in [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). + An example is available in [Indexing raw text](#indexing-raw-text). * **From the Studio**: - See [Configure the vector field in the Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-the-studio). + See [Configure the vector field in the Studio](#configure-the-vector-field-in-the-studio). The **source data types** that can be used for vector search are detailed in [Data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx). @@ -186,7 +186,7 @@ In addition, you can apply any of the 'order by' methods to your query, as expla ### Indexing raw text The index in this example indexes data from raw text. -For an index that indexes pre-made text-embeddings see [this example below](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). +For an index that indexes pre-made text-embeddings see [this example below](#indexing-pre-made-text-embeddings-generated-by-tasks). The following index defines a **vector field** named `vectorfromText`. It indexes embeddings generated from the raw textual data in the `Name` field of all _Product_ documents. @@ -457,7 +457,7 @@ where exact(vector.search(vectorFromTextEmbeddings, $p0, 0.75, 20)) * **Query using a numerical embedding (direct vector)**: You provide a numerical array as the search term, and RavenDB compares it directly against the indexed embeddings. - See [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input). + See [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input). * **Query using a text input**: You provide a text string as the search term and specify an existing [Embedding generation task](../../../ai-integration/generating-embeddings/overview.mdx) that will convert this text into a vector embedding. @@ -470,7 +470,7 @@ where exact(vector.search(vectorFromTextEmbeddings, $p0, 0.75, 20)) This hybrid approach allows you to index custom embeddings (e.g., externally generated image vectors) while still benefiting from RavenDB’s ability to perform semantic text search, as long as the same model was used for both. - See [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input). + See [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input). * The examples in this section use the [sample data provided in the dynamic query article](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#sample-data). @@ -998,7 +998,7 @@ or vector.search(vectorFromText, $searchTerm2, 0.8) * Similar to [querying for similar documents using a dynamic query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents), you can **query a static-index for similar documents** by specifying a document ID in the vector search. -* The following example queries the static-index defined in [this example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) above. +* The following example queries the static-index defined in [this example](#indexing-vector-data---text) above. The document for which we want to find similar documents is specified by the document ID passed to the `ForDocument` method. * RavenDB retrieves the embedding that was indexed for the queried field in the specified document and uses it as the query vector for the similarity comparison. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx index 5cf61a2784..12886b6d6b 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/content/_vector-search-using-static-index-python.mdx @@ -15,26 +15,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; * The vector search feature is only supported by indexes that use the [Corax search engine](../../../indexes/search-engine/corax.mdx). * Vector fields are **not** supported in Map-Reduce indexes. - See [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + See [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) for a workaround that uses two separate indexes. * In this article: - * [Indexing a vector field - Overview](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-a-vector-field---overview) - * [Defining a vector field in a static index](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#defining-a-vector-field-in-a-static-index) - * [Parameters defined in the index definition](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-in-the-index-definition) - * [Behavior during indexing](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#behavior-during-indexing) - * [Parameters used at query time](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-used-at-query-time) - * [Behavior when documents are deleted](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#vector-behavior-when-documents-are-deleted) - * [Indexing vector data - TEXT](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) - * [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text) - * [Indexing pre-made text-embeddings generated by tasks](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks) - * [Indexing vector data - NUMERICAL](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---numerical) - * [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input) - * [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input) - * [Indexing multiple field types](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-multiple-field-types) - * [Querying the static index for similar documents](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#querying-the-static-index-for-similar-documents) - * [Configure the vector field in Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-studio) - * [Combining vector search with Map-Reduce indexes](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#combining-vector-search-with-map-reduce-indexes) + * [Indexing a vector field - Overview](#indexing-a-vector-field---overview) + * [Defining a vector field in a static index](#defining-a-vector-field-in-a-static-index) + * [Parameters defined in the index definition](#parameters-defined-in-the-index-definition) + * [Behavior during indexing](#behavior-during-indexing) + * [Parameters used at query time](#parameters-used-at-query-time) + * [Behavior when documents are deleted](#vector-behavior-when-documents-are-deleted) + * [Indexing vector data - TEXT](#indexing-vector-data---text) + * [Indexing raw text](#indexing-raw-text) + * [Indexing pre-made text-embeddings generated by tasks](#indexing-pre-made-text-embeddings-generated-by-tasks) + * [Indexing vector data - NUMERICAL](#indexing-vector-data---numerical) + * [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input) + * [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input) + * [Indexing multiple field types](#indexing-multiple-field-types) + * [Querying the static index for similar documents](#querying-the-static-index-for-similar-documents) + * [Configure the vector field in Studio](#configure-the-vector-field-in-studio) + * [Combining vector search with Map-Reduce indexes](#combining-vector-search-with-map-reduce-indexes) @@ -51,15 +51,15 @@ To define a vector index-field in your static-index definition: **`LoadVector()`**: When indexing **pre-made text-embeddings** generated by RavenDB's [Embeddings generation tasks](../../../ai-integration/generating-embeddings/overview.mdx), use the `LoadVector()` method in your index definition. - An example is available in [Indexing pre-made text-embeddings](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). + An example is available in [Indexing pre-made text-embeddings](#indexing-pre-made-text-embeddings-generated-by-tasks). **`CreateVector()`**: When indexing **your own data** (textual or numerical) that was not generated by these tasks, use the `CreateVector()` method in your index definition. - An example is available in [Indexing raw text](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). + An example is available in [Indexing raw text](#indexing-raw-text). * **From Studio**: - See [Configure the vector field in Studio](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#configure-the-vector-field-in-studio). + See [Configure the vector field in Studio](#configure-the-vector-field-in-studio). The **source data types** that can be used for vector search are detailed in [Data types for vector search](../../../ai-integration/vector-search/data-types-for-vector-search.mdx). @@ -185,7 +185,7 @@ In addition, you can apply any of the 'order by' methods to your query, as expla ### Indexing raw text The index in this example indexes data from raw text. -For an index that indexes pre-made text-embeddings see [this example below](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-pre-made-text-embeddings-generated-by-tasks). +For an index that indexes pre-made text-embeddings see [this example below](#indexing-pre-made-text-embeddings-generated-by-tasks). The following index defines a **vector field** named `vector_from_text`. It indexes embeddings generated from the raw textual data in the `Name` field of all _Product_ documents. @@ -403,7 +403,7 @@ where exact(vector.search(vector_from_text_embeddings, $p0, 0.75, 20)) * **Query using a numerical embedding (direct vector)**: You provide a numerical array as the search term, and RavenDB compares it directly against the indexed embeddings. - See [Indexing numerical data and querying using numeric input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-numeric-input). + See [Indexing numerical data and querying using numeric input](#indexing-numerical-data-and-querying-using-numeric-input). * **Query using a text input**: You provide a text string as the search term and specify an existing [Embedding generation task](../../../ai-integration/generating-embeddings/overview.mdx) that will convert this text into a vector embedding. @@ -416,7 +416,7 @@ where exact(vector.search(vector_from_text_embeddings, $p0, 0.75, 20)) This hybrid approach allows you to index custom embeddings (e.g., externally generated image vectors) while still benefiting from RavenDB’s ability to perform semantic text search, as long as the same model was used for both. - See [Indexing numerical data and querying using text input](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-numerical-data-and-querying-using-text-input). + See [Indexing numerical data and querying using text input](#indexing-numerical-data-and-querying-using-text-input). * The examples in this section use the [sample data provided in the dynamic query article](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#sample-data). @@ -880,7 +880,7 @@ or vector.search(vector_from_text, $searchTerm2, 0.8) * Similar to [querying for similar documents using a dynamic query](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#dynamic-vector-search---querying-for-similar-documents), you can **query a static-index for similar documents** by specifying a document ID in the vector search. -* The following example queries the static-index defined in [this example](../../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-vector-data---text) above. +* The following example queries the static-index defined in [this example](#indexing-vector-data---text) above. The document for which we want to find similar documents is specified by the document ID passed to the `forDoc` method. * RavenDB retrieves the embedding that was indexed for the queried field in the specified document and uses it as the query vector for the similarity comparison. diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/overview.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/overview.mdx index 6f5398fba9..095c747a17 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/overview.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/overview.mdx @@ -16,11 +16,11 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [What is a vector database](../../ai-integration/vector-search/overview.mdx#what-is-a-vector-database) - * [Why choose RavenDB as your vector database](../../ai-integration/vector-search/overview.mdx#why-choose-ravendb-as-your-vector-database) - * [Vector search in RavenDB](../../ai-integration/vector-search/overview.mdx#vector-search-in-ravendb) - * [Vector search using a dynamic query](../../ai-integration/vector-search/overview.mdx#vector-search-using-a-dynamic-query) - * [Vector search using a static-index](../../ai-integration/vector-search/overview.mdx#vector-search-using-a-static-index) + * [What is a vector database](#what-is-a-vector-database) + * [Why choose RavenDB as your vector database](#why-choose-ravendb-as-your-vector-database) + * [Vector search in RavenDB](#vector-search-in-ravendb) + * [Vector search using a dynamic query](#vector-search-using-a-dynamic-query) + * [Vector search using a static-index](#vector-search-using-a-static-index) diff --git a/versioned_docs/version-7.1/ai-integration/vector-search/what-affects-vector-search-results.mdx b/versioned_docs/version-7.1/ai-integration/vector-search/what-affects-vector-search-results.mdx index e808b28d06..61a799cbbf 100644 --- a/versioned_docs/version-7.1/ai-integration/vector-search/what-affects-vector-search-results.mdx +++ b/versioned_docs/version-7.1/ai-integration/vector-search/what-affects-vector-search-results.mdx @@ -27,13 +27,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Several **indexing-time parameters** affect how the vector graph is built, and **query-time parameters** affect how the graph is searched. These settings influence the trade-off between speed and accuracy. -* If full accuracy is required, RavenDB also provides [Exact vector search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search), +* If full accuracy is required, RavenDB also provides [Exact vector search](#using-exact-search), which performs a full scan of all indexed vectors to guarantee the closest matches. * In this article: - * [The approximate nature of HNSW](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#the-approximate-nature-of-hnsw) - * [Indexing-time parameters](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#indexing-time-parameters) - * [Query-time parameters](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#query-time-parameters) - * [Using exact search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search) + * [The approximate nature of HNSW](#the-approximate-nature-of-hnsw) + * [Indexing-time parameters](#indexing-time-parameters) + * [Query-time parameters](#query-time-parameters) + * [Using exact search](#using-exact-search) @@ -45,7 +45,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Top layers are sparse and support fast, broad navigation. The bottom layer is dense and includes all indexed vectors for fine-grained matching. * Each node (vector) is connected only to a limited number of neighbors, selected as the most relevant during indexing (graph build time). - This limitation is controlled by the [Indexing-time parameters](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#indexing-time-parameters) described below. + This limitation is controlled by the [Indexing-time parameters](#indexing-time-parameters) described below. * This structure speeds up search but increases the chance that a relevant document is not reachable - especially if it's poorly connected. @@ -66,12 +66,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The algorithm doesn't exhaustively explore all possible paths, so it can miss the true global nearest neighbors - especially if they are not well-connected in the graph. This design enables HNSW to find relevant results very quickly by focusing only on the most promising paths, making it highly efficient even for large datasets. - * The search is influenced by the [Query-time params](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#query-time-parameters) described below. + * The search is influenced by the [Query-time params](#query-time-parameters) described below. Slight variations in graph structure or search parameters can lead to different results. * While HNSW offers fast search performance at scale and quickly finds points that are likely to be among the nearest neighbors, it does not guarantee exact results - only approximate matches are returned. This behavior is expected in all ANN algorithms, not just HNSW. - If full accuracy is critical, consider using [Exact search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search) instead. + If full accuracy is critical, consider using [Exact search](#using-exact-search) instead. ## Indexing-time parameters @@ -148,7 +148,7 @@ These parameters directly affect how many results are found, how similar they ar it is typically accurate and strongly recommended in most scenarios due to its performance. * **Exact search**: Performs a full comparison against all indexed vectors to guarantee the closest matches. - Learn more in [Using exact search](../../ai-integration/vector-search/what-affects-vector-search-results.mdx#using-exact-search) below. + Learn more in [Using exact search](#using-exact-search) below. For all parameters that can be defined at query time, see: Dynamic queries - [The dynamic query parameters](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#the-dynamic-query-parameters). diff --git a/versioned_docs/version-7.1/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx b/versioned_docs/version-7.1/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx index f77cb2aa73..16c0707759 100644 --- a/versioned_docs/version-7.1/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/bulk-insert/content/_how-to-work-with-bulk-insert-operation-csharp.mdx @@ -9,23 +9,23 @@ import ContentFrame from "@site/src/components/ContentFrame"; * `BulkInsert` is useful when inserting a large quantity of data from the client to the server. * It is an optimized time-saving approach with a few - [limitations](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#limitations) + [limitations](#limitations) like the possibility that interruptions will occur during the operation. * In this page: - * [Quick example](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#quick-example) - * [`BulkInsertOperation`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoperation) - * [Methods](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#methods) - * [Limitations](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#limitations) - * [Example](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#example) - * [`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) - * [CompressionLevel](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#compressionlevel) - * [SkipOverwriteIfUnchanged](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#skipoverwriteifunchanged) - * [Track progress with OnProgress](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#track-progress-with-onprogress) - * [Syntax](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#syntax) - * [Method signatures](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#method-signatures) - * [Event signature](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#event-signature) - * [Classes](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#classes) + * [Quick example](#quick-example) + * [`BulkInsertOperation`](#bulkinsertoperation) + * [Methods](#methods) + * [Limitations](#limitations) + * [Example](#example) + * [`BulkInsertOptions`](#bulkinsertoptions) + * [CompressionLevel](#compressionlevel) + * [SkipOverwriteIfUnchanged](#skipoverwriteifunchanged) + * [Track progress with OnProgress](#track-progress-with-onprogress) + * [Syntax](#syntax) + * [Method signatures](#method-signatures) + * [Event signature](#event-signature) + * [Classes](#classes) @@ -48,7 +48,7 @@ using (BulkInsertOperation bulkInsert = store.BulkInsert())
For the full set of `BulkInsert` overloads and their parameters, see the -[Syntax](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#syntax) +[Syntax](#syntax) section at the end of this page. @@ -89,7 +89,7 @@ The following methods can be used when creating a bulk insert. cause some of your data not to persist on the server yet. * If the operation was interrupted and you choose to re-insert the whole dataset in a new operation, you can set - [SkipOverwriteIfUnchanged](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#skipoverwriteifunchanged) + [SkipOverwriteIfUnchanged](#skipoverwriteifunchanged) to `true` so the operation overwrites existing documents only if they changed since the last insertion. * **If you need full transactionality**, using a @@ -223,7 +223,7 @@ so far - subscribe to the `OnProgress` event. The bulk insert delivers a progress snapshot to your handler each time the server reports new progress, with counters such as `DocumentsProcessed`, `BatchCount`, and the ID of the document processed most recently (`LastProcessedId`). -See [Classes](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#classes) +See [Classes](#classes) for the full property list. * Updates arrive asynchronously over the @@ -307,7 +307,7 @@ using (var bulkInsert = store.BulkInsert()) Opens a bulk insert against the given database with a -[`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) +[`BulkInsertOptions`](#bulkinsertoptions) instance to configure compression and overwrite behavior. ```csharp @@ -336,7 +336,7 @@ using (var bulkInsert = store.BulkInsert("Northwind", new BulkInsertOptions | Parameter | Type | Description | |-----------|------|-------------| | **database** | `string` | The name of the database to perform the bulk operation on.
If `null`, the `DocumentStore.Database` is used. | -| **options** | `BulkInsertOptions` | [Options](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) to configure BulkInsert. | +| **options** | `BulkInsertOptions` | [Options](#bulkinsertoptions) to configure BulkInsert. | | **token** | `CancellationToken` | Cancellation token used to halt the worker operation. | | Return value | | @@ -347,7 +347,7 @@ using (var bulkInsert = store.BulkInsert("Northwind", new BulkInsertOptions Opens a bulk insert against the document store's default database with a -[`BulkInsertOptions`](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) +[`BulkInsertOptions`](#bulkinsertoptions) instance to configure compression and overwrite behavior. ```csharp @@ -374,7 +374,7 @@ using (var bulkInsert = store.BulkInsert(new BulkInsertOptions | Parameter | Type | Description | |-----------|------|-------------| -| **options** | `BulkInsertOptions` | [Options](../../../client-api/bulk-insert/how-to-work-with-bulk-insert-operation.mdx#bulkinsertoptions) to configure BulkInsert. | +| **options** | `BulkInsertOptions` | [Options](#bulkinsertoptions) to configure BulkInsert. | | **token** | `CancellationToken` | Cancellation token used to halt the worker operation. | | Return value | | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx index e9fe158519..df88cee222 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-csharp.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to counter changes: -- [ForCounter](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounter) -- [ForCounterOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounterofdocument) -- [ForCountersOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcountersofdocument) -- [ForAllCounters](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forallcounters) +- [ForCounter](#forcounter) +- [ForCounterOfDocument](#forcounterofdocument) +- [ForCountersOfDocument](#forcountersofdocument) +- [ForAllCounters](#forallcounters) ## ForCounter @@ -29,7 +29,7 @@ Counter changes can be observed using `ForCounter` method. This will subscribe c | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -74,7 +74,7 @@ Specific counter changes of a given document can be observed using `ForCounterOf | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -118,7 +118,7 @@ Counter changes of a specified document can be observed using `ForCountersOfDocu | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -158,7 +158,7 @@ Changes for all counters can be observed using `ForAllCounters` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -187,7 +187,7 @@ Changes for all counters can be observed using `ForAllCounters` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [CounterChangeTypes](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchangetypes) | Counter change type enum | +| **Type** | [CounterChangeTypes](#counterchangetypes) | Counter change type enum | | **Name** | string | Counter name | | **Value** | long | Counter value after the change | | **DocumentId** | string | Counter document identifier | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx index 87d72bb4df..9bf2858eda 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-counter-changes-java.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to counter changes: -- [ForCounter](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounter) -- [ForCounterOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcounterofdocument) -- [ForCountersOfDocument](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forcountersofdocument) -- [ForAllCounters](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#forallcounters) +- [ForCounter](#forcounter) +- [ForCounterOfDocument](#forcounterofdocument) +- [ForCountersOfDocument](#forcountersofdocument) +- [ForAllCounters](#forallcounters) ## ForCounter @@ -29,7 +29,7 @@ Counter changes can be observed using `forCounter` method. This will subscribe c | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -71,7 +71,7 @@ Specific counter changes of a given document can be observed using `forCounterOf | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -112,7 +112,7 @@ Counter changes of a specified document can be observed using `forCountersOfDocu | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -149,7 +149,7 @@ Changes for all counters can be observed using `forAllCounters` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[CounterChange](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchange)> | Observable that allows to add subscriptions to counter notifications. | +| IChangesObservable<[CounterChange](#counterchange)> | Observable that allows to add subscriptions to counter notifications. | ### Example @@ -175,7 +175,7 @@ Changes for all counters can be observed using `forAllCounters` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [CounterChangeTypes](../../../client-api/changes/how-to-subscribe-to-counter-changes.mdx#counterchangetypes) | Counter change type enum | +| **Type** | [CounterChangeTypes](#counterchangetypes) | Counter change type enum | | **Name** | String | Counter name | | **Value** | Long | Counter value after the change | | **DocumentId** | String | Counter document identifier | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx index 684d3c9531..52cb7822f0 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-csharp.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [ForDocument](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [ForDocumentsInCollection](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [ForDocumentsStartingWith](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [ForAllDocuments](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [ForDocument](#fordocument) +- [ForDocumentsInCollection](#fordocumentsincollection) +- [ForDocumentsStartingWith](#fordocumentsstartingwith) +- [ForAllDocuments](#foralldocuments) ## ForDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `ForDocument` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | ### Example @@ -78,7 +78,7 @@ IChangesObservable ForDocumentsInCollection(); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with `TEntity` type uses `Conventions.GetCollectionName` to get collection name. @@ -130,7 +130,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -161,7 +161,7 @@ To observe all document changes use `ForAllDocuments` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -181,7 +181,7 @@ To observe all document changes use `ForAllDocuments` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **Type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **Id** | string | Document identifier | | **CollectionName** | string | Document's collection name | | **TypeName** | string | Type name | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx index 2278707899..170562433b 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-java.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [forDocument](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [forDocumentsInCollection](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [forDocumentsStartingWith](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [forAllDocuments](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [forDocument](#fordocument) +- [forDocumentsInCollection](#fordocumentsincollection) +- [forDocumentsStartingWith](#fordocumentsstartingwith) +- [forAllDocuments](#foralldocuments) ## forDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `forDocument` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document. | ### Example @@ -74,7 +74,7 @@ IChangesObservable forDocumentsInCollection(Class clazz); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with `TEntity` type uses `conventions.GetCollectionName` to get collection name. @@ -130,7 +130,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -163,7 +163,7 @@ To observe all document changes use `forAllDocuments` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -185,7 +185,7 @@ To observe all document changes use `forAllDocuments` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **Type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **Id** | String | Document identifier | | **CollectionName** | String | Document's collection name | | **TypeName** | String | Type name | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx index adf60a21e6..c34b2e7e88 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-document-changes-nodejs.mdx @@ -5,10 +5,10 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to document changes: -- [forDocument()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocument) -- [forDocumentsInCollection()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsincollection) -- [forDocumentsStartingWith()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#fordocumentsstartingwith) -- [forAllDocuments()](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#foralldocuments) +- [forDocument()](#fordocument) +- [forDocumentsInCollection()](#fordocumentsincollection) +- [forDocumentsStartingWith()](#fordocumentsstartingwith) +- [forAllDocuments()](#foralldocuments) ## forDocument @@ -29,7 +29,7 @@ Single document changes can be observed using `forDocument()` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add listeners for events for given document. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add listeners for events for given document. | ### Example @@ -75,7 +75,7 @@ store.changes().forDocumentsInCollection(clazz); | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document collection name. | Overload with entity type uses `conventions.getCollectionNameForType()` to get collection name. @@ -128,7 +128,7 @@ To observe all document changes for documents with ID that contains given prefix | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for given document ID prefix. | ### Example @@ -160,7 +160,7 @@ To observe all document changes use `forAllDocuments()` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[DocumentChange](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | +| IChangesObservable<[DocumentChange](#documentchange)> | Observable that allows to add subscriptions to notifications for all documents. | ### Example @@ -180,7 +180,7 @@ To observe all document changes use `forAllDocuments()` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **type** | [DocumentChangeTypes](../../../client-api/changes/how-to-subscribe-to-document-changes.mdx#documentchangetypes) | Document change type enum | +| **type** | [DocumentChangeTypes](#documentchangetypes) | Document change type enum | | **id** | string | Document identifier | | **collectionName** | string | Document's collection name | | **typeName** | string | Type name | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx index 59857984a7..8943990d0a 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-csharp.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [ForIndex](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [ForAllIndexes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [ForIndex](#forindex) +- [ForAllIndexes](#forallindexes) ## ForIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `ForIndex` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -93,7 +93,7 @@ Index changes for all indexex can be observed using `ForAllIndexes` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -124,7 +124,7 @@ Index changes for all indexex can be observed using `ForAllIndexes` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **Type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **Name** | string | Index name | | **Etag** | long? | Index Etag | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx index 8d02c69f94..f87a9cc20c 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [forIndex](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [forAllIndexes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [forIndex](#forindex) +- [forAllIndexes](#forallindexes) ## forIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `forIndex` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -93,7 +93,7 @@ Index changes for all indexex can be observed using `forAllIndexes` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -126,7 +126,7 @@ Index changes for all indexex can be observed using `forAllIndexes` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **Type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **Name** | String | Index name | | **Etag** | Long | Index Etag | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx index a7076e0764..d8e371da0e 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-index-changes-nodejs.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; Following methods allow you to subscribe to index changes: -- [forIndex()](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forindex) -- [forAllIndexes()](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#forallindexes) +- [forIndex()](#forindex) +- [forAllIndexes()](#forallindexes) ## forIndex @@ -27,7 +27,7 @@ Index changes for one index can be observed using `forIndex()` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for index with given name. | ### Example @@ -91,7 +91,7 @@ Index changes for all indexex can be observed using `forAllIndexes()` method. | Return value | | | ------------- | ----- | -| IChangesObservable<[IndexChange](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | +| IChangesObservable<[IndexChange](#indexchange)> | Observable that allows to add subscriptions to notifications for all indexes. | ### Syntax @@ -122,7 +122,7 @@ Index changes for all indexex can be observed using `forAllIndexes()` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **type** | [IndexChangeTypes](../../../client-api/changes/how-to-subscribe-to-index-changes.mdx#indexchangetypes) | Change type | +| **type** | [IndexChangeTypes](#indexchangetypes) | Change type | | **name** | string | Index name | | **etag** | number | Index Etag | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx index bee95aa63c..7df2e9ed34 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-csharp.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [ForOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperationid) -- [ForAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [ForOperationId](#foroperationid) +- [ForAllOperations](#foralloperations) ## ForOperationId @@ -37,7 +37,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -89,7 +89,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax @@ -120,7 +120,7 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Name | Type | Description | | ------------- | ------------- | ----- | -| **State** | [OperationState](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationstate) | Operation state | +| **State** | [OperationState](#operationstate) | Operation state | | **OperationId** | long | Operation ID | @@ -131,9 +131,9 @@ tracking to a single node: `store.Changes(dbName, nodeTag)` | Name | Type | Description | | ------------- | ------------- | ----- | -| **Result** | [IOperationResult](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationresult) | Operation result | +| **Result** | [IOperationResult](#operationresult) | Operation result | | **Progress** | IOperationProgress| Instance of IOperationProgress (json representation of the progress) | -| **Status** | [OperationStatus](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationstatus) | Operation status | +| **Status** | [OperationStatus](#operationstatus) | Operation status | ## OperationResult diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx index 5c10cb9f60..36533ee873 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [forOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperation) -- [forAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [forOperationId](#foroperation) +- [forAllOperations](#foralloperations) ## forOperation @@ -27,7 +27,7 @@ Operation changes for one operation can be observed using the `forOperationId` m | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -53,7 +53,7 @@ Operations changes for all Operations can be observed using the `forAllOperation | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx index ba5c3b0fa8..251ec63b6b 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-operation-changes-nodejs.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; The following methods allow you to subscribe to operation changes: -- [forOperationId()](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperation) -- [forAllOperations()](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) +- [forOperationId()](#foroperation) +- [forAllOperations()](#foralloperations) ## forOperation @@ -27,7 +27,7 @@ Operation changes for one operation can be observed using the `forOperationId()` | Return value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows you to add subscriptions to notifications for an operation with a given ID. | ### Example @@ -51,7 +51,7 @@ Operations changes for all Operations can be observed using the `forAllOperation | Return Value | | | ------------- | ----- | -| IChangesObservable<[OperationStatusChange](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | +| IChangesObservable<[OperationStatusChange](#operationchange)> | Observable that allows to add subscriptions to notifications for all operations. | ### Syntax diff --git a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx index f4349a81fd..f168df060e 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_how-to-subscribe-to-time-series-changes-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Track **all** time series * In this page: - * [ForTimeSeries](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#fortimeseries) - * [ForTimeSeriesOfDocument](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#fortimeseriesofdocument) - * [ForAllTimeSeries](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#foralltimeseries) + * [ForTimeSeries](#fortimeseries) + * [ForTimeSeriesOfDocument](#fortimeseriesofdocument) + * [ForAllTimeSeries](#foralltimeseries) ## ForTimeSeries @@ -40,7 +40,7 @@ using the `ForTimeSeries` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -91,7 +91,7 @@ Use this `ForTimeSeriesOfDocument` overload to track changes in a **specific tim | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -131,7 +131,7 @@ Use this `ForTimeSeriesOfDocument` overload to track changes in **any time serie | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -171,7 +171,7 @@ Subscribe to changes in **all time-series** using the `ForAllTimeSeries` method. | Return Value | | | ------------- | ----- | -| IChangesObservable<[TimeSeriesChange](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | +| IChangesObservable<[TimeSeriesChange](#timeserieschange)> | Observable that allows to add subscriptions to time series notifications. | #### Example @@ -200,7 +200,7 @@ Subscribe to changes in **all time-series** using the `ForAllTimeSeries` method. | Name | Type | Description | | ------------- | ------------- | ----- | -| **Type** | [TimeSeriesChangeTypes](../../../client-api/changes/how-to-subscribe-to-time-series-changes.mdx#timeserieschangetypes) | Time series change type enum | +| **Type** | [TimeSeriesChangeTypes](#timeserieschangetypes) | Time series change type enum | | **Name** | string | Time Series Name | | **DocumentId** | string | Time series Document Identifier | | **CollectionName** | string | Time series document Collection Name | diff --git a/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-csharp.mdx b/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-csharp.mdx index 240dac83d6..24a4523913 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-csharp.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [FAQ](../../../client-api/changes/what-is-changes-api.mdx#faq) - * [Changes API and Database Timeout](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-database-timeout) - * [Changes API and Method Overloads](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-method-overloads) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [FAQ](#faq) + * [Changes API and Database Timeout](#changes-api-and-database-timeout) + * [Changes API and Method Overloads](#changes-api-and-method-overloads) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API @@ -107,7 +107,7 @@ To receive notifications regarding server-side events, subscribe using one of th Track changes for a given index (by Index Name) * **For Operation Changes:** - Operation changes can be tracked only [on a specific node](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api). + Operation changes can be tracked only [on a specific node](#accessing-changes-api). - [ForAllOperations](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foralloperations) Track changes for all operation - [ForOperationId](../../../client-api/changes/how-to-subscribe-to-operation-changes.mdx#foroperationid) diff --git a/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-java.mdx b/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-java.mdx index df488dd95d..da3d724912 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-java.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-java.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [Note](../../../client-api/changes/what-is-changes-api.mdx#note) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [Note](#note) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API diff --git a/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-nodejs.mdx b/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-nodejs.mdx index 2dc3ced34c..9ed8b354e2 100644 --- a/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/changes/content/_what-is-changes-api-nodejs.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; any expensive polling. * In this page: - * [Accessing Changes API](../../../client-api/changes/what-is-changes-api.mdx#accessing-changes-api) - * [Connection interface](../../../client-api/changes/what-is-changes-api.mdx#connection-interface) - * [Subscribing](../../../client-api/changes/what-is-changes-api.mdx#subscribing) - * [Unsubscribing](../../../client-api/changes/what-is-changes-api.mdx#unsubscribing) - * [FAQ](../../../client-api/changes/what-is-changes-api.mdx#faq) - * [Changes API and Database Timeout](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-database-timeout) - * [Changes API and Method Overloads](../../../client-api/changes/what-is-changes-api.mdx#changes-api-and-method-overloads) - * [Changes API -vs- Data Subscriptions](../../../client-api/changes/what-is-changes-api.mdx#changes-api--vs--data-subscriptions) + * [Accessing Changes API](#accessing-changes-api) + * [Connection interface](#connection-interface) + * [Subscribing](#subscribing) + * [Unsubscribing](#unsubscribing) + * [FAQ](#faq) + * [Changes API and Database Timeout](#changes-api-and-database-timeout) + * [Changes API and Method Overloads](#changes-api-and-method-overloads) + * [Changes API -vs- Data Subscriptions](#changes-api--vs--data-subscriptions) ## Accessing Changes API diff --git a/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx b/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx index f3e863f000..d3a6f3d781 100644 --- a/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-csharp.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx b/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx index c3695729d3..1e50df5d81 100644 --- a/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx +++ b/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx b/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx index b8f38a0eb4..88a3625247 100644 --- a/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/cluster/content/_how-client-integrates-with-replication-and-cluster-nodejs.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Failover behavior](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#failover-behavior) - * [Cluster topology in the client](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#cluster-topology-in-the-client) - * [Topology discovery](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#topology-discovery) - * [Configuring topology nodes](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#configuring-topology-nodes) - * [Write assurance and database groups](../../../client-api/cluster/how-client-integrates-with-replication-and-cluster.mdx#write-assurance-and-database-groups) + * [Failover behavior](#failover-behavior) + * [Cluster topology in the client](#cluster-topology-in-the-client) + * [Topology discovery](#topology-discovery) + * [Configuring topology nodes](#configuring-topology-nodes) + * [Write assurance and database groups](#write-assurance-and-database-groups) ## Failover behavior diff --git a/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx b/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx index 43295e9d72..65e49fa867 100644 --- a/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-csharp.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction). * In this page: - * [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples) - * [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands) - * [Syntax](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#syntax) + * [Examples](#examples) + * [Available batch commands](#available-batch-commands) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx b/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx index 03c73468d1..b89367e859 100644 --- a/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/commands/batches/content/_how-to-send-multiple-commands-using-a-batch-nodejs.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; See [Open a cluster-wide session](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction). * In this page: - * [Examples](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#examples) - * [Available batch commands](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#available-batch-commands) - * [Syntax](../../../../client-api/commands/batches/how-to-send-multiple-commands-using-a-batch.mdx#syntax) + * [Examples](#examples) + * [Available batch commands](#available-batch-commands) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/content/_overview-csharp.mdx b/versioned_docs/version-7.1/client-api/commands/content/_overview-csharp.mdx index 6c14ce14a6..08c9be0d42 100644 --- a/versioned_docs/version-7.1/client-api/commands/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/commands/content/_overview-csharp.mdx @@ -29,17 +29,17 @@ import CodeBlock from '@theme/CodeBlock'; * Commands are responsible for sending the appropriate request to the server using a `Request Executor`, and parsing the server's response. - * All commands can be executed using either the [Store's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-store) - or the [Session's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-session), + * All commands can be executed using either the [Store's _Request Executor_](#execute-command---using-the-store) + or the [Session's _Request Executor_](#execute-command---using-the-session), regardless of whether the command is session-related or not. * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Execute command - using the Store Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-store-request-executor) - * [Execute command - using the Session Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-session-request-executor) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Execute command - using the Store Request Executor](#execute-command---using-the-store-request-executor) + * [Execute command - using the Session Request Executor](#execute-command---using-the-session-request-executor) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Execute command - using the Store Request Executor diff --git a/versioned_docs/version-7.1/client-api/commands/content/_overview-java.mdx b/versioned_docs/version-7.1/client-api/commands/content/_overview-java.mdx index 6bd51f3993..729d2eae1f 100644 --- a/versioned_docs/version-7.1/client-api/commands/content/_overview-java.mdx +++ b/versioned_docs/version-7.1/client-api/commands/content/_overview-java.mdx @@ -35,9 +35,9 @@ import CodeBlock from '@theme/CodeBlock'; * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Examples](../../../client-api/commands/overview.mdx#examples) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Examples](#examples) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/client-api/commands/content/_overview-nodejs.mdx index 8e2fe72792..fa373316f5 100644 --- a/versioned_docs/version-7.1/client-api/commands/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/commands/content/_overview-nodejs.mdx @@ -29,17 +29,17 @@ import CodeBlock from '@theme/CodeBlock'; * Commands are responsible for sending the appropriate request to the server using a `Request Executor`, and parsing the server's response. - * All commands can be executed using either the [Store's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-store) - or the [Session's _Request Executor_](../../../client-api/commands/overview.mdx#execute-command---using-the-session), + * All commands can be executed using either the [Store's _Request Executor_](#execute-command---using-the-store) + or the [Session's _Request Executor_](#execute-command---using-the-session), regardless of whether the command is session-related or not. * This layered structure lets you work at any level, depending on your needs. * In this page: - * [Execute command - using the Store Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-store-request-executor) - * [Execute command - using the Session Request Executor](../../../client-api/commands/overview.mdx#execute-command---using-the-session-request-executor) - * [Available commands](../../../client-api/commands/overview.mdx#available-commands) - * [Syntax](../../../client-api/commands/overview.mdx#syntax) + * [Execute command - using the Store Request Executor](#execute-command---using-the-store-request-executor) + * [Execute command - using the Session Request Executor](#execute-command---using-the-session-request-executor) + * [Available commands](#available-commands) + * [Syntax](#syntax) ## Execute command - using the Store Request Executor diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-csharp.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-csharp.mdx index 67720eb954..d8c463593b 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/delete.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-nodejs.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-nodejs.mdx index 6505dd457d..dd631d5d02 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/delete.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-php.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-php.mdx index 7ccc950619..dbc8c6cf39 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-php.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/delete.mdx#example) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-python.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-python.mdx index f440c8cf06..795d53ea6f 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-python.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_delete-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/delete.mdx#example) - * [Syntax](../../../../client-api/commands/documents/delete.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-csharp.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-csharp.mdx index 0ef4a8e33d..e95aee9dcd 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-csharp.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents - by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents---by-id-prefix) - - [Get documents - with includes](../../../../client-api/commands/documents/get.mdx#get-documents---with-includes) - - [Syntax](../../../../client-api/commands/documents/get.mdx#syntax) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get metadata only](#get-metadata-only) + - [Get paged documents](#get-paged-documents) + - [Get documents - by ID prefix](#get-documents---by-id-prefix) + - [Get documents - with includes](#get-documents---with-includes) + - [Syntax](#syntax) ## Get single document diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-java.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-java.mdx index 9740299364..92110c1be6 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-java.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-java.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; There are a few methods that allow you to retrieve documents from a database: -- [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) -- [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) -- [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) -- [Get documents by starts with](../../../../client-api/commands/documents/get.mdx#get-by-starts-with) -- [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) +- [Get single document](#get-single-document) +- [Get multiple documents](#get-multiple-documents) +- [Get paged documents](#get-paged-documents) +- [Get documents by starts with](#get-by-starts-with) +- [Get metadata only](#get-metadata-only) ## Get single document diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-nodejs.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-nodejs.mdx index b4664b65fd..88be48bc31 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-nodejs.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * To retrieve documents using a higher-level method, see [loading entities](../../../../client-api/session/loading-entities.mdx) or [query for documents](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get metadata only](../../../../client-api/commands/documents/get.mdx#get-metadata-only) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents - by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents---by-id-prefix) - - [Get documents - with includes](../../../../client-api/commands/documents/get.mdx#get-documents---with-includes) - - [Syntax](../../../../client-api/commands/documents/get.mdx#syntax) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get metadata only](#get-metadata-only) + - [Get paged documents](#get-paged-documents) + - [Get documents - by ID prefix](#get-documents---by-id-prefix) + - [Get documents - with includes](#get-documents---with-includes) + - [Syntax](#syntax) ## Get single document diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-php.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-php.mdx index 35c5509bd3..4e98a2fa47 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-php.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-php.mdx @@ -8,10 +8,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetDocumentsCommand` to retrieve documents from the database. * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents-by-id-prefix) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get paged documents](#get-paged-documents) + - [Get documents by ID prefix](#get-documents-by-id-prefix) ## Get single document diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-python.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-python.mdx index 4b7f55b814..f8828fb244 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_get-python.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_get-python.mdx @@ -8,10 +8,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetDocumentsCommand` to retrieve documents from the database. * In this page: - - [Get single document](../../../../client-api/commands/documents/get.mdx#get-single-document) - - [Get multiple documents](../../../../client-api/commands/documents/get.mdx#get-multiple-documents) - - [Get paged documents](../../../../client-api/commands/documents/get.mdx#get-paged-documents) - - [Get documents by ID prefix](../../../../client-api/commands/documents/get.mdx#get-documents-by-id-prefix) + - [Get single document](#get-single-document) + - [Get multiple documents](#get-multiple-documents) + - [Get paged documents](#get-paged-documents) + - [Get documents by ID prefix](#get-documents-by-id-prefix) ## Get single document diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-csharp.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-csharp.mdx index 48c6caf464..ee58b22224 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/put.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-nodejs.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-nodejs.mdx index 74edf1c2de..15695f8902 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Examples](../../../../client-api/commands/documents/put.mdx#examples) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Examples](#examples) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-php.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-php.mdx index f7974c4eca..0d75d87db7 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-php.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/put.mdx#example) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-python.mdx b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-python.mdx index 64cf90a984..3935dd8f61 100644 --- a/versioned_docs/version-7.1/client-api/commands/documents/content/_put-python.mdx +++ b/versioned_docs/version-7.1/client-api/commands/documents/content/_put-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Example](../../../../client-api/commands/documents/put.mdx#example) - * [Syntax](../../../../client-api/commands/documents/put.mdx#syntax) + * [Example](#example) + * [Syntax](#syntax) ## Example diff --git a/versioned_docs/version-7.1/client-api/configuration/content/_conventions-csharp.mdx b/versioned_docs/version-7.1/client-api/configuration/content/_conventions-csharp.mdx index 7d71befeaf..e1d10773f5 100644 --- a/versioned_docs/version-7.1/client-api/configuration/content/_conventions-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/content/_conventions-csharp.mdx @@ -8,59 +8,59 @@ import CodeBlock from '@theme/CodeBlock'; * **Conventions** in RavenDB are customizable settings that users can configure to tailor client behaviors according to their preferences. * In this article: - * [How to set conventions](../../../client-api/configuration/conventions.mdx#how-to-set-conventions) + * [How to set conventions](#how-to-set-conventions) * [Conventions:](../../../client-api/configuration/conventions.mdx#conventions:) - [AddIdFieldToDynamicObjects](../../../client-api/configuration/conventions.mdx#addidfieldtodynamicobjects) - [AggressiveCache.Duration](../../../client-api/configuration/conventions.mdx#aggressivecacheduration) - [AggressiveCache.Mode](../../../client-api/configuration/conventions.mdx#aggressivecachemode) - [AsyncDocumentIdGenerator](../../../client-api/configuration/conventions.mdx#asyncdocumentidgenerator) - [CreateHttpClient](../../../client-api/configuration/conventions.mdx#createhttpclient) - [DisableAtomicDocumentWritesInClusterWideTransaction](../../../client-api/configuration/conventions.mdx#disableatomicdocumentwritesinclusterwidetransaction) - [DisableTcpCompression](../../../client-api/configuration/conventions.mdx#disabletcpcompression) - [DisableTopologyCache](../../../client-api/configuration/conventions.mdx#disabletopologycache) - [DisableTopologyUpdates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) - [DisposeCertificate](../../../client-api/configuration/conventions.mdx#disposecertificate) - [FindClrType](../../../client-api/configuration/conventions.mdx#findclrtype) - [FindClrTypeName](../../../client-api/configuration/conventions.mdx#findclrtypename) - [FindClrTypeNameForDynamic](../../../client-api/configuration/conventions.mdx#findclrtypenamefordynamic) - [FindCollectionName](../../../client-api/configuration/conventions.mdx#findcollectionname) - [FindCollectionNameForDynamic](../../../client-api/configuration/conventions.mdx#findcollectionnamefordynamic) - [FindIdentityProperty](../../../client-api/configuration/conventions.mdx#findidentityproperty) - [FindIdentityPropertyNameFromCollectionName](../../../client-api/configuration/conventions.mdx#findidentitypropertynamefromcollectionname) - [FindProjectedPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findprojectedpropertynameforindex) - [FindPropertyNameForDynamicIndex](../../../client-api/configuration/conventions.mdx#findpropertynamefordynamicindex) - [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) - [FirstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) - [GlobalHttpClientTimeout](../../../client-api/configuration/conventions.mdx#globalhttpclienttimeout) - [HttpClientType](../../../client-api/configuration/conventions.mdx#httpclienttype) - [HttpPooledConnectionIdleTimeout](../../../client-api/configuration/conventions.mdx#httppooledconnectionidletimeout) - [HttpPooledConnectionLifetime](../../../client-api/configuration/conventions.mdx#httppooledconnectionlifetime) - [HttpVersion](../../../client-api/configuration/conventions.mdx#httpversion) - [IdentityPartsSeparator](../../../client-api/configuration/conventions.mdx#identitypartsseparator) - [LoadBalanceBehavior](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [LoadBalancerContextSeed](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [LoadBalancerPerSessionContextSelector](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [MaxHttpCacheSize](../../../client-api/configuration/conventions.mdx#maxhttpcachesize) - [MaxNumberOfRequestsPerSession](../../../client-api/configuration/conventions.mdx#maxnumberofrequestspersession) - [Modify serialization of property name](../../../client-api/configuration/conventions.mdx#modify-serialization-of-property-name) - [OperationStatusFetchMode](../../../client-api/configuration/conventions.mdx#operationstatusfetchmode) - [PreserveDocumentPropertiesNotFoundOnModel](../../../client-api/configuration/conventions.mdx#preservedocumentpropertiesnotfoundonmodel) - [ReadBalanceBehavior](../../../client-api/configuration/conventions.mdx#readbalancebehavior) - [RequestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout) - [ResolveTypeFromClrTypeName](../../../client-api/configuration/conventions.mdx#resolvetypefromclrtypename) - [SaveEnumsAsIntegers](../../../client-api/configuration/conventions.mdx#saveenumsasintegers) - [SecondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) - [SendApplicationIdentifier](../../../client-api/configuration/conventions.mdx#sendapplicationidentifier) - [ShouldIgnoreEntityChanges](../../../client-api/configuration/conventions.mdx#shouldignoreentitychanges) - [TopologyCacheLocation](../../../client-api/configuration/conventions.mdx#topologycachelocation) - [TransformTypeCollectionNameToDocumentIdPrefix](../../../client-api/configuration/conventions.mdx#transformtypecollectionnametodocumentidprefix) - [UseHttpCompression](../../../client-api/configuration/conventions.mdx#usehttpcompression) - [UseHttpDecompression](../../../client-api/configuration/conventions.mdx#usehttpdecompression) - [HttpCompressionAlgorithm](../../../client-api/configuration/conventions.mdx#httpcompressionalgorithm) - [UseOptimisticConcurrency](../../../client-api/configuration/conventions.mdx#useoptimisticconcurrency) - [WaitForIndexesAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforindexesaftersavechangestimeout) - [WaitForNonStaleResultsTimeout](../../../client-api/configuration/conventions.mdx#waitfornonstaleresultstimeout) - [WaitForReplicationAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforreplicationaftersavechangestimeout) + [AddIdFieldToDynamicObjects](#addidfieldtodynamicobjects) + [AggressiveCache.Duration](#aggressivecacheduration) + [AggressiveCache.Mode](#aggressivecachemode) + [AsyncDocumentIdGenerator](#asyncdocumentidgenerator) + [CreateHttpClient](#createhttpclient) + [DisableAtomicDocumentWritesInClusterWideTransaction](#disableatomicdocumentwritesinclusterwidetransaction) + [DisableTcpCompression](#disabletcpcompression) + [DisableTopologyCache](#disabletopologycache) + [DisableTopologyUpdates](#disabletopologyupdates) + [DisposeCertificate](#disposecertificate) + [FindClrType](#findclrtype) + [FindClrTypeName](#findclrtypename) + [FindClrTypeNameForDynamic](#findclrtypenamefordynamic) + [FindCollectionName](#findcollectionname) + [FindCollectionNameForDynamic](#findcollectionnamefordynamic) + [FindIdentityProperty](#findidentityproperty) + [FindIdentityPropertyNameFromCollectionName](#findidentitypropertynamefromcollectionname) + [FindProjectedPropertyNameForIndex](#findprojectedpropertynameforindex) + [FindPropertyNameForDynamicIndex](#findpropertynamefordynamicindex) + [FindPropertyNameForIndex](#findpropertynameforindex) + [FirstBroadcastAttemptTimeout](#firstbroadcastattempttimeout) + [GlobalHttpClientTimeout](#globalhttpclienttimeout) + [HttpClientType](#httpclienttype) + [HttpPooledConnectionIdleTimeout](#httppooledconnectionidletimeout) + [HttpPooledConnectionLifetime](#httppooledconnectionlifetime) + [HttpVersion](#httpversion) + [IdentityPartsSeparator](#identitypartsseparator) + [LoadBalanceBehavior](#loadbalancebehavior) + [LoadBalancerContextSeed](#loadbalancebehavior) + [LoadBalancerPerSessionContextSelector](#loadbalancebehavior) + [MaxHttpCacheSize](#maxhttpcachesize) + [MaxNumberOfRequestsPerSession](#maxnumberofrequestspersession) + [Modify serialization of property name](#modify-serialization-of-property-name) + [OperationStatusFetchMode](#operationstatusfetchmode) + [PreserveDocumentPropertiesNotFoundOnModel](#preservedocumentpropertiesnotfoundonmodel) + [ReadBalanceBehavior](#readbalancebehavior) + [RequestTimeout](#requesttimeout) + [ResolveTypeFromClrTypeName](#resolvetypefromclrtypename) + [SaveEnumsAsIntegers](#saveenumsasintegers) + [SecondBroadcastAttemptTimeout](#secondbroadcastattempttimeout) + [SendApplicationIdentifier](#sendapplicationidentifier) + [ShouldIgnoreEntityChanges](#shouldignoreentitychanges) + [TopologyCacheLocation](#topologycachelocation) + [TransformTypeCollectionNameToDocumentIdPrefix](#transformtypecollectionnametodocumentidprefix) + [UseHttpCompression](#usehttpcompression) + [UseHttpDecompression](#usehttpdecompression) + [HttpCompressionAlgorithm](#httpcompressionalgorithm) + [UseOptimisticConcurrency](#useoptimisticconcurrency) + [WaitForIndexesAfterSaveChangesTimeout](#waitforindexesaftersavechangestimeout) + [WaitForNonStaleResultsTimeout](#waitfornonstaleresultstimeout) + [WaitForReplicationAfterSaveChangesTimeout](#waitforreplicationaftersavechangestimeout) ## How to set conventions @@ -193,7 +193,7 @@ public Func> AsyncDocumentIdGenerator \{ get; set; * For example, implementing your own HTTP client can be useful when you'd like your clients to provide the server with tracing info. * If you override the default `CreateHttpClient` convention we advise that you also set the HTTP client type - correctly using the [HttpClientType](../../../client-api/configuration/conventions.mdx#httpclienttype) convention. + correctly using the [HttpClientType](#httpclienttype) convention. @@ -262,7 +262,7 @@ public bool DisableTcpCompression \{ get; set; \} In such a case: * The client will not load the topology from the cache upon failing to connect to a server. - * Even if the client is configured to [receive topology updates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) from the server, + * Even if the client is configured to [receive topology updates](#disabletopologyupdates) from the server, no topology files will be saved on disk, thus preventing the accumulation of these files. * DEFAULT: `false` @@ -490,7 +490,7 @@ public Func FindIdentityPropertyNameFromCollectionName \{ get; s * DEFAULT: `null` When `FindProjectedPropertyNameForIndex` is set to `null` (or returns `null`), - the [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) convention is used instead. + the [FindPropertyNameForIndex](#findpropertynameforindex) convention is used instead. **Example**: Consider the following index, which indexes the nested `School.Id` property from _Student_ documents: @@ -539,7 +539,7 @@ public class School When querying the index and projecting fields from the matching _Student_ documents, if the `FindProjectedPropertyNameForIndex` convention is Not set, -the client will use the [FindPropertyNameForIndex](../../../client-api/configuration/conventions.mdx#findpropertynameforindex) convention instead when constructing the RQL sent to the server. +the client will use the [FindPropertyNameForIndex](#findpropertynameforindex) convention instead when constructing the RQL sent to the server. This results in the following RQL query: (Note that while the high-level query uses `.Select(student => student.School.Id)`, @@ -686,7 +686,7 @@ public Func FindPropertyNameForIndex \{ ge * In the first attempt, the request executor will send a single request to the selected node. Learn about the "selected node" in: [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node). -* A [second attempt](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) will be held upon failure. +* A [second attempt](#secondbroadcastattempttimeout) will be held upon failure. * DEFAULT: `5 seconds` @@ -714,9 +714,9 @@ public TimeSpan FirstBroadcastAttemptTimeout \{ get; set; \} This setting does not control how long an idle TCP connection remains open; it limits how long the client waits for an HTTP request to complete. * This value also serves as the maximum allowed timeout for request-executor timeouts, - such as [RequestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout), - [FirstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout), - [SecondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout), and per-request command timeouts. + such as [RequestTimeout](#requesttimeout), + [FirstBroadcastAttemptTimeout](#firstbroadcastattempttimeout), + [SecondBroadcastAttemptTimeout](#secondbroadcastattempttimeout), and per-request command timeouts. Setting any of these to a value greater than `GlobalHttpClientTimeout` will throw an exception. * In client code, set `GlobalHttpClientTimeout` to be greater than or equal to the longest request timeout you plan to use. @@ -748,7 +748,7 @@ public TimeSpan GlobalHttpClientTimeout \{ get; set; \} * RavenDB uses the HTTP type internally to manage its cache. -* If you override the [CreateHttpClient](../../../client-api/configuration/conventions.mdx#createhttpclient) convention to use a non-default HTTP client, +* If you override the [CreateHttpClient](#createhttpclient) convention to use a non-default HTTP client, we advise that you also set `HttpClientType` so it returns the client type you are actually using. @@ -1094,7 +1094,7 @@ public bool SaveEnumsAsIntegers \{ get; set; \} #### SecondBroadcastAttemptTimeout * Use the `SecondBroadcastAttemptTimeout` convention to set the timeout for the second broadcast attempt. -* Upon failure of the [first attempt](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. +* Upon failure of the [first attempt](#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. * DEFAULT: `30 seconds` @@ -1228,7 +1228,7 @@ public bool UseHttpDecompression \{ get; set; \} #### HttpCompressionAlgorithm * Use this convention to set the HTTP compression algorithm - (see [UseHttpDecompression](../../../client-api/configuration/conventions.mdx#usehttpcompression) above). + (see [UseHttpDecompression](#usehttpcompression) above). * DEFAULT: `Zstd` diff --git a/versioned_docs/version-7.1/client-api/configuration/content/_conventions-nodejs.mdx b/versioned_docs/version-7.1/client-api/configuration/content/_conventions-nodejs.mdx index 9568ff2e09..93eb3ac9ad 100644 --- a/versioned_docs/version-7.1/client-api/configuration/content/_conventions-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/content/_conventions-nodejs.mdx @@ -8,37 +8,37 @@ import CodeBlock from '@theme/CodeBlock'; * **Conventions** in RavenDB are customizable settings that users can configure to tailor client behaviors according to their preferences. * In this article: - * [How to set conventions](../../../client-api/configuration/conventions.mdx#how-to-set-conventions) + * [How to set conventions](#how-to-set-conventions) * [Conventions:](../../../client-api/configuration/conventions.mdx#conventions:) - [customFetch](../../../client-api/configuration/conventions.mdx#customfetch) - [disableAtomicDocumentWritesInClusterWideTransaction](../../../client-api/configuration/conventions.mdx#disableatomicdocumentwritesinclusterwidetransaction) - [disableTopologyUpdates](../../../client-api/configuration/conventions.mdx#disabletopologyupdates) - [findCollectionName](../../../client-api/configuration/conventions.mdx#findcollectionname) - [findJsType](../../../client-api/configuration/conventions.mdx#_findjstype) - [findJsTypeName](../../../client-api/configuration/conventions.mdx#_findjstypename) - [firstBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) - [identityPartsSeparator](../../../client-api/configuration/conventions.mdx#identitypartsseparator) - [loadBalanceBehavior](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [loadBalancerContextSeed](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [loadBalancerPerSessionContextSelector](../../../client-api/configuration/conventions.mdx#loadbalancebehavior) - [maxHttpCacheSize](../../../client-api/configuration/conventions.mdx#maxhttpcachesize) - [maxNumberOfRequestsPerSession](../../../client-api/configuration/conventions.mdx#maxnumberofrequestspersession) - [readBalanceBehavior](../../../client-api/configuration/conventions.mdx#readbalancebehavior) - [requestTimeout](../../../client-api/configuration/conventions.mdx#requesttimeout) - [secondBroadcastAttemptTimeout](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) - [sendApplicationIdentifier](../../../client-api/configuration/conventions.mdx#sendapplicationidentifier) - [shouldIgnoreEntityChanges](../../../client-api/configuration/conventions.mdx#shouldignoreentitychanges) - [storeDatesInUtc](../../../client-api/configuration/conventions.mdx#storedatesinutc) - [storeDatesWithTimezoneInfo](../../../client-api/configuration/conventions.mdx#storedateswithtimezoneinfo) - [syncJsonParseLimit](../../../client-api/configuration/conventions.mdx#syncjsonparselimit) - [throwIfQueryPageSizeIsNotSet](../../../client-api/configuration/conventions.mdx#throwifquerypagesizeisnotset) - [transformClassCollectionNameToDocumentIdPrefix](../../../client-api/configuration/conventions.mdx#transformclasscollectionnametodocumentidprefix) - [useCompression](../../../client-api/configuration/conventions.mdx#usecompression) - [useJsonlStreaming](../../../client-api/configuration/conventions.mdx#usejsonlstreaming) - [useOptimisticConcurrency](../../../client-api/configuration/conventions.mdx#useoptimisticconcurrency) - [waitForIndexesAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforindexesaftersavechangestimeout) - [waitForNonStaleResultsTimeout](../../../client-api/configuration/conventions.mdx#waitfornonstaleresultstimeout) - [waitForReplicationAfterSaveChangesTimeout](../../../client-api/configuration/conventions.mdx#waitforreplicationaftersavechangestimeout) + [customFetch](#customfetch) + [disableAtomicDocumentWritesInClusterWideTransaction](#disableatomicdocumentwritesinclusterwidetransaction) + [disableTopologyUpdates](#disabletopologyupdates) + [findCollectionName](#findcollectionname) + [findJsType](#_findjstype) + [findJsTypeName](#_findjstypename) + [firstBroadcastAttemptTimeout](#firstbroadcastattempttimeout) + [identityPartsSeparator](#identitypartsseparator) + [loadBalanceBehavior](#loadbalancebehavior) + [loadBalancerContextSeed](#loadbalancebehavior) + [loadBalancerPerSessionContextSelector](#loadbalancebehavior) + [maxHttpCacheSize](#maxhttpcachesize) + [maxNumberOfRequestsPerSession](#maxnumberofrequestspersession) + [readBalanceBehavior](#readbalancebehavior) + [requestTimeout](#requesttimeout) + [secondBroadcastAttemptTimeout](#secondbroadcastattempttimeout) + [sendApplicationIdentifier](#sendapplicationidentifier) + [shouldIgnoreEntityChanges](#shouldignoreentitychanges) + [storeDatesInUtc](#storedatesinutc) + [storeDatesWithTimezoneInfo](#storedateswithtimezoneinfo) + [syncJsonParseLimit](#syncjsonparselimit) + [throwIfQueryPageSizeIsNotSet](#throwifquerypagesizeisnotset) + [transformClassCollectionNameToDocumentIdPrefix](#transformclasscollectionnametodocumentidprefix) + [useCompression](#usecompression) + [useJsonlStreaming](#usejsonlstreaming) + [useOptimisticConcurrency](#useoptimisticconcurrency) + [waitForIndexesAfterSaveChangesTimeout](#waitforindexesaftersavechangestimeout) + [waitForNonStaleResultsTimeout](#waitfornonstaleresultstimeout) + [waitForReplicationAfterSaveChangesTimeout](#waitforreplicationaftersavechangestimeout) ## How to set conventions @@ -201,7 +201,7 @@ set findJsTypeName(value); * In the first attempt, the request executor will send a single request to the selected node. Learn about the "selected node" in: [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node). -* A [second attempt](../../../client-api/configuration/conventions.mdx#secondbroadcastattempttimeout) will be held upon failure. +* A [second attempt](#secondbroadcastattempttimeout) will be held upon failure. * DEFAULT: `5 seconds` @@ -328,7 +328,7 @@ set requestTimeout(value); #### secondBroadcastAttemptTimeout * Use the `secondBroadcastAttemptTimeout` convention to set the timeout for the second broadcast attempt. -* Upon failure of the [first attempt](../../../client-api/configuration/conventions.mdx#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. +* Upon failure of the [first attempt](#firstbroadcastattempttimeout) the request executor will resend the command to all nodes simultaneously. * DEFAULT: `30 seconds` diff --git a/versioned_docs/version-7.1/client-api/configuration/content/_deserialization-csharp.mdx b/versioned_docs/version-7.1/client-api/configuration/content/_deserialization-csharp.mdx index b4191f5ca9b01ff1c7c97efee6131b5c12427449..f4fde82470a3ddd80fe4725deebeb24507f7bbcc 100644 GIT binary patch delta 28 kcmew*{ZVqmN5;u&OwN<%F$GUnV-A_Tp4oA;D$7+)0IFLGmH+?% delta 168 zcmew;`Ad4kN5;uaTq2Vr82N-#Qj1fIG81z$s}f5x^Yip_Qz|BZWOT+WZ^9IeSH7Jo S1h4#UCP#eon`M} diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx index 437b1373ff..47a72c7b0e 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx index 77af4c4b60..4da59fc3f5 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `loadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'loadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'loadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx index e6635b4498..fc82d71424 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-php.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx index c1220e9dae..d3057df904 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_load-balance-behavior-python.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; requests routed to the **same node**. Gain load balancing by assigning **different contexts** to **different sessions**. * In this page: - * [LoadBalanceBehavior options](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#loadbalancebehavior-options) - * [Initialize LoadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#initialize-loadbalancebehavior-on-the-client) - * [Set LoadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#when-to-use) + * [LoadBalanceBehavior options](#loadbalancebehavior-options) + * [Initialize LoadBalanceBehavior on the client](#initialize-loadbalancebehavior-on-the-client) + * [Set LoadBalanceBehavior on the server:](#set-loadbalancebehavior-on-the-server) + * [By operation](#set-loadbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-loadbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## LoadBalanceBehavior options @@ -60,7 +60,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `LoadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the load balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/load-balance-behavior.mdx#set-loadbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'LoadBalanceBehavior' on the server, see [below](#set-loadbalancebehavior-on-the-server). **Initialize conventions**: diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx index d740865fb1..046f18627b 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx index b7d516cc38..8f4e2f81eb 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [readBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize readBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set readBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [readBalanceBehavior options](#readbalancebehavior-options) + * [Initialize readBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set readBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `readBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'readBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'readBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx index 67dfe4cc31..886e88a4a6 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-php.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx index 51148c9204..c35be01585 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/content/_read-balance-behavior-python.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; * Upon a node failure, the node to failover to is also determined by the defined option. * In this page: - * [ReadBalanceBehavior options](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options) - * [Initialize ReadBalanceBehavior on the client](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#initialize-readbalancebehavior-on-the-client) - * [Set ReadBalanceBehavior on the server:](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server) - * [By operation](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---by-operation) - * [From Studio](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server---from-studio) - * [When to use](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#when-to-use) + * [ReadBalanceBehavior options](#readbalancebehavior-options) + * [Initialize ReadBalanceBehavior on the client](#initialize-readbalancebehavior-on-the-client) + * [Set ReadBalanceBehavior on the server:](#set-readbalancebehavior-on-the-server) + * [By operation](#set-readbalancebehavior-on-the-server---by-operation) + * [From Studio](#set-readbalancebehavior-on-the-server---from-studio) + * [When to use](#when-to-use) ## readBalanceBehavior options @@ -59,7 +59,7 @@ import CodeBlock from '@theme/CodeBlock'; * The `ReadBalanceBehavior` convention can be set **on the client** when initializing the Document Store. This will set the read balance behavior for the default database that is set on the store. -* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](../../../../client-api/configuration/load-balance/read-balance-behavior.mdx#set-readbalancebehavior-on-the-server). +* This setting can be **overriden** by setting 'ReadBalanceBehavior' on the server, see [below](#set-readbalancebehavior-on-the-server). diff --git a/versioned_docs/version-7.1/client-api/configuration/load-balance/overview.mdx b/versioned_docs/version-7.1/client-api/configuration/load-balance/overview.mdx index fee668b5de..dcbfb4842c 100644 --- a/versioned_docs/version-7.1/client-api/configuration/load-balance/overview.mdx +++ b/versioned_docs/version-7.1/client-api/configuration/load-balance/overview.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Each instance is a complete replica of the database. * The [database-group-topology](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---view) is the list of nodes that contain those database replicas. - The first node in this list is called the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node). + The first node in this list is called the [preferred node](#the-preferred-node). * The client is kept up-to-date with this topology list. __The client decides which node from this list to access__ when making requests to the RavenDB cluster. @@ -28,10 +28,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [ReadBalanceBehavior](../../../client-api/configuration/load-balance/read-balance-behavior.mdx) - load balancing `Read` requests only * [LoadBalanceBehavior](../../../client-api/configuration/load-balance/load-balance-behavior.mdx) - load balancing `Read & Write` requests * In this page: - * [Keeping the client topology up-to-date](../../../client-api/configuration/load-balance/overview.mdx#keeping-the-client-topology-up-to-date) - * [Client logic for choosing a node](../../../client-api/configuration/load-balance/overview.mdx#client-logic-for-choosing-a-node) - * [The preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) - * [Single-node session usage](../../../client-api/configuration/load-balance/overview.mdx#single-node-session-usage) + * [Keeping the client topology up-to-date](#keeping-the-client-topology-up-to-date) + * [Client logic for choosing a node](#client-logic-for-choosing-a-node) + * [The preferred node](#the-preferred-node) + * [Single-node session usage](#single-node-session-usage) ## Keeping the client topology up-to-date @@ -67,7 +67,7 @@ The client uses the following logic (from top to bottom) to determine which node `Read` requests: The client will select a node based on the [read balance options](../../../client-api/configuration/load-balance/read-balance-behavior.mdx#readbalancebehavior-options). `Write` requests: All _Write_ requests will be directed to the preferred node. * Else, use the __preferred node__: - Use the [preferred node](../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) for both `Read & Write` requests. + Use the [preferred node](#the-preferred-node) for both `Read & Write` requests. diff --git a/versioned_docs/version-7.1/client-api/content/_creating-document-store-csharp.mdx b/versioned_docs/version-7.1/client-api/content/_creating-document-store-csharp.mdx index 6c3bfd1fee..691b7d18b2 100644 --- a/versioned_docs/version-7.1/client-api/content/_creating-document-store-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/content/_creating-document-store-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * **Creating a Document Store** is the _first step_ that a RavenDB client application needs to make when working with RavenDB. * We recommend that your Document Store implement the [Singleton Pattern](https://csharpindepth.com/articles/Singleton) as demonstrated in -the example code [below](../../client-api/creating-document-store.mdx#creating-a-document-store---example). +the example code [below](#creating-a-document-store---example). Creating more than one Document Store may be resource intensive, and one instance is sufficient for most use cases. * In this page: - * [Creating a Document Store - Configuration](../../client-api/creating-document-store.mdx#creating-a-document-store---configuration) - * [Certificate Disposal](../../client-api/creating-document-store.mdx#certificate-disposal) - * [Creating a Document Store - Example](../../client-api/creating-document-store.mdx#creating-a-document-store---example) + * [Creating a Document Store - Configuration](#creating-a-document-store---configuration) + * [Certificate Disposal](#certificate-disposal) + * [Creating a Document Store - Example](#creating-a-document-store---example) ## Creating a Document Store - Configuration diff --git a/versioned_docs/version-7.1/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx b/versioned_docs/version-7.1/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx index 098d83c96b..95b4621044 100644 --- a/versioned_docs/version-7.1/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/content/_setting-up-authentication-and-authorization-csharp.mdx @@ -17,7 +17,7 @@ The Client Certificate is generated by the admin from the [Studio](../../server/ certificate. * Pass your Client Certificate to the Document Store before initialization, as shown in the example code -[below](../../client-api/setting-up-authentication-and-authorization.mdx#example---initializing-document-store-with-a-client-certificate). +[below](#example---initializing-document-store-with-a-client-certificate). The server will use this certificate to authenticate the client when connection is established. diff --git a/versioned_docs/version-7.1/client-api/content/_setting-up-default-database-csharp.mdx b/versioned_docs/version-7.1/client-api/content/_setting-up-default-database-csharp.mdx index 38f3417c74..aba613c255 100644 --- a/versioned_docs/version-7.1/client-api/content/_setting-up-default-database-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/content/_setting-up-default-database-csharp.mdx @@ -17,8 +17,8 @@ The default database value itself will Not change. explicitly passed. * In this page: - * [Example - Without a Default Database](../../client-api/setting-up-default-database.mdx#example---without-a-default-database) - * [Example - With a Default Database](../../client-api/setting-up-default-database.mdx#example---with-a-default-database) + * [Example - Without a Default Database](#example---without-a-default-database) + * [Example - With a Default Database](#example---with-a-default-database) ## Example - Without a Default Database diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx index c0683651da..1dc373dca1 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-csharp.mdx @@ -8,13 +8,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers data subscriptions maintenance operations. * In this page: - * [DocumentSubscriptions class](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#documentsubscriptions-class) - * [Delete subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#delete-subscription) - * [Disabling subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disable-subscription) - * [Enable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#enable-subscription) - * [Update subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#update-subscription) - * [Drop Connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#drop-connection) - * [Get subscription state](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscription-state) + * [DocumentSubscriptions class](#documentsubscriptions-class) + * [Delete subscription](#delete-subscription) + * [Disabling subscription](#disable-subscription) + * [Enable subscription](#enable-subscription) + * [Update subscription](#update-subscription) + * [Drop Connection](#drop-connection) + * [Get subscription state](#get-subscription-state) ## DocumentSubscriptions class diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx index 994b10206c..e7cf868a4f 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * This page covers data subscriptions maintenance operations: - * [Deleting subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#deleting-subscription) - * [Dropping connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#dropping-connection) - * [Disabling subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disabling-subscription) - * [Updating subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#updating-subscription) - * [Getting subscription status](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#getting-subscription-status) + * [Deleting subscription](#deleting-subscription) + * [Dropping connection](#dropping-connection) + * [Disabling subscription](#disabling-subscription) + * [Updating subscription](#updating-subscription) + * [Getting subscription status](#getting-subscription-status) ## Deleting subscription diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx index 83379c7a73..2238aee053 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_maintenance-operations-nodejs.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers data subscriptions maintenance operations. * In this page: - * [Delete subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#delete-subscription) - * [Disable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#disable-subscription) - * [Enable subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#enable-subscription) - * [Update subscription](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#update-subscription) - * [Drop connection](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#drop-connection) - * [Get subscriptions](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscriptions) - * [Get subscription state](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#get-subscription-state) - * [DocumentSubscriptions class](../../../../client-api/data-subscriptions/advanced-topics/maintenance-operations.mdx#documentsubscriptions-class) + * [Delete subscription](#delete-subscription) + * [Disable subscription](#disable-subscription) + * [Enable subscription](#enable-subscription) + * [Update subscription](#update-subscription) + * [Drop connection](#drop-connection) + * [Get subscriptions](#get-subscriptions) + * [Get subscription state](#get-subscription-state) + * [DocumentSubscriptions class](#documentsubscriptions-class) ## Delete subscription diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx index 25f8ad1e10..69b500b71e 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-csharp.mdx @@ -15,11 +15,11 @@ import CodeBlock from '@theme/CodeBlock'; See how to create and consume it in the examples below. * In this page: - * [Regular subscription vs Revisions subscription](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#regular-subscription-vs-revisions-subscription) - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple creation and consumption](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption) - * [Filtering revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#filtering-revisions) - * [Projecting fields from revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions) + * [Regular subscription vs Revisions subscription](#regular-subscription-vs-revisions-subscription) + * [Revisions processing order](#revisions-processing-order) + * [Simple creation and consumption](#simple-creation-and-consumption) + * [Filtering revisions](#filtering-revisions) + * [Projecting fields from revisions](#projecting-fields-from-revisions) ## Regular subscription vs Revisions subscription @@ -46,7 +46,7 @@ import CodeBlock from '@theme/CodeBlock'; * **Query access scope**: For each revision, the subscription query running on the server has access to both the currently processed revision and its previous revision. * **Data sent to client**: - By default, unless the subscription query is [projecting specific fields](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions), + By default, unless the subscription query is [projecting specific fields](#projecting-fields-from-revisions), each item in the batch sent to the client contains both the processed revision (`Result.Current`) and its preceding revision (`Result.Previous`). If the document has just been created, the previous revision will be `null`. @@ -285,7 +285,7 @@ Here we define a revisions subscription that will filter the revisions and send Since the revision fields are projected into the `OrderRevenues` class in the subscription definition, each item received in the batch has the format of this projected class instead of the default `Result.Previous` and `Result.Current` fields, -as was demonstrated in the [simple example](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption). +as was demonstrated in the [simple example](#simple-creation-and-consumption). diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx index f0278bbcda..25d891e229 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-java.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; Both revisions are accessible for filtering and projection. * In this page: - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple declaration and usage](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-declaration-and-usage) - * [Revisions processing and projection](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-and-projection) + * [Revisions processing order](#revisions-processing-order) + * [Simple declaration and usage](#simple-declaration-and-usage) + * [Revisions processing and projection](#revisions-processing-and-projection) ## Revisions processing order diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx index ccb9d4e4bb..f703754297 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/advanced-topics/content/_subscription-with-revisioning-nodejs.mdx @@ -15,11 +15,11 @@ import CodeBlock from '@theme/CodeBlock'; See how to create and consume it in the examples below. * In this page: - * [Regular subscription vs Revisions subscription](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#regular-subscription-vs-revisions-subscription) - * [Revisions processing order](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#revisions-processing-order) - * [Simple creation and consumption](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption) - * [Filtering revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#filtering-revisions) - * [Projecting fields from revisions](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#projecting-fields-from-revisions) + * [Regular subscription vs Revisions subscription](#regular-subscription-vs-revisions-subscription) + * [Revisions processing order](#revisions-processing-order) + * [Simple creation and consumption](#simple-creation-and-consumption) + * [Filtering revisions](#filtering-revisions) + * [Projecting fields from revisions](#projecting-fields-from-revisions) ## Regular subscription vs Revisions subscription @@ -248,7 +248,7 @@ Here we define a revisions subscription that will filter the revisions and send Since the revision fields are projected into the `OrderRevenues` class in the subscription definition, each item received in the batch has the format of this projected class instead of the default `result.previous` and `result.current` fields, -as was demonstrated in the [simple example](../../../../client-api/data-subscriptions/advanced-topics/subscription-with-revisioning.mdx#simple-creation-and-consumption). +as was demonstrated in the [simple example](#simple-creation-and-consumption). diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx index d172cdbad9..de8d8a01d3 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-csharp.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [SubscriptionBatch<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht) - * [SubscriptionBatch<T>.Item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) - * [SubscriptionWorker<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert) + * [Create the subscription worker](#create-the-subscription-worker) + * [SubscriptionWorkerOptions](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [SubscriptionBatch<T>](#subscriptionbatcht) + * [SubscriptionBatch<T>.Item](#subscriptionbatchtitem) + * [SubscriptionWorker<T>](#subscriptionworkert) ## Create the subscription worker @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; A subscription worker can be created using the following `GetSubscriptionWorker` methods available through the `Subscriptions` property of the `DocumentStore`. Note: Simply creating the worker is insufficient; -after creating the worker, you need to [run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) to initiate document processing. +after creating the worker, you need to [run the subscription worker](#run-the-subscription-worker) to initiate document processing. @@ -112,8 +112,8 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../. ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. -To start processing, you need to call the `Run` method of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert). +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +To start processing, you need to call the `Run` method of the [SubscriptionWorker](#subscriptionworkert). The `Run` function takes a delegate, which is your client-side code responsible for processing the received document batches. @@ -144,7 +144,7 @@ Task Run(Func, Task> processDocuments, | Member | Type | Description | |--------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatchtitem) below. | +| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](#subscriptionbatchtitem) below. | | **NumberOfItemsInBatch** | `int` | Number of items in the batch. | | Method Signature | Return value | Description | @@ -215,7 +215,7 @@ Using it outside this scope may cause unexpected behavior. | **DisposeAsync()** | `Task` | Async version of `Dispose()`. | | **Dispose(bool waitForSubscriptionTask)** | `void` | Aborts the subscription worker, but allows deciding whether to wait for the `Run` function task or not. | | **DisposeAsync(bool waitForSubscriptionTask)** | `Task` | Async version of `DisposeAsync(bool waitForSubscriptionTask)`. | -| **Run (multiple overloads)** | `Task` | Call `Run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| **Run (multiple overloads)** | `Task` | Call `Run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx index 57f4671bf4..a92c10a679 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-java.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [SubscriptionBatch<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatcht) - * [SubscriptionWorker<T>](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert) + * [Create the subscription worker](#create-the-subscription-worker) + * [SubscriptionWorkerOptions](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [SubscriptionBatch<T>](#subscriptionbatcht) + * [SubscriptionWorker<T>](#subscriptionworkert) ## Create the subscription worker @@ -73,8 +73,8 @@ All other parameters are optional and will default to their respective default v ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. -To start processing, you need to call the `run` method of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkert). +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +To start processing, you need to call the `run` method of the [SubscriptionWorker](#subscriptionworkert). The `run` function takes a delegate, which is your client-side code responsible for processing the received document batches. @@ -147,7 +147,7 @@ if T is `ObjectNode`, no deserialization will take place | Method Signature | Return Type | Description | |------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **close()** | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | -| **run (multiple overloads)** | `CompletableFuture` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| **run (multiple overloads)** | `CompletableFuture` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx index 31a3deb17d..0e4ca997ef 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-nodejs.mdx @@ -6,12 +6,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [Subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker-options) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [Subscription batch](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch) - * [Subscription batch item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch-item) - * [Subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker) + * [Create the subscription worker](#create-the-subscription-worker) + * [Subscription worker options](#subscription-worker-options) + * [Run the subscription worker](#run-the-subscription-worker) + * [Subscription batch](#subscription-batch) + * [Subscription batch item](#subscription-batch-item) + * [Subscription worker](#subscription-worker) ## Create the subscription worker @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; A subscription worker can be created using the following `getSubscriptionWorker` methods available through the `subscriptions` property of the `documentStore`. Note: Simply creating the worker is insufficient; -after creating the worker, you need to [run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) to initiate document processing. +after creating the worker, you need to [run the subscription worker](#run-the-subscription-worker) to initiate document processing. @@ -36,11 +36,11 @@ await documentStore.subscriptions.getSubscriptionWorker(options, database); |----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **subscriptionName** | `string` | The name of the subscription to which the worker will connect. | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in DocumentStore will be used. | -| **options** | `object` | [Subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker-options) object that affect how the worker interacts with the subscription. These options do not alter the definition of the subscription itself. | +| **options** | `object` | [Subscription worker options](#subscription-worker-options) object that affect how the worker interacts with the subscription. These options do not alter the definition of the subscription itself. | | Return value | | |----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `SubscriptionWorker` | The [subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-worker) that has been created.
The worker will start processing documents once you define the worker's `on` method,
which listens to the `batch` event. | +| `SubscriptionWorker` | The [subscription worker](#subscription-worker) that has been created.
The worker will start processing documents once you define the worker's `on` method,
which listens to the `batch` event. | @@ -82,7 +82,7 @@ All other parameters are optional and will default to their respective default v ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. To initiate processing, you need to define an event handler and attach it to the worker's `batch` event listener. This handler contains your client-side code responsible for processing the document batches received from the server. @@ -113,7 +113,7 @@ The subscription batch class contains the following public properties & methods: | Property | Type | Description | |-------------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **items** | `Item[]` | List of items in the batch.
See [subscription batch item](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscription-batch-item). | +| **items** | `Item[]` | List of items in the batch.
See [subscription batch item](#subscription-batch-item). | | Method | Return type | Description | |-------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------| diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx index 392247d01e..564124ca34 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_api-overview-python.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) - * [`SubscriptionWorkerOptions`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions) - * [Run the subscription worker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker) - * [`SubscriptionBatch[_T]`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch_t) - * [`SubscriptionWorker[_T]`](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker_t) + * [Create the subscription worker](#create-the-subscription-worker) + * [`SubscriptionWorkerOptions`](#subscriptionworkeroptions) + * [Run the subscription worker](#run-the-subscription-worker) + * [`SubscriptionBatch[_T]`](#subscriptionbatch_t) + * [`SubscriptionWorker[_T]`](#subscriptionworker_t) ## Create the subscription worker @@ -82,7 +82,7 @@ Learn more about `SubscriptionOpeningStrategy` in [worker strategies](../../../. ## Run the subscription worker -After [creating](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. +After [creating](#create-the-subscription-worker) a subscription worker, the subscription worker is still not processing any documents. To start processing, you need to call the `run` function of the [SubscriptionWorker](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker[_t]). The `run` function receives the client-side code as a function that will process the received document batches. @@ -180,7 +180,7 @@ is not supported. | Method | Return Type | Description | |-------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `close(bool wait_for_subscription_task = True)` | `void` | Aborts subscription worker operation ungracefully by waiting for the task returned by the `run` function to finish running. | -| `run` | `Future[None]` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#run-the-subscription-worker)). | +| `run` | `Future[None]` | Call `run` to begin the worker's batch processing.
Pass the batch processing delegates to this method
(see [above](#run-the-subscription-worker)). | ### Events: | Event | Type\Return type | Description | diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx index 65e0901c3f..da087b81b8 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-csharp.mdx @@ -6,15 +6,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Worker that processes a blittable object](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-a-blittable-object) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Subscription workers with failover on other nodes](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-workers-with-failover-on-other-nodes) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Worker that processes a blittable object](#worker-that-processes-a-blittable-object) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Subscription workers with failover on other nodes](#subscription-workers-with-failover-on-other-nodes) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-java.mdx index 8466cf34ac..102d7ccae3 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-java.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * this page: - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Subscription that ends when no documents left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-left) - * [Worker that processes raw objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#sworker-that-processes-raw-objects) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Subscription that ends when no documents left](#subscription-that-ends-when-no-documents-left) + * [Worker that processes raw objects](#sworker-that-processes-raw-objects) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Worker with a specified batch size diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx index e2c5222311..32482747b6 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-nodejs.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-python.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-python.mdx index f2a6937706..c2ce17e968 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-python.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_examples-python.mdx @@ -6,14 +6,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Client with full exception handling and processing retries](../../../../client-api/data-subscriptions/consumption/examples.mdx#client-with-full-exception-handling-and-processing-retries) - * [Worker with a specified batch size](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-with-a-specified-batch-size) - * [Worker that operates with a session](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-operates-with-a-session) - * [Worker that processes dynamic objects](../../../../client-api/data-subscriptions/consumption/examples.mdx#worker-that-processes-dynamic-objects) - * [Subscription that ends when no documents are left](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-ends-when-no-documents-are-left) - * [Subscription that uses included documents](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-that-uses-included-documents) - * [Subscription workers with failover on other nodes](../../../../client-api/data-subscriptions/consumption/examples.mdx#subscription-workers-with-failover-on-other-nodes) - * [Primary and secondary workers](../../../../client-api/data-subscriptions/consumption/examples.mdx#primary-and-secondary-workers) + * [Client with full exception handling and processing retries](#client-with-full-exception-handling-and-processing-retries) + * [Worker with a specified batch size](#worker-with-a-specified-batch-size) + * [Worker that operates with a session](#worker-that-operates-with-a-session) + * [Worker that processes dynamic objects](#worker-that-processes-dynamic-objects) + * [Subscription that ends when no documents are left](#subscription-that-ends-when-no-documents-are-left) + * [Subscription that uses included documents](#subscription-that-uses-included-documents) + * [Subscription workers with failover on other nodes](#subscription-workers-with-failover-on-other-nodes) + * [Primary and secondary workers](#primary-and-secondary-workers) ## Client with full exception handling and processing retries diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx index 7379c89553..d164ce8d55 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see [SubscriptionWorkerOptions](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions). * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## SubscriptionWorker lifecycle @@ -55,7 +55,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -179,15 +179,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [concurrent](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [concurrent](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx index ccc4a0db5e..c00a2e325c 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-java.mdx @@ -10,9 +10,9 @@ A `SubscriptionWorker` object manages the documents processing and the communica We've introduced several ways to create and configure a SubscriptionWorker, starting from just giving a subscription name, and ending with a detailed configuration object - `SubscriptionWorkerOptions`. * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) ## SubscriptionWorker lifecycle @@ -52,7 +52,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx index 83eafbe3aa..621e624247 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see [subscription worker options](../../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworkeroptions). * In this page: - * [SubscriptionWorker lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscriptionworker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [SubscriptionWorker lifecycle](#subscriptionworker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## SubscriptionWorker lifecycle @@ -73,7 +73,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -185,15 +185,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [concurrent](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [concurrent](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [concurrent](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx index c9f14b40d8..70a0049646 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/consumption/content/_how-to-consume-data-subscription-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * There are several ways to create and configure the SubscriptionWorker - see `SubscriptionWorkerOptions`. * In this page: - * [`subscription_worker` lifecycle](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#subscription_worker-lifecycle) - * [Error handling](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#error-handling) - * [Worker strategies](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#worker-strategies) - * [Determining which workers a subscription will serve](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#determining-which-workers-a-subscription-will-serve) + * [`subscription_worker` lifecycle](#subscription_worker-lifecycle) + * [Error handling](#error-handling) + * [Worker strategies](#worker-strategies) + * [Determining which workers a subscription will serve](#determining-which-workers-a-subscription-will-serve) ## `subscription_worker` lifecycle @@ -54,7 +54,7 @@ When an unexpected error arises, the worker will attempt to **reconnect to the s However, there are several conditions under which the worker will stop its operation but will Not attempt to reconnect: * The subscription no longer exists or has been deleted. -* Another worker has taken control of the subscription (see [connection strategy](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#available-worker-strategies)). +* Another worker has taken control of the subscription (see [connection strategy](#available-worker-strategies)). * The worker is unable to connect to any of the servers. * The worker could not receive the node responsible for the task (this can happen when there is no leader in the cluster). @@ -163,15 +163,15 @@ which additional workers the subscription can serve until all worker connections -* A subscription that serves one or more [CONCURRENT](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) workers, +* A subscription that serves one or more [CONCURRENT](#multiple-workers-per-subscription-strategy) workers, **can only serve other concurrent workers** until all connections are dropped. - If a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) + If a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy attempts to connect - * The connection attempt will be rejected. * `SubscriptionInUseException` will be thrown. -* A subscription that serves a worker with a [one worker per subscription](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#one-worker-per-subscription-strategies) strategy, - **cannot** serve [CONCURRENT](../../../../client-api/data-subscriptions/consumption/how-to-consume-data-subscription.mdx#multiple-workers-per-subscription-strategy) +* A subscription that serves a worker with a [one worker per subscription](#one-worker-per-subscription-strategies) strategy, + **cannot** serve [CONCURRENT](#multiple-workers-per-subscription-strategy) workers until that worker's connection is dropped. If a concurrent worker attempts to connect - * The connection attempt will be rejected. diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx index 7a1ed39051..27fe8fcfea 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * Documents that were assigned to workers whose connection has ended unexpectedly, can be reassigned by the server to available workers. - See [connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) below. + See [connection failure](#connection-failure) below. * In this page: - * [Defining concurrent workers](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#defining-concurrent-workers) - * [Dropping a connection](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#dropping-a-connection) - * [Connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) + * [Defining concurrent workers](#defining-concurrent-workers) + * [Dropping a connection](#dropping-a-connection) + * [Connection failure](#connection-failure) ## Defining concurrent workers diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx index 1e0836f58b..34d0e7362c 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_concurrent-subscriptions-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * Documents that were assigned to workers whose connection has ended unexpectedly, can be reassigned by the server to available workers. - See [connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) below. + See [connection failure](#connection-failure) below. * In this page: - * [Defining concurrent workers](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#defining-concurrent-workers) - * [Dropping a connection](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#dropping-a-connection) - * [Connection failure](../../../client-api/data-subscriptions/concurrent-subscriptions.mdx#connection-failure) + * [Defining concurrent workers](#defining-concurrent-workers) + * [Dropping a connection](#dropping-a-connection) + * [Connection failure](#connection-failure) ## Defining concurrent workers diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx index 5948b0ed9a..8a59dbf231 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) ## Data subscription consumption diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx index 5199e144b2..b0ba14a913 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-java.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx index d0c082823b..982ac5045a 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/content/_what-are-data-subscriptions-nodejs.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; The server persists the processing progress, allowing you to pause and continue the processing. * In this page: - * [Data subscription consumption](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscription-consumption) - * [What defines a data subscription](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#what-defines-a-data-subscription) - * [Documents processing](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#documents-processing) - * [Progress Persistence](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#progress-persistence) - * [How the worker communicates with the server](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#how-the-worker-communicates-with-the-server) - * [Working with multiple clients](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#working-with-multiple-clients) - * [Data subscriptions usage example](../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx#data-subscriptions-usage-example) + * [Data subscription consumption](#data-subscription-consumption) + * [What defines a data subscription](#what-defines-a-data-subscription) + * [Documents processing](#documents-processing) + * [Progress Persistence](#progress-persistence) + * [How the worker communicates with the server](#how-the-worker-communicates-with-the-server) + * [Working with multiple clients](#working-with-multiple-clients) + * [Data subscriptions usage example](#data-subscriptions-usage-example) diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx index dc05ade4dd..a8bbde626f 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-csharp.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [Subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options) - * [Subscription query](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query) + * [Create subscription](#create-subscription) + * [Subscription creation options](#subscription-creation-options) + * [Update subscription](#update-subscription) + * [Subscription update options](#subscription-update-options) + * [Subscription query](#subscription-query) ## Create subscription @@ -55,9 +55,9 @@ Task CreateAsync(Expression> predicate = null, | Parameter | Type | Description | |----------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **predicate** | `Expression>` | An optional lambda expression that returns a boolean.
This predicate defines the filter criteria for the subscription documents. | -| **options** | `SubscriptionCreationOptions` | Contains subscription creation options.
See [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) | -| **options** | `SubscriptionCreationOptions` | Contains subscription creation options
(non-generic version).
See [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) | -| **options** | `PredicateSubscriptionCreationOptions ` | Contains subscription creation options
(when passing a predicate).
See [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) | +| **options** | `SubscriptionCreationOptions` | Contains subscription creation options.
See [Subscription creation options](#subscription-creation-options) | +| **options** | `SubscriptionCreationOptions` | Contains subscription creation options
(non-generic version).
See [Subscription creation options](#subscription-creation-options) | +| **options** | `PredicateSubscriptionCreationOptions ` | Contains subscription creation options
(when passing a predicate).
See [Subscription creation options](#subscription-creation-options) | | **database** | `string` | The name of the database where the subscription task will be created. If `null`, the default database configured in the DocumentStore will be used. | | **token** | `CancellationToken` | Cancellation token used in to halt the subscription creation process. | @@ -139,7 +139,7 @@ Options for the **non-generic** version of the subscription creation options obj | **Filter** | `Expression>` | Lambda expression defining the filter logic for the subscription. Will be translated to a JavaScript function. | | **Projection** | `Expression>` | Lambda expression defining the projection that will be sent by the subscription for each matching document. Will be translated to a JavaScript function. | | **Includes** | `Action>` | An action that defines include clauses for the subscription. [Included documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) and/or [included counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) will be part of the batch sent by the subscription. Include methods can be chained. | -| **ChangeVector** | `string` | Allows to define a change vector from which the subscription will start processing.
Learn more [below](../../../../client-api/data-subscriptions/creation/api-overview.mdx#the--property). | +| **ChangeVector** | `string` | Allows to define a change vector from which the subscription will start processing.
Learn more [below](#the--property). | | **Disabled** | `bool` | `true` - task will be disabled.
`false` - task will be enabled. | | **MentorNode** | `string` | Allows to define a node in the cluster that will be responsible to handle the subscription. Useful when you prefer a specific server due to its stronger hardware, closer geographic proximity to clients, or other reasons. | | **PinToMentorNode** | `bool` | `true` - the selected responsible node will be pinned to handle the task.
`false` - Another node will execute the task if the responsible node is down. | @@ -175,7 +175,7 @@ Task UpdateAsync(SubscriptionUpdateOptions options, string database = nu | Parameter | Type | Description | |--------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `SubscriptionUpdateOptions` | The subscription update options object.
See [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) | +| **options** | `SubscriptionUpdateOptions` | The subscription update options object.
See [SubscriptionUpdateOptions](#subscriptionupdateoptions) | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in the DocumentStore will be used. | | **token** | `CancellationToken` | Cancellation token used to halt the update process. | @@ -187,7 +187,7 @@ Task UpdateAsync(SubscriptionUpdateOptions options, string database = nu ## Subscription update options -`SubscriptionUpdateOptions` inherits from [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) +`SubscriptionUpdateOptions` inherits from [SubscriptionCreationOptions](#subscriptioncreationoptions) and adds two additional fields: diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx index 154528cb19..c73019a8bd 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-nodejs.mdx @@ -6,13 +6,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [Subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) - * [Include methods](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [Subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options) - * [Subscribe to revisions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscribe-to-revisions) - * [Subscription RQL](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-rql) + * [Create subscription](#create-subscription) + * [Subscription creation options](#subscription-creation-options) + * [Include methods](#include-methods) + * [Update subscription](#update-subscription) + * [Subscription update options](#subscription-update-options) + * [Subscribe to revisions](#subscribe-to-revisions) + * [Subscription RQL](#subscription-rql) ## Create subscription @@ -35,13 +35,13 @@ create(documentType); | Parameter | Type | Description | |------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options). | +| **options** | `object` | The [subscription creation options](#subscription-creation-options). | | **database** | `string` | The name of the database where the subscription task will be created.
If `null`, the default database configured in the DocumentStore will be used. | | **documentType** | `object` | The class type from which the collection of documents managed by the subscription will be derived. | | Return value | Description | |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Promise` | A Promise that resolves to the **name** of the created data subscription (a `string`).
If the name was provided in the [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options), it will be returned.
Otherwise, a unique name will be generated by server. | +| `Promise` | A Promise that resolves to the **name** of the created data subscription (a `string`).
If the name was provided in the [subscription creation options](#subscription-creation-options), it will be returned.
Otherwise, a unique name will be generated by server. | Examples for creating subscriptions are available [here](../../../../client-api/data-subscriptions/creation/examples.mdx). @@ -70,8 +70,8 @@ Examples for creating subscriptions are available [here](../../../../client-api/ | Member | Type | Description | |---------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **name** | `string` | User defined name for the subscription.
The name must be unique in the database. | -| **query** | `string` | RQL query that defines the subscription. This RQL comes with additional support to JavaScript functions inside the `where` clause and special semantics for subscriptions on documents revisions.
Learn more in [subscription RQL](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-rql). | -| **includes** | `(builder) => void` | A function that accepts a builder object, which allows you to include related documents, counters, and time series in the batch that is sent to the client.
See [Include methods](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods). | +| **query** | `string` | RQL query that defines the subscription. This RQL comes with additional support to JavaScript functions inside the `where` clause and special semantics for subscriptions on documents revisions.
Learn more in [subscription RQL](#subscription-rql). | +| **includes** | `(builder) => void` | A function that accepts a builder object, which allows you to include related documents, counters, and time series in the batch that is sent to the client.
See [Include methods](#include-methods). | | **changeVector** | `string` | Allows to define a change vector from which the subscription will start processing. Useful for ad-hoc processes that need to process only recent changes. In such cases, you can set the field to _"LastDocument"_ to start processing from the latest document in the collection. | | **mentorNode** | `string` | Allows to define a specific node in the cluster to handle the subscription. Useful when you prefer a specific server due to its stronger hardware, closer geographic proximity to clients, or other reasons. | | **pinToMentorNode** | `boolean` | `true` - task will only be handled by the specified mentor node.
`false` - When the specified mentor node is down, the cluster selects another node from the Database Group to handle the task.
Learn more in [pinning a task](../../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task). | @@ -163,7 +163,7 @@ update(options, database); | Parameter | Type | Description | |--------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription update options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-update-options). | +| **options** | `object` | The [subscription update options](#subscription-update-options). | | **database** | `string` | The name of the database where the subscription task resides.
If `null`, the default database configured in the DocumentStore will be used. | | Return value | Description | @@ -176,7 +176,7 @@ Examples for updating an existing subscription are available [here](../../../../ ## Subscription update options -The subscription update options object extends the [creation options object](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options) +The subscription update options object extends the [creation options object](#subscription-creation-options) and adds two additional fields: @@ -221,7 +221,7 @@ createForRevisions(options, database); | Parameter | Type | Description | |--------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| **options** | `object` | The [subscription creation options](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-creation-options). | +| **options** | `object` | The [subscription creation options](#subscription-creation-options). | | **database** | `string` | The name of the database where the subscription task will be created.
If `null`, the default database configured in the DocumentStore will be used. | When providing raw RQL to the `query` param in the options object, diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-python.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-python.mdx index 42a4912648..aba6c34a85 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-python.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_api-overview-python.mdx @@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Create subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#create-subscription) - * [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions) - * [Update subscription](../../../../client-api/data-subscriptions/creation/api-overview.mdx#update-subscription) - * [SubscriptionUpdateOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptionupdateoptions) - * [Subscription query](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscription-query) + * [Create subscription](#create-subscription) + * [SubscriptionCreationOptions](#subscriptioncreationoptions) + * [Update subscription](#update-subscription) + * [SubscriptionUpdateOptions](#subscriptionupdateoptions) + * [Subscription query](#subscription-query) ## Create subscription @@ -99,7 +99,7 @@ Modifies an existing data subscription. These methods are accessible at `Documen ## SubscriptionUpdateOptions -Inherits from `SubscriptionCreationOptions` and has all the same fields (see [above](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptions)) plus the two additional fields described below: +Inherits from `SubscriptionCreationOptions` and has all the same fields (see [above](#subscriptioncreationoptions)) plus the two additional fields described below: diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-csharp.mdx index 8d8a9d2253..b2ac089d4f 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-csharp.mdx @@ -11,15 +11,15 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Create subscription - subscribe to revisions](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---subscribe-to-revisions) - * [Create subscription - via update](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---via-update) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Create subscription - subscribe to revisions](#create-subscription---subscribe-to-revisions) + * [Create subscription - via update](#create-subscription---via-update) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -263,7 +263,7 @@ See how to consume this type of subscription [here](../../../../client-api/data- Include statements can be added to the subscription with `ISubscriptionIncludeBuilder`. This builder is assigned to the `Includes` property in [SubscriptionCreationOptions<T>](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst). -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. To include related documents, use method `IncludeDocuments`. @@ -287,7 +287,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx index 665881ccf8..9af2bc5cae 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-nodejs.mdx @@ -11,15 +11,15 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Create subscription - subscribe to revisions](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---subscribe-to-revisions) - * [Create subscription - via update](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---via-update) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Create subscription - subscribe to revisions](#create-subscription---subscribe-to-revisions) + * [Create subscription - via update](#create-subscription---via-update) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -222,7 +222,7 @@ const subscriptionName = await documentStore.subscriptions.create({ query }); Include statements can be added to the subscription with a _builder_ object. This builder is assigned to the `includes` property in the _options_ object. -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. See this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx#include-methods) for all available include methods. @@ -248,7 +248,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-python.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-python.mdx index 69f8adc10c..e083c09cf1 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-python.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_examples-python.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; * For a detailed syntax of the available subscription methods and objects, see this [API overview](../../../../client-api/data-subscriptions/creation/api-overview.mdx). * In this page: - * [Create subscription - for all documents in a collection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---for-all-documents-in-a-collection) - * [Create subscription - filter documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-documents) - * [Create subscription - filter and project fields](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields) - * [Create subscription - project data from a related document](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---project-data-from-a-related-document) - * [Create subscription - include documents](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-documents) - * [Create subscription - include counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters) - * [Update existing subscription](../../../../client-api/data-subscriptions/creation/examples.mdx#update-existing-subscription) + * [Create subscription - for all documents in a collection](#create-subscription---for-all-documents-in-a-collection) + * [Create subscription - filter documents](#create-subscription---filter-documents) + * [Create subscription - filter and project fields](#create-subscription---filter-and-project-fields) + * [Create subscription - project data from a related document](#create-subscription---project-data-from-a-related-document) + * [Create subscription - include documents](#create-subscription---include-documents) + * [Create subscription - include counters](#create-subscription---include-counters) + * [Update existing subscription](#update-existing-subscription) ## Create subscription - for all documents in a collection @@ -208,7 +208,7 @@ See how to consume this type of subscription [here](../../../../client-api/data- Include statements can be added to the subscription with `SubscriptionIncludeBuilder`. This builder is assigned to the `includes` property in [SubscriptionCreationOptions](../../../../client-api/data-subscriptions/creation/api-overview.mdx#subscriptioncreationoptionst). -It supports methods for including documents as well as [counters](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). +It supports methods for including documents as well as [counters](#create-subscription---include-counters). These methods can be chained. To include related documents, use method `include_documents`. @@ -232,7 +232,7 @@ The include statements can be written in two ways: -If you include documents when making a [projection](../../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---filter-and-project-fields), +If you include documents when making a [projection](#create-subscription---filter-and-project-fields), the include will search for the specified paths in the projected fields rather than in the original document. diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx index 1ea774503c..454abc5712 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-csharp.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx index e7e5952443..748af66246 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-java.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx index 5aed7ed6c4..edcc70d9df 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-nodejs.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx index 7136152ec7..e4b9a9cf28 100644 --- a/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx +++ b/versioned_docs/version-7.1/client-api/data-subscriptions/creation/content/_how-to-create-data-subscription-python.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; * From that point and on, clients that will connect to a server in order to consume the subscription will be redirected to the node mentioned above. * In this page: - * [Subscription creation](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-creation) - * [Subscription name](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#subscription-name) - * [Responsible node](../../../../client-api/data-subscriptions/creation/how-to-create-data-subscription.mdx#responsible-node) + * [Subscription creation](#subscription-creation) + * [Subscription name](#subscription-name) + * [Responsible node](#responsible-node) ## Subscription creation diff --git a/versioned_docs/version-7.1/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx b/versioned_docs/version-7.1/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx index 938d90661f..614dfe4c4d 100644 --- a/versioned_docs/version-7.1/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/document-identifiers/content/_hilo-algorithm-csharp.mdx @@ -22,15 +22,15 @@ import Panel from "@site/src/components/Panel"; and how to manually generate HiLo-based IDs when needed. * In this article: - * [How the HiLo algorithm works in RavenDB](../../../client-api/document-identifiers/hilo-algorithm.mdx#how-the-hilo-algorithm-works-in-ravendb) - * [Generating unique IDs efficiently](../../../client-api/document-identifiers/hilo-algorithm.mdx#generating-unique-ids-efficiently) - * [Using HiLo documents](../../../client-api/document-identifiers/hilo-algorithm.mdx#using-hilo-documents) - * [Returning HiLo ranges](../../../client-api/document-identifiers/hilo-algorithm.mdx#returning-hilo-ranges) - * [Identity parts separator](../../../client-api/document-identifiers/hilo-algorithm.mdx#identity-parts-separator) - * [Manual HiLo ID generation](../../../client-api/document-identifiers/hilo-algorithm.mdx#manual-hilo-id-generation) - * [Get next ID - number only](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) - * [Get next ID - full document ID](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) - * [Overriding the HiLo algorithm](../../../client-api/document-identifiers/hilo-algorithm.mdx#overriding-the-hilo-algorithm) + * [How the HiLo algorithm works in RavenDB](#how-the-hilo-algorithm-works-in-ravendb) + * [Generating unique IDs efficiently](#generating-unique-ids-efficiently) + * [Using HiLo documents](#using-hilo-documents) + * [Returning HiLo ranges](#returning-hilo-ranges) + * [Identity parts separator](#identity-parts-separator) + * [Manual HiLo ID generation](#manual-hilo-id-generation) + * [Get next ID - number only](#get-next-id---number-only) + * [Get next ID - full document ID](#get-next-id---full-document-id) + * [Overriding the HiLo algorithm](#overriding-the-hilo-algorithm) @@ -188,8 +188,8 @@ using (var session = newStore.OpenSession()) You can ask the default HiLo generator for the next ID value without storing a document first. You can retrieve either the next number from the HiLo range or the next full document ID, and then use that value when storing a document, as explained below: - * [Get next ID - number only](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) - * [Get next ID - full document ID](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) + * [Get next ID - number only](#get-next-id---number-only) + * [Get next ID - full document ID](#get-next-id---full-document-id) --- @@ -372,8 +372,8 @@ using (var session = store.OpenSession()) * Once you configure a custom `AsyncDocumentIdGenerator`: * Your custom ID generation logic is used whenever the session stores a document whose `Id` property is `null`. * The store's default `HiLoIdGenerator` is no longer available. - Calling [GenerateNextIdForAsync](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---number-only) or - [GenerateDocumentIdAsync](../../../client-api/document-identifiers/hilo-algorithm.mdx#get-next-id---full-document-id) through `store.HiLoIdGenerator` + Calling [GenerateNextIdForAsync](#get-next-id---number-only) or + [GenerateDocumentIdAsync](#get-next-id---full-document-id) through `store.HiLoIdGenerator` will throw an exception. \ No newline at end of file diff --git a/versioned_docs/version-7.1/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx b/versioned_docs/version-7.1/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx index 47c23ff8ee..6c9d91a806 100644 --- a/versioned_docs/version-7.1/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/document-identifiers/content/_working-with-document-identifiers-csharp.mdx @@ -17,14 +17,14 @@ import CodeBlock from '@theme/CodeBlock'; by the HiLo algorithm. As described below, this is how the identifier is generated by the session. * In this page: - * [Session Usage](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#session-usage) - * [Autogenerated IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#autogenerated-ids) + * [Session Usage](#session-usage) + * [Autogenerated IDs](#autogenerated-ids) * [Custom / Semantic IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#custom-/-semantic-ids) - * [Server-side generated IDs](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids) - * [Identities](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities) - * [Setting Identity IDs Using Commands and Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#setting-identity-ids-using-commands-and-operations) - * [Using Commands](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-commands) - * [Using Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-operations) + * [Server-side generated IDs](#server-side-generated-ids) + * [Identities](#identities) + * [Setting Identity IDs Using Commands and Operations](#setting-identity-ids-using-commands-and-operations) + * [Using Commands](#using-commands) + * [Using Operations](#using-operations) ## Session Usage @@ -260,7 +260,7 @@ and might affect performance. By default, document IDs created by the server use `/` to separate their components. This separator can be changed to any other character except `|`, in the [Global Identifier Generation Conventions](../../../client-api/configuration/identifier-generation/global.mdx#identitypartsseparator). -See [Setting Identity IDs Using Commands and Operations](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#setting-identity-ids-using-commands-and-operations) +See [Setting Identity IDs Using Commands and Operations](#setting-identity-ids-using-commands-and-operations) for details. * **Concurrent writes** @@ -350,7 +350,7 @@ session.Advanced.RequestExecutor.Execute(putCommand, session.Advanced.Context); RavenDB ver. 4.2 and higher provides high-level [operations](../../../client-api/operations/what-are-operations.mdx#operations-what-are-the-operations) that you may set IDs with, in addition to the -low-level [commands](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#using-commands) +low-level [commands](#using-commands) we have described above. There is no operational difference between using operations and commands, since the high-level operations actually execute low-level commands. However, using operations may produce a clearer, more concise code. diff --git a/versioned_docs/version-7.1/client-api/faq/backward-compatibility.mdx b/versioned_docs/version-7.1/client-api/faq/backward-compatibility.mdx index d58f7f2572..64756da561 100644 --- a/versioned_docs/version-7.1/client-api/faq/backward-compatibility.mdx +++ b/versioned_docs/version-7.1/client-api/faq/backward-compatibility.mdx @@ -21,13 +21,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; compatible, and advises regarding upgrading. * In this page: - * [Client-Server Compatibility](../../client-api/faq/backward-compatibility.mdx#client-server-compatibility) - * [Compatibility - Up to RavenDB 4.1](../../client-api/faq/backward-compatibility.mdx#compatibility---up-to-ravendb-41) - * [Compatibility - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-42-and-higher) - * [Upgrading](../../client-api/faq/backward-compatibility.mdx#upgrading) - * [Upgrading - Up to RavenDB 4.1](../../client-api/faq/backward-compatibility.mdx#upgrading---up-to-ravendb-41) - * [Upgrading - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#upgrading---ravendb-42-and-higher) - * [Upgrading Order](../../client-api/faq/backward-compatibility.mdx#upgrading-order) + * [Client-Server Compatibility](#client-server-compatibility) + * [Compatibility - Up to RavenDB 4.1](#compatibility---up-to-ravendb-41) + * [Compatibility - RavenDB 4.2 and Higher](#compatibility---ravendb-42-and-higher) + * [Upgrading](#upgrading) + * [Upgrading - Up to RavenDB 4.1](#upgrading---up-to-ravendb-41) + * [Upgrading - RavenDB 4.2 and Higher](#upgrading---ravendb-42-and-higher) + * [Upgrading Order](#upgrading-order) @@ -75,7 +75,7 @@ Upgrading RavenDB from a version earlier than 4.2 to a higher major version, req ### Upgrading - RavenDB 4.2 and Higher When RavenDB is upgraded from version 4.2 and higher, e.g. from 4.2 to 5.3, it is recommended - but not mandatory - to upgrade the clients, since they are -[compatible with servers of versions higher than theirs](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-42-and-higher). +[compatible with servers of versions higher than theirs](#compatibility---ravendb-42-and-higher). ### Upgrading Order To properly upgrade your applications and server, we advise you to upgrade the server first, then the clients. diff --git a/versioned_docs/version-7.1/client-api/faq/transaction-support.mdx b/versioned_docs/version-7.1/client-api/faq/transaction-support.mdx index 2ca7b85c92..53c2b2bfd9 100644 --- a/versioned_docs/version-7.1/client-api/faq/transaction-support.mdx +++ b/versioned_docs/version-7.1/client-api/faq/transaction-support.mdx @@ -15,14 +15,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [ACID storage](../../client-api/faq/transaction-support.mdx#acid-storage) - * [What is and what isn't a transaction](../../client-api/faq/transaction-support.mdx#what-is-and-what-isn) - * [Working with transactions in RavenDB ](../../client-api/faq/transaction-support.mdx#working-with-transactions-in-ravendb) - * [Single-node model](../../client-api/faq/transaction-support.mdx#single-node-model) - * [Multi-master model](../../client-api/faq/transaction-support.mdx#multi-master-model) - * [Cluster-wide transactions](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions) - * [ACID for document operations](../../client-api/faq/transaction-support.mdx#acid-for-document-operations) - * [BASE for query operations](../../client-api/faq/transaction-support.mdx#base-for-query-operations) + * [ACID storage](#acid-storage) + * [What is and what isn't a transaction](#what-is-and-what-isn) + * [Working with transactions in RavenDB ](#working-with-transactions-in-ravendb) + * [Single-node model](#single-node-model) + * [Multi-master model](#multi-master-model) + * [Cluster-wide transactions](#cluster-wide-transactions) + * [ACID for document operations](#acid-for-document-operations) + * [BASE for query operations](#base-for-query-operations) ## ACID storage @@ -47,7 +47,7 @@ which guarantees all ACID properties, whether executed on document, index or loc It employs _Serializable_ isolation for write operations and _Snapshot_ isolation for read operations. * RavenDB doesn't support a transaction spanning __multiple__ HTTP requests. Interactive transactions are not implemented by RavenDB - (see [below](../../client-api/faq/transaction-support.mdx#no-support-for-interactive-transactions) for the reasoning behind this decision). + (see [below](#no-support-for-interactive-transactions) for the reasoning behind this decision). RavenDB offers [optimistic concurrency](../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx) feature to achieve similar behavior. * The [Client API Session](../../client-api/session/what-is-a-session-and-how-does-it-work.mdx) is a pure Client API object and does not represent a transaction, @@ -140,7 +140,7 @@ so you can utilize RavenDB for each of your scenarios: When running in a multi-node setup, RavenDB still uses transactions. However, they are single-node transactions. That means that the set of changes that you write in a transaction is committed only to the node you are writing to. It will then asynchronously replicate to the other nodes. -To achieve consistency across the entire cluster please refer to the [Cluster-wide transactions](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions) section below. +To achieve consistency across the entire cluster please refer to the [Cluster-wide transactions](#cluster-wide-transactions) section below. #### Replication conflicts @@ -158,14 +158,14 @@ This behavior was influenced by the [Dynamo paper](https://dl.acm.org/doi/10.114 The assumption is that if you are writing data to the database, you expect it to be persisted. RavenDB will do its utmost to provide that to you, allowing you to write to the database even in the case of partitions or partial failure states. -However, handling replication conflicts is a consideration you have to take into account when using single-node transactions in RavenDB (see below for running a [cluster-wide transaction](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions)). +However, handling replication conflicts is a consideration you have to take into account when using single-node transactions in RavenDB (see below for running a [cluster-wide transaction](#cluster-wide-transactions)). If no conflict resolution script is defined for a collection, then by default RavenDB resolves the conflict using the latest version based on the `@last-modified` property of conflicted versions of the document. That might result in the lost update anomaly. -If you care about avoiding lost updates, you need to ensure you have the conflict resolution script defined accordingly or use a [cluster-wide transaction](../../client-api/faq/transaction-support.mdx#cluster-wide-transactions). +If you care about avoiding lost updates, you need to ensure you have the conflict resolution script defined accordingly or use a [cluster-wide transaction](#cluster-wide-transactions). diff --git a/versioned_docs/version-7.1/client-api/faq/what-is-a-collection.mdx b/versioned_docs/version-7.1/client-api/faq/what-is-a-collection.mdx index ad8f4c3bba..9bb3249e74 100644 --- a/versioned_docs/version-7.1/client-api/faq/what-is-a-collection.mdx +++ b/versioned_docs/version-7.1/client-api/faq/what-is-a-collection.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Collections are used throughout many RavenDB features, such as defining indexes, setting revisions, and much more. * In this page: - * [Collection Name Generation](../../client-api/faq/what-is-a-collection.mdx#collection-name-generation) - * [Collection Usages](../../client-api/faq/what-is-a-collection.mdx#collection-usages) + * [Collection Name Generation](#collection-name-generation) + * [Collection Usages](#collection-usages) * For more information see [Documents and Collections](../../studio/database/documents/documents-and-collections.mdx) diff --git a/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-csharp.mdx b/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-csharp.mdx index b5dc0c4738..5561174c36 100644 --- a/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-csharp.mdx @@ -18,14 +18,14 @@ When applied correctly, they can drastically improve performance, reduce network * In this page: - * [Denormalization](../../../client-api/how-to/handle-document-relationships.mdx#denormalization) - * [Includes](../../../client-api/how-to/handle-document-relationships.mdx#includes) - * [One to many includes](../../../client-api/how-to/handle-document-relationships.mdx#one-to-many-includes) - * [Secondary level includes](../../../client-api/how-to/handle-document-relationships.mdx#secondary-level-includes) - * [Dictionary includes](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes) - * [Dictionary includes: complex types](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes-complex-types) - * [Combining approaches](../../../client-api/how-to/handle-document-relationships.mdx#combining-approaches) - * [Summary](../../../client-api/how-to/handle-document-relationships.mdx#summary) + * [Denormalization](#denormalization) + * [Includes](#includes) + * [One to many includes](#one-to-many-includes) + * [Secondary level includes](#secondary-level-includes) + * [Dictionary includes](#dictionary-includes) + * [Dictionary includes: complex types](#dictionary-includes-complex-types) + * [Combining approaches](#combining-approaches) + * [Summary](#summary) ## Denormalization diff --git a/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-nodejs.mdx b/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-nodejs.mdx index e88929612c..c662afa703 100644 --- a/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/content/_handle-document-relationships-nodejs.mdx @@ -18,14 +18,14 @@ When applied correctly, they can drastically improve performance, reduce network * In this page: - * [Denormalization](../../../client-api/how-to/handle-document-relationships.mdx#denormalization) - * [Includes](../../../client-api/how-to/handle-document-relationships.mdx#includes) - * [One to many includes](../../../client-api/how-to/handle-document-relationships.mdx#one-to-many-includes) - * [Secondary level includes](../../../client-api/how-to/handle-document-relationships.mdx#secondary-level-includes) - * [Dictionary includes](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes) - * [Dictionary includes: complex types](../../../client-api/how-to/handle-document-relationships.mdx#dictionary-includes-complex-types) - * [Combining approaches](../../../client-api/how-to/handle-document-relationships.mdx#combining-approaches) - * [Summary](../../../client-api/how-to/handle-document-relationships.mdx#summary) + * [Denormalization](#denormalization) + * [Includes](#includes) + * [One to many includes](#one-to-many-includes) + * [Secondary level includes](#secondary-level-includes) + * [Dictionary includes](#dictionary-includes) + * [Dictionary includes: complex types](#dictionary-includes-complex-types) + * [Combining approaches](#combining-approaches) + * [Summary](#summary) ## Denormalization diff --git a/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx b/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx index 2e3d414e16..e5d629c773 100644 --- a/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-csharp.mdx @@ -22,24 +22,24 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Use convention defaults](../../../client-api/how-to/setup-aggressive-caching.mdx#use-convention-defaults) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Use convention defaults](#use-convention-defaults) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -102,7 +102,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-java.mdx b/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-java.mdx index fa861e4eff..c61de29c45 100644 --- a/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-java.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/content/_setup-aggressive-caching-java.mdx @@ -22,24 +22,24 @@ import ContentFrame from '@site/src/components/ContentFrame'; --- * In this article: - * [Caching in RavenDB](../../../client-api/how-to/setup-aggressive-caching.mdx#caching-in-ravendb) - * [Standard HTTP caching](../../../client-api/how-to/setup-aggressive-caching.mdx#standard-http-caching) - * [Aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#aggressive-caching) - * [How invalidation works](../../../client-api/how-to/setup-aggressive-caching.mdx#how-invalidation-works) - * [Enable aggressive caching](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-aggressive-caching) - * [Enable for a scope](../../../client-api/how-to/setup-aggressive-caching.mdx#enable-for-a-scope) - * [Use convention defaults](../../../client-api/how-to/setup-aggressive-caching.mdx#use-convention-defaults) - * [Apply to the entire application](../../../client-api/how-to/setup-aggressive-caching.mdx#apply-to-the-entire-application) - * [Cache modes](../../../client-api/how-to/setup-aggressive-caching.mdx#cache-modes) - * [TrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#trackchanges) - * [DoNotTrackChanges](../../../client-api/how-to/setup-aggressive-caching.mdx#donottrackchanges) - * [More operations](../../../client-api/how-to/setup-aggressive-caching.mdx#more-operations) - * [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) - * [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached) - * [Common mistakes](../../../client-api/how-to/setup-aggressive-caching.mdx#common-mistakes) - * [Syntax](../../../client-api/how-to/setup-aggressive-caching.mdx#syntax) - * [Methods](../../../client-api/how-to/setup-aggressive-caching.mdx#methods) - * [Classes](../../../client-api/how-to/setup-aggressive-caching.mdx#classes) + * [Caching in RavenDB](#caching-in-ravendb) + * [Standard HTTP caching](#standard-http-caching) + * [Aggressive caching](#aggressive-caching) + * [How invalidation works](#how-invalidation-works) + * [Enable aggressive caching](#enable-aggressive-caching) + * [Enable for a scope](#enable-for-a-scope) + * [Use convention defaults](#use-convention-defaults) + * [Apply to the entire application](#apply-to-the-entire-application) + * [Cache modes](#cache-modes) + * [TrackChanges](#trackchanges) + * [DoNotTrackChanges](#donottrackchanges) + * [More operations](#more-operations) + * [Opt out for a single call](#opt-out-for-a-single-call) + * [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached) + * [Common mistakes](#common-mistakes) + * [Syntax](#syntax) + * [Methods](#methods) + * [Classes](#classes) @@ -102,7 +102,7 @@ The next read of any aggressively cached entry is sent to the server for revalid There is a short delay between the moment a document is modified on the server and the moment the change notification reaches the client. A read that hits the aggressive cache during that window will return the previous value of the document. Use aggressive caching only when this small staleness window is acceptable for the calling code. -For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](../../../client-api/how-to/setup-aggressive-caching.mdx#opt-out-for-a-single-call) and [Requests that are never aggressively cached](../../../client-api/how-to/setup-aggressive-caching.mdx#requests-that-are-never-aggressively-cached). +For requests that must always see the most recent committed state, use the bypass options under [Opt out for a single call](#opt-out-for-a-single-call) and [Requests that are never aggressively cached](#requests-that-are-never-aggressively-cached). diff --git a/versioned_docs/version-7.1/client-api/how-to/integrate-with-excel.mdx b/versioned_docs/version-7.1/client-api/how-to/integrate-with-excel.mdx index b1ad71734d..b9eb8e68cd 100644 --- a/versioned_docs/version-7.1/client-api/how-to/integrate-with-excel.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/integrate-with-excel.mdx @@ -39,7 +39,7 @@ In order to include only specific properties in the CSV output you can use the ` -In some cases it might be cumbersome to use the URL to send the query or the query might be too long. Please see our [dedicated section](../../client-api/how-to/integrate-with-excel.mdx#dealing-with-long-query-urls-in-excel) that deals with that problem. +In some cases it might be cumbersome to use the URL to send the query or the query might be too long. Please see our [dedicated section](#dealing-with-long-query-urls-in-excel) that deals with that problem. diff --git a/versioned_docs/version-7.1/client-api/how-to/subscribe-to-store-events.mdx b/versioned_docs/version-7.1/client-api/how-to/subscribe-to-store-events.mdx index 5dc7776f4a..68d118e3c8 100644 --- a/versioned_docs/version-7.1/client-api/how-to/subscribe-to-store-events.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/subscribe-to-store-events.mdx @@ -28,18 +28,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about session events [here](../../client-api/session/how-to/subscribe-to-events.mdx). * In this article: - * [Store events](../../client-api/how-to/subscribe-to-store-events.mdx#store-events) - * [OnBeforeRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onbeforerequest) - * [OnSucceedRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onsucceedrequest) - * [AfterDispose](../../client-api/how-to/subscribe-to-store-events.mdx#afterdispose) - * [BeforeDispose](../../client-api/how-to/subscribe-to-store-events.mdx#beforedispose) - * [RequestExecutorCreated](../../client-api/how-to/subscribe-to-store-events.mdx#requestexecutorcreated) - * [OnSessionCreated](../../client-api/how-to/subscribe-to-store-events.mdx#onsessioncreated) - * [OnFailedRequest](../../client-api/how-to/subscribe-to-store-events.mdx#onfailedrequest) - * [OnTopologyUpdated](../../client-api/how-to/subscribe-to-store-events.mdx#ontopologyupdated) - * [Store/Session events](../../client-api/how-to/subscribe-to-store-events.mdx#storesession-events) - * [Unsubscribing from an event](../../client-api/how-to/subscribe-to-store-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../client-api/how-to/subscribe-to-store-events.mdx#syntax) + * [Store events](#store-events) + * [OnBeforeRequest](#onbeforerequest) + * [OnSucceedRequest](#onsucceedrequest) + * [AfterDispose](#afterdispose) + * [BeforeDispose](#beforedispose) + * [RequestExecutorCreated](#requestexecutorcreated) + * [OnSessionCreated](#onsessioncreated) + * [OnFailedRequest](#onfailedrequest) + * [OnTopologyUpdated](#ontopologyupdated) + * [Store/Session events](#storesession-events) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/how-to/using-timeonly-and-dateonly.mdx b/versioned_docs/version-7.1/client-api/how-to/using-timeonly-and-dateonly.mdx index 67c27f3495..601c01d458 100644 --- a/versioned_docs/version-7.1/client-api/how-to/using-timeonly-and-dateonly.mdx +++ b/versioned_docs/version-7.1/client-api/how-to/using-timeonly-and-dateonly.mdx @@ -21,16 +21,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can now convert `DateTime` or strings written in date/time formats to .NET's `DateOnly` or `TimeOnly` types without slowing down queries and while leaving your existing data as is. - * Use `AsDateOnly` or `AsTimeOnly` in a static index ([see examples below](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime)) + * Use `AsDateOnly` or `AsTimeOnly` in a static index ([see examples below](#use--or--in-a-static-index-to-convert-strings-or-datetime)) * `AsDateOnly` and `AsTimeOnly` automatically convert strings to ticks for faster querying. * We convert the types in [static indexes](../../indexes/map-indexes.mdx) so that the conversions and calculations are done behind the scenes and the data is ready for fast queries. ([See sample index below.](../../client-api/how-to/using-timeonly-and-dateonly.mdx#convert-and-use-date/timeonly-without-affecting-your-existing-data)) * In this page: - * [About DateOnly and TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#about-dateonly-and-timeonly) + * [About DateOnly and TimeOnly](#about-dateonly-and-timeonly) * [Convert and Use Date/TimeOnly Without Affecting Your Existing Data](../../client-api/how-to/using-timeonly-and-dateonly.mdx#convert-and-use-date/timeonly-without-affecting-your-existing-data) - * [Using already existing DateOnly or TimeOnly fields](../../client-api/how-to/using-timeonly-and-dateonly.mdx#using-already-existing-dateonly-or-timeonly-fields) + * [Using already existing DateOnly or TimeOnly fields](#using-already-existing-dateonly-or-timeonly-fields) @@ -54,7 +54,7 @@ These two new C# types are available from .NET 6.0+ (RavenDB 5.3+). ## Convert and Use Date/TimeOnly Without Affecting Your Existing Data -RavenDB offers conversion of types in static indexes with the methods [AsDateOnly or AsTimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime). +RavenDB offers conversion of types in static indexes with the methods [AsDateOnly or AsTimeOnly](#use--or--in-a-static-index-to-convert-strings-or-datetime). * [Static indexes](../../indexes/indexing-basics.mdx) process new data in the background, including calculations and conversions to DateOnly/TimeOnly values, which can be used as ticks, @@ -78,8 +78,8 @@ though comparing ticks is faster. ### Use `AsDateOnly` or `AsTimeOnly` in a static index to convert strings or DateTime -* [Converting Strings to DateOnly or TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#converting-strings-with-minimal-cost) -* [Converting DateTime to DateOnly or TimeOnly](../../client-api/how-to/using-timeonly-and-dateonly.mdx#converting--with-minimal-cost) +* [Converting Strings to DateOnly or TimeOnly](#converting-strings-with-minimal-cost) +* [Converting DateTime to DateOnly or TimeOnly](#converting--with-minimal-cost) #### Converting Strings with minimal cost @@ -272,7 +272,7 @@ var result = session **Querying on Ticks** -Strings are automatically converted to ticks with [`AsDateOnly` and `AsTimeOnly`](../../client-api/how-to/using-timeonly-and-dateonly.mdx#use--or--in-a-static-index-to-convert-strings-or-datetime). +Strings are automatically converted to ticks with [`AsDateOnly` and `AsTimeOnly`](#use--or--in-a-static-index-to-convert-strings-or-datetime). diff --git a/versioned_docs/version-7.1/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx index 6602b5c804..ab355e8c7a 100644 --- a/versioned_docs/version-7.1/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/attachments/content/_delete-attachment-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Delete attachment example](../../../../client-api/operations/attachments/delete-attachment.mdx#delete-attachment-example) - * [Syntax](../../../../client-api/operations/attachments/delete-attachment.mdx#syntax) + * [Delete attachment example](#delete-attachment-example) + * [Syntax](#syntax) ## Delete attachment example diff --git a/versioned_docs/version-7.1/client-api/operations/attachments/content/_get-attachment-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/attachments/content/_get-attachment-nodejs.mdx index a839aad662..d8debbd91d 100644 --- a/versioned_docs/version-7.1/client-api/operations/attachments/content/_get-attachment-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/attachments/content/_get-attachment-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get attachment example](../../../../client-api/operations/attachments/get-attachment.mdx#get-attachment-example) - * [Syntax](../../../../client-api/operations/attachments/get-attachment.mdx#syntax) + * [Get attachment example](#get-attachment-example) + * [Syntax](#syntax) ## Get attachment example diff --git a/versioned_docs/version-7.1/client-api/operations/attachments/content/_put-attachment-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/attachments/content/_put-attachment-nodejs.mdx index 68bafb96c0..6b136549d6 100644 --- a/versioned_docs/version-7.1/client-api/operations/attachments/content/_put-attachment-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/attachments/content/_put-attachment-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put attachment example](../../../../client-api/operations/attachments/put-attachment.mdx#put-attachment-example) - * [Syntax](../../../../client-api/operations/attachments/put-attachment.mdx#syntax) + * [Put attachment example](#put-attachment-example) + * [Syntax](#syntax) ## Put attachment example diff --git a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-csharp.mdx index 29e9cc904a..0a0bf057a6 100644 --- a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-csharp.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-nodejs.mdx index c0d7f2417e..f1e32a29b6 100644 --- a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-nodejs.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-php.mdx b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-php.mdx index e2c9e2c214..da9793bb61 100644 --- a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-php.mdx @@ -26,9 +26,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) - * [Syntax](../../../../client-api/operations/common/delete-by-query.mdx#syntax) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-python.mdx b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-python.mdx index c0600d9ff0..40e7891465 100644 --- a/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/common/content/_delete-by-query-python.mdx @@ -25,8 +25,8 @@ import CodeBlock from '@theme/CodeBlock'; * To learn more about the differences between transaction types, see [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction). * In this article: - * [Delete by dynamic query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-dynamic-query) - * [Delete by index query](../../../../client-api/operations/common/delete-by-query.mdx#delete-by-index-query) + * [Delete by dynamic query](#delete-by-dynamic-query) + * [Delete by index query](#delete-by-index-query) diff --git a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-csharp.mdx index dc591be3c6..326b23822b 100644 --- a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-csharp.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#kill-operation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#kill-operation) ## Why use operations @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `Send` method on the `Operations` property of the DocumentStore. @@ -186,7 +186,7 @@ Task> SendAsync(PatchOperation * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `Send` method on the `Maintenance` property in the DocumentStore. @@ -384,7 +384,7 @@ Task SendAsync(IMaintenanceOperation operation, Use [ForNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `Send` method on the `Maintenance.Server` property in the DocumentStore. diff --git a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-nodejs.mdx index f0b6eaad57..f651877c46 100644 --- a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-nodejs.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * __Operation types__: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#killoperation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#killoperation) ## Why use operations @@ -56,7 +56,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * __Background operations__: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property of the DocumentStore. @@ -161,7 +161,7 @@ await send(patchOperation, sessionInfo, resultType); * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -327,7 +327,7 @@ __Send syntax__: Use [forNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property of the DocumentStore. diff --git a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-php.mdx b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-php.mdx index 93e97791a0..97b34c788d 100644 --- a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-php.mdx @@ -14,14 +14,14 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) ## Why use operations @@ -57,7 +57,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property in the DocumentStore. @@ -155,7 +155,7 @@ public function send(...$parameters); * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -316,7 +316,7 @@ $status = $indexStats->getStatus(); // will be "Paused" Use [forNode](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-python.mdx b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-python.mdx index 03616e8c93..bb704e2808 100644 --- a/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/content/_what-are-operations-python.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; directly to the server via DocumentStore Operations instead of using the higher-level Session API. * In this page: - * [Why use operations](../../../client-api/operations/what-are-operations.mdx#why-use-operations) - * [How operations work](../../../client-api/operations/what-are-operations.mdx#how-operations-work) + * [Why use operations](#why-use-operations) + * [How operations work](#how-operations-work) * **Operation types**: - * [Common operations](../../../client-api/operations/what-are-operations.mdx#common-operations) - * [Maintenance operations](../../../client-api/operations/what-are-operations.mdx#maintenance-operations) - * [Server-maintenance operations](../../../client-api/operations/what-are-operations.mdx#server-maintenance-operations) - * [Manage lengthy operations](../../../client-api/operations/what-are-operations.mdx#manage-lengthy-operations) - * [Wait for completion](../../../client-api/operations/what-are-operations.mdx#wait-for-completion) - * [Kill operation](../../../client-api/operations/what-are-operations.mdx#kill-operation) + * [Common operations](#common-operations) + * [Maintenance operations](#maintenance-operations) + * [Server-maintenance operations](#server-maintenance-operations) + * [Manage lengthy operations](#manage-lengthy-operations) + * [Wait for completion](#wait-for-completion) + * [Kill operation](#kill-operation) ## Why use operations @@ -58,7 +58,7 @@ import CodeBlock from '@theme/CodeBlock'; If needed, data will then replicate to the other nodes in the database-group. * **Background operations**: Some operations may take a long time to complete and can be awaited for completion. - Learn more [below](../../../client-api/operations/what-are-operations.mdx#wait-for-completion). + Learn more [below](#wait-for-completion). @@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock'; * These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_, document-extensions related operations such as getting/putting an attachment, and more. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-common-operations-are-available). + See all available operations [below](#the-following-common-operations-are-available). * To execute a common operation request, use the `send` method on the `operations` property of the DocumentStore. @@ -155,7 +155,7 @@ def send_patch_operation_with_entity_class( * These operations include database management operations such as setting client configuration, managing indexes & ongoing-tasks operations, getting stats, and more. - See all available maintenance operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-maintenance-operations-are-available). + See all available maintenance operations [below](#the-following-maintenance-operations-are-available). * To execute a maintenance operation request, use the `send` method on the `maintenance` property in the DocumentStore. @@ -317,7 +317,7 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper Use [for_node](../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration. * These operations include server management and configuration operations. - See all available operations [below](../../../client-api/operations/what-are-operations.mdx#the-following-server-maintenance-operations-are-available). + See all available operations [below](#the-following-server-maintenance-operations-are-available). * To execute a server-maintenance operation request, use the `send` method on the `maintenance.server` property in the DocumentStore. diff --git a/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx index e0d0512557..a612588a1d 100644 --- a/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-csharp.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server-maintenance operations - ForNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server-maintenance operations - ForNode](#server-maintenance-operations---fornode) ## Server maintenance operations - ForNode diff --git a/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx index 550e850c3e..98a9a1aa1b 100644 --- a/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-nodejs.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server maintenance operations - forNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server maintenance operations - forNode](#server-maintenance-operations---fornode) ## Server maintenance operations - forNode diff --git a/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx b/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx index 5744f29c27..bc63cb591a 100644 --- a/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/how-to/content/_switch-operations-to-a-different-node-php.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; (An exception is thrown if that node is not available). * In this page: - * [Server-maintenance operations - ForNode](../../../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx#server-maintenance-operations---fornode) + * [Server-maintenance operations - ForNode](#server-maintenance-operations---fornode) ## Server maintenance operations - ForNode diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/backup-overview.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/backup-overview.mdx index 83050a936e..6fd9df2996 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/backup-overview.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/backup-overview.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * RavenDB's Backup task is an [Ongoing-Task](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx) designed to run periodically on a pre-defined schedule. You can run it as a one-time operation as well, by using [Export](../../../../client-api/smuggler/what-is-smuggler.mdx#export) - or executing a backup task [immediately](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution). + or executing a backup task [immediately](#initiate-immediate-backup-execution). * On a [sharded](../../../../sharding/overview.mdx) database, a single backup task is defined by the user for all shards, and RavenDB automatically defines @@ -27,18 +27,18 @@ import LanguageContent from "@site/src/components/LanguageContent"; Read about backups on a sharded database [in the section dedicated to it](../../../../sharding/backup-and-restore/backup.mdx). * In this page: - * [Backup Types](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-types) - * [Logical-Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup) - * [Snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) - * [Backup Scope](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-scope) - * [Full Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#full-backup) - * [Incremental Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup) - * [Backup to Local and Remote Destinations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations) - * [Backup Retention Policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy) - * [Server-Wide Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#server-wide-backup) - * [Initiate Immediate Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution) - * [Delay Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#delay-backup-execution) - * [Recommended Precautions](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#recommended-precautions) + * [Backup Types](#backup-types) + * [Logical-Backup](#logical-backup) + * [Snapshot](#snapshot) + * [Backup Scope](#backup-scope) + * [Full Backup](#full-backup) + * [Incremental Backup](#incremental-backup) + * [Backup to Local and Remote Destinations](#backup-to-local-and-remote-destinations) + * [Backup Retention Policy](#backup-retention-policy) + * [Server-Wide Backup](#server-wide-backup) + * [Initiate Immediate Backup Execution](#initiate-immediate-backup-execution) + * [Delay Backup Execution](#delay-backup-execution) + * [Recommended Precautions](#recommended-precautions) ## Backup Types @@ -110,7 +110,7 @@ var result = await docStore.Maintenance.SendAsync(operation); * If Incremental backups are created for a Snapshot-type backup: * The first backup will be a full Snapshot. * The following backups will be Incremental. - * [Incremental backups](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup) + * [Incremental backups](#incremental-backup) have different storage contents than Snapshots. * Code Sample: @@ -360,7 +360,7 @@ The retention policy is a property of `PeriodicBackupConfiguration`: You can create a Server-Wide Backup task to back-up **all the databases in your cluster** at a scheduled time. Individual databases can be excluded from the backup. Learn more in [Studio: Server-Wide Backup](../../../../studio/server/server-wide-backup.mdx). -Backups can be made locally, as well as to a [set of remote locations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations). +Backups can be made locally, as well as to a [set of remote locations](#backup-to-local-and-remote-destinations). #### Examples @@ -584,7 +584,7 @@ await docStore.Maintenance.SendAsync( * An ACIDity of backed-up data, to keep its independence during restoration. * **Remove old backup files regularly**. - Set the [backup retention policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy) + Set the [backup retention policy](#backup-retention-policy) to remove unneeded backup files so that they don't build up. While setting how many days to keep your backups, consider how much of a recent database history you would like to have access to. diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/encrypted-backup.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/encrypted-backup.mdx index ce2a6660b9..7ea05a085e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/encrypted-backup.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/encrypted-backup.mdx @@ -28,19 +28,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; using the same encryption key provided for the full backup. * In this page: - * [RavenDB's Security Approach](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#ravendb) - * [Secure Client-Server Communication](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#secure-client-server-communication) - * [Database Encryption](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#database-encryption) - * [Backup-Encryption Overview](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#backup-encryption-overview) - * [Prerequisites to Encrypting Backups](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#prerequisites-to-encrypting-backups) - * [Choosing Encryption Mode & Key](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#choosing-encryption-mode--key) - * [Creating an Encrypted Logical-Backup](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#creating-an-encrypted-logical-backup) - * [For a Non-Encrypted Database](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#for-a-non-encrypted-database) - * [For an Encrypted Database](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#for-an-encrypted-database) - * [Creating an Encrypted Snapshot](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#creating-an-encrypted-snapshot) - * [Restoring an Encrypted Backup](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-backup) - * [Restoring an encrypted Logical-Backup](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-logical-backup) - * [Restoring a Snapshot](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-a-snapshot) + * [RavenDB's Security Approach](#ravendb) + * [Secure Client-Server Communication](#secure-client-server-communication) + * [Database Encryption](#database-encryption) + * [Backup-Encryption Overview](#backup-encryption-overview) + * [Prerequisites to Encrypting Backups](#prerequisites-to-encrypting-backups) + * [Choosing Encryption Mode & Key](#choosing-encryption-mode--key) + * [Creating an Encrypted Logical-Backup](#creating-an-encrypted-logical-backup) + * [For a Non-Encrypted Database](#for-a-non-encrypted-database) + * [For an Encrypted Database](#for-an-encrypted-database) + * [Creating an Encrypted Snapshot](#creating-an-encrypted-snapshot) + * [Restoring an Encrypted Backup](#restoring-an-encrypted-backup) + * [Restoring an encrypted Logical-Backup](#restoring-an-encrypted-logical-backup) + * [Restoring a Snapshot](#restoring-a-snapshot) ## RavenDB's Security Approach @@ -87,7 +87,7 @@ Secure the data stored on the server by * **Secure communication to enable database encryption.** An encrypted database can only be created when the - [client-server communication is secure](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#secure-client-server-communication). + [client-server communication is secure](#secure-client-server-communication). @@ -286,7 +286,7 @@ docStore.Maintenance.Server.Send(restoreBackupTask); #### Restoring an encrypted Logical-Backup -A database is [restored](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-backup) from a logical-backup +A database is [restored](#restoring-an-encrypted-backup) from a logical-backup to its **unencrypted** form. To restore a database and encrypt its contents, you have to address it explicitly. @@ -325,7 +325,7 @@ docStore.Maintenance.Server.Send(restoreBackupTask); #### Restoring a Snapshot -Restore a snapshot as specified in [Restoring an Encrypted Database](../../../../client-api/operations/maintenance/backup/encrypted-backup.mdx#restoring-an-encrypted-backup). +Restore a snapshot as specified in [Restoring an Encrypted Database](#restoring-an-encrypted-backup). * The database of an un-encrypted snapshot is restored to its un-encrypted form. * The database of an encrypted snapshot is restored to its encrypted form. diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/faq.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/faq.mdx index ea90398cb0..fe7a7b9582 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/faq.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/faq.mdx @@ -15,15 +15,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Is there a one-time backup?](../../../../client-api/operations/maintenance/backup/faq.mdx#is-there-a-one-time-backup) - * [How do I create a backup of my cluster, not just one database?](../../../../client-api/operations/maintenance/backup/faq.mdx#how-do-i-create-a-backup-of-my-cluster-not-just-one-database) - * [How should the servers' time be set in a multi-node cluster?](../../../../client-api/operations/maintenance/backup/faq.mdx#how-should-the-servers-time-be-set-in-a-multi-node-cluster) - * [Is an External Replication a good substitute for a backup task?](../../../../client-api/operations/maintenance/backup/faq.mdx#is-an-external-replication-task-a-good-substitute-for-a-backup-task) - * [Can I simply copy the database folder contents whenever I need to create a backup?](../../../../client-api/operations/maintenance/backup/faq.mdx#can-i-simply-copy-the-database-folder-contents-whenever-i-need-to-create-a-backup) - * [Does RavenDB automatically delete old backups?](../../../../client-api/operations/maintenance/backup/faq.mdx#does-ravendb-automatically-delete-old-backups) - * [Are there any locations that backup files should NOT be stored at?](../../../../client-api/operations/maintenance/backup/faq.mdx#are-there-any-locations-that-backup-files-should-not-be-stored-at) - * [What happens when a backup process fails before it is completed?](../../../../client-api/operations/maintenance/backup/faq.mdx#what-happens-when-a-backup-process-fails-before-completion) - * [What happens if the node responsible for a backup task is down?](../../../../client-api/operations/maintenance/backup/faq.mdx#what-happens-if-the-node-responsible-for-a-backup-task-is-down) + * [Is there a one-time backup?](#is-there-a-one-time-backup) + * [How do I create a backup of my cluster, not just one database?](#how-do-i-create-a-backup-of-my-cluster-not-just-one-database) + * [How should the servers' time be set in a multi-node cluster?](#how-should-the-servers-time-be-set-in-a-multi-node-cluster) + * [Is an External Replication a good substitute for a backup task?](#is-an-external-replication-task-a-good-substitute-for-a-backup-task) + * [Can I simply copy the database folder contents whenever I need to create a backup?](#can-i-simply-copy-the-database-folder-contents-whenever-i-need-to-create-a-backup) + * [Does RavenDB automatically delete old backups?](#does-ravendb-automatically-delete-old-backups) + * [Are there any locations that backup files should NOT be stored at?](#are-there-any-locations-that-backup-files-should-not-be-stored-at) + * [What happens when a backup process fails before it is completed?](#what-happens-when-a-backup-process-fails-before-completion) + * [What happens if the node responsible for a backup task is down?](#what-happens-if-the-node-responsible-for-a-backup-task-is-down) ## FAQ @@ -56,7 +56,7 @@ and databases can be [restored from backup](../../../../studio/database/create-n **To prevent downtime while rebuilding**, you can [replicate your database](../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx) so that there is a live version available to distribute the workload and act as a failover. -[Is an External Replication a good substitute for a backup task?](../../../../client-api/operations/maintenance/backup/faq.mdx#is-an-external-replication-task-a-good-substitute-for-a-backup-task) +[Is an External Replication a good substitute for a backup task?](#is-an-external-replication-task-a-good-substitute-for-a-backup-task) ### How should the servers' time be set in a multi-node cluster? The backup task runs on schedule according to the executing server's local time. @@ -94,7 +94,7 @@ Learn how to change the [Retention Policy via API](../../../../client-api/operat It is recommended **not to store backups on the same drive as your database** data files, since both the database and the backups would be exposed to the same risks. -* Disk space can run low as backups start piling up unless you [set your retention policy for backups](../../../../client-api/operations/maintenance/backup/faq.mdx#does-ravendb-automatically-delete-old-backups). +* Disk space can run low as backups start piling up unless you [set your retention policy for backups](#does-ravendb-automatically-delete-old-backups). * There are many [options for backup locations](../../../../studio/database/tasks/backup-task.mdx#destination). * We recommend creating ongoing backups in two different types of locations (cloud and local machine). You can store your backups in multiple locations by setting up one [on-going backup task](../../../../studio/database/tasks/backup-task.mdx) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/restore.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/restore.mdx index ff3cd0662d..fe592dc8e7 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/backup/restore.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/backup/restore.mdx @@ -23,12 +23,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * [Restoring a Database: Configuration and Execution](../../../../client-api/operations/maintenance/backup/restore.mdx#restoring-a-database:-configuration-and-execution) - * [Optional Settings](../../../../client-api/operations/maintenance/backup/restore.mdx#optional-settings) - * [Restore Database to a Single Node](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-a-single-node) - * [Restore Database to Multiple Nodes](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-multiple-nodes) - * [Restore to a Single Node & Replicate to Other Nodes](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-a-single-node--replicate-it-to-other-nodes) - * [Restore to Multiple Nodes Simultaneously](../../../../client-api/operations/maintenance/backup/restore.mdx#restore-database-to-multiple-nodes-simultaneously) - * [Recommended Precautions](../../../../client-api/operations/maintenance/backup/restore.mdx#recommended-precautions) + * [Optional Settings](#optional-settings) + * [Restore Database to a Single Node](#restore-database-to-a-single-node) + * [Restore Database to Multiple Nodes](#restore-database-to-multiple-nodes) + * [Restore to a Single Node & Replicate to Other Nodes](#restore-database-to-a-single-node--replicate-it-to-other-nodes) + * [Restore to Multiple Nodes Simultaneously](#restore-database-to-multiple-nodes-simultaneously) + * [Recommended Precautions](#recommended-precautions) ## Restoring a Database: Configuration and Execution @@ -122,7 +122,7 @@ This is where you need to provide your encryption key if your backup is encrypte ### `DisableOngoingTasks` set **DisableOngoingTasks** to **true** to disable the execution of ongoing tasks after restoration. -See [Recommended Precautions](../../../../client-api/operations/maintenance/backup/restore.mdx#recommended-precautions). +See [Recommended Precautions](#recommended-precautions). {`// Do or do not run ongoing tasks after restoration. @@ -212,7 +212,7 @@ and not in any ongoing tasks that may have existed during backup. * E.g., an ETL ongoing task from a production cluster may have unwanted results in a testing environment. -In such cases, **disable** ongoing tasks using the [DisableOngoingTasks](../../../../client-api/operations/maintenance/backup/restore.mdx#section-1) flag. +In such cases, **disable** ongoing tasks using the [DisableOngoingTasks](#section-1) flag. * Code Sample: diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx index fa4c3296b3..4c4fb8a58c 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx index c8228847e7..2dceaceb77 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx index 5bbf13f04f..922167b8ed 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_database-settings-operation-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Put database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#put-database-settings-operation) + * [Put database settings operation](#put-database-settings-operation) - * [Get database settings operation](../../../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx#get-database-settings-operation) + * [Get database settings operation](#get-database-settings-operation) Do not modify the database settings unless you are an expert and know what you're doing. diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx index 2b86f1ff2f..bca13a0045 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx index a1882b8c92..42a111998d 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx index 606fa07cd5..484c3db08e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx index 60d1f73c4e..5d4e01225e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_get-client-configuration-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetClientConfigurationOperation` to get the current client-configuration set on the server for the database. * In this page: - * [Get client-configuration](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#get-client-configuration) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/get-client-configuration.mdx#syntax) + * [Get client-configuration](#get-client-configuration) + * [Syntax](#syntax) ## Get client-configuration diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx index ad46e4c334..534dfcb800 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-csharp.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx index 7fdf0fb004..541af8f192 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-nodejs.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx index ec9d1548a2..62d64159e0 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-php.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx index 40bd2eb343..f30ce85ce8 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/configuration/content/_put-client-configuration-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; The client will be updated with the modified configuration the next time it sends a request to the database. * In this page: - * [Client configuration overview and modification](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#client-configuration-overview-and-modification) - * [What can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) + * [Client configuration overview and modification](#client-configuration-overview-and-modification) + * [What can be configured](#what-can-be-configured) * [Put client configuration (for database)](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#put-client-configuration-(for-database)) - * [Syntax](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Client configuration overview and modification * **What is the client configuration**: The client configuration is a set of configuration options that apply to the client when communicating with the database. - See [what can be configured](../../../../../client-api/operations/maintenance/configuration/put-client-configuration.mdx#what-can-be-configured) below. + See [what can be configured](#what-can-be-configured) below. * **Initializing the client configuration** (on the client): This configuration can be initially customized from the client code when creating the Document Store via the [Conventions](../../../../../client-api/configuration/conventions.mdx). diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx index 1dfb694b64..c4d25b09a5 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_add-connection-string-csharp.mdx @@ -8,15 +8,15 @@ import CodeBlock from '@theme/CodeBlock'; * Use the [PutConnectionStringOperation](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#the%c2%a0putconnectionstringoperation%c2%a0method) method to define a connection string in your database. * In this page: - * [Add a RavenDB connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-ravendb-connection-string) - * [Add an SQL connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-sql-connection-string) - * [Add a Snowflake connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-snowflake-connection-string) - * [Add an OLAP connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-olap-connection-string) - * [Add an Elasticsearch connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-elasticsearch-connection-string) - * [Add a Kafka connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-kafka-connection-string) - * [Add a RabbitMQ connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-a-rabbitmq-connection-string) - * [Add an Azure Queue Storage connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-azure-queue-storage-connection-string) - * [Add an Amazon SQS connection string](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#add-an-amazon-sqs-connection-string) + * [Add a RavenDB connection string](#add-a-ravendb-connection-string) + * [Add an SQL connection string](#add-an-sql-connection-string) + * [Add a Snowflake connection string](#add-a-snowflake-connection-string) + * [Add an OLAP connection string](#add-an-olap-connection-string) + * [Add an Elasticsearch connection string](#add-an-elasticsearch-connection-string) + * [Add a Kafka connection string](#add-a-kafka-connection-string) + * [Add a RabbitMQ connection string](#add-a-rabbitmq-connection-string) + * [Add an Azure Queue Storage connection string](#add-an-azure-queue-storage-connection-string) + * [Add an Amazon SQS connection string](#add-an-amazon-sqs-connection-string) * [The PutConnectionStringOperation method](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx#the%c2%a0putconnectionstringoperation%c2%a0method) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx index 95abc1e135..a8b69a3a2a 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_get-connection-string-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to create a new connection string, see [Add Connection String Operation](../../../../../client-api/operations/maintenance/connection-strings/add-connection-string.mdx). * In this page: - * [Get connection string by name and type](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#get-connection-string-by-name-and-type) - * [Get all connection strings](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#get-all-connnection-strings) - * [Syntax](../../../../../client-api/operations/maintenance/connection-strings/get-connection-string.mdx#syntax) + * [Get connection string by name and type](#get-connection-string-by-name-and-type) + * [Get all connection strings](#get-all-connnection-strings) + * [Syntax](#syntax) ## Get connection string by name and type diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx index 69eda73d4b..81b24da81a 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/connection-strings/content/_remove-connection-string-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `RemoveConnectionStringOperation` to remove a connection string definition from the database. * In this page: - * [Remove connection string](../../../../../client-api/operations/maintenance/connection-strings/remove-connection-string.mdx#remove-connecion-string) - * [Syntax](../../../../../client-api/operations/maintenance/connection-strings/remove-connection-string.mdx#syntax) + * [Remove connection string](#remove-connecion-string) + * [Syntax](#syntax) ## Remove connection string diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-csharp.mdx index 512ebf3689..b96eb56aa4 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-csharp.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [ForDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [ForDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-java.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-java.mdx index 1fae1c14e5..df718630b8 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-java.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-java.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [ForDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [ForDatabase](#get-stats-for-another-database). * In this page: - * [Get collection stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-stats) - * [Get detailed collection stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-stats) - * [Get database stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-stats) - * [Get detailed database stats](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats) - * [Get stats for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database) + * [Get collection stats](#get-collection-stats) + * [Get detailed collection stats](#get-detailed-collection-stats) + * [Get database stats](#get-database-stats) + * [Get detailed database stats](#get-detailed-database-stats) + * [Get stats for another database](#get-stats-for-another-database) ## Get collection stats diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-nodejs.mdx index 0d3dc4753a..097ecccc2e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-nodejs.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [forDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [forDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-php.mdx index e71b112ca2..8508a669fa 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-php.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [forDatabase](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [forDatabase](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-python.mdx index 48a81b5992..58863dc624 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/content/_get-stats-python.mdx @@ -8,14 +8,14 @@ import CodeBlock from '@theme/CodeBlock'; * Statistics can be retrieved for the database and for collections. * By default, statistics are retrieved for the database defined in the Document Store. - To get database and collection statistics for another database use [for_database](../../../../client-api/operations/maintenance/get-stats.mdx#get-stats-for-another-database). + To get database and collection statistics for another database use [for_database](#get-stats-for-another-database). * In this page: - * [Get collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-collection-statistics) - * [Get detailed collection statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-statistics) - * [Get database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-database-statistics) - * [Get detailed database statistics](../../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-statistics) - * [Get statistics for another database](../../../../client-api/operations/maintenance/get-stats.mdx#get-statistics-for-another-database) + * [Get collection statistics](#get-collection-statistics) + * [Get detailed collection statistics](#get-detailed-collection-statistics) + * [Get database statistics](#get-database-statistics) + * [Get detailed database statistics](#get-detailed-database-statistics) + * [Get statistics for another database](#get-statistics-for-another-database) ## Get collection statistics diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx index 9738caff5c..10d619e3d3 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-csharp.mdx @@ -12,16 +12,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Add RavenDB ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-ravendb-etl-task) - * [Add SQL ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-sql-etl-task) - * [Add Snowflake ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-snowflake-etl-task) - * [Add OLAP ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-olap-etl-task) - * [Add Elasticsearch ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-elasticsearch-etl-task) - * [Add Kafka ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-kafka-etl-task) - * [Add RabbitMQ ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-rabbitmq-etl-task) - * [Add Azure Queue Storage ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-azure-queue-storage-etl-task) - * [Add Amazon SQS ETL task](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#add-amazon-sqs-etl-task) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Add RavenDB ETL task](#add-ravendb-etl-task) + * [Add SQL ETL task](#add-sql-etl-task) + * [Add Snowflake ETL task](#add-snowflake-etl-task) + * [Add OLAP ETL task](#add-olap-etl-task) + * [Add Elasticsearch ETL task](#add-elasticsearch-etl-task) + * [Add Kafka ETL task](#add-kafka-etl-task) + * [Add RabbitMQ ETL task](#add-rabbitmq-etl-task) + * [Add Azure Queue Storage ETL task](#add-azure-queue-storage-etl-task) + * [Add Amazon SQS ETL task](#add-amazon-sqs-etl-task) + * [Syntax](#syntax) ## Add RavenDB ETL task diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-java.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-java.mdx index 3f1d1cd14e..3d1a32b908 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-java.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-java.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to manage ETL tasks from the Studio, see [Ongoing tasks - overview](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx). * In this page: - * [Example - add Raven ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-raven-etl) - * [Example - add SQL ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-sql-etl) - * [Example - add OLAP ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-olap-etl) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Example - add Raven ETL](#example---add-raven-etl) + * [Example - add SQL ETL](#example---add-sql-etl) + * [Example - add OLAP ETL](#example---add-olap-etl) + * [Syntax](#syntax) ## Example - add Raven ETL diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx index 58170dae88..183150f6e8 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/etl/content/_add-etl-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn how to manage ETL tasks from the Studio, see [Ongoing tasks - overview](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx). * In this page: - * [Example - add Raven ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-raven-etl) - * [Example - add SQL ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-sql-etl) - * [Example - add OLAP ETL](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-olap-etl) - * [Syntax](../../../../../client-api/operations/maintenance/etl/add-etl.mdx#syntax) + * [Example - add Raven ETL](#example---add-raven-etl) + * [Example - add SQL ETL](#example---add-sql-etl) + * [Example - add OLAP ETL](#example---add-olap-etl) + * [Syntax](#syntax) ## Example - add Raven ETL diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx index 09d03d3609..bfac0591d0 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-csharp.mdx @@ -26,8 +26,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx index f7cbc6f2b1..bafbc76300 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-nodejs.mdx @@ -23,8 +23,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-php.mdx index 6176ada7ab..85f8f0a247 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-php.mdx @@ -26,8 +26,8 @@ Learn more about identities in: * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-python.mdx index 1c54707c75..90875ad0ee 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_get-identities-python.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get identities operation](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#get-identities-operation) - * [Syntax](../../../../../client-api/operations/maintenance/identities/get-identities.mdx#syntax) + * [Get identities operation](#get-identities-operation) + * [Syntax](#syntax) ## Get identities operation diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx index a66fb5d3a6..c3fce10f04 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx index ea2d1d1e78..eac448b7a8 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx index c56dd45fa9..8e3bbb6d14 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-php.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx index 7b1d4db3c9..cd30e17816 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_increment-next-identity-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Increment the next identity value](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#increment-the-next-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/increment-next-identity.mdx#syntax) + * [Increment the next identity value](#increment-the-next-identity-value) + * [Syntax](#syntax) ## Increment the next identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx index d369cc606f..b95b3f0252 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx index f677028677..04b1f81bb3 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx index cff41d67c5..6a75c48d3a 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx index 566905305a..101a42c5d5 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/identities/content/_seed-identity-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * Identity values can also be managed from the Studio [identities view](../../../../../studio/database/documents/identities-view.mdx). * In this page: - * [Set a higher identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#set-a-higher-identity-value) - * [Force a lower identity value](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#force-a-lower-identity-value) - * [Syntax](../../../../../client-api/operations/maintenance/identities/seed-identity.mdx#syntax) + * [Set a higher identity value](#set-a-higher-identity-value) + * [Force a lower identity value](#force-a-lower-identity-value) + * [Syntax](#syntax) ## Set a higher identity value diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx index c23fc026f5..f7fe67a74f 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx index a93f84d8e7..ebef111c90 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx index e02fc1e16b..4d6e0c8812 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx index 92fa250e9a..79e0c07a20 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx index f1e376d6a0..f25efd5775 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-errors-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To just get index errors see [get index errors](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx). * In this page: - * [Delete errors from all indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-all-indexes) - * [Delete errors from specific indexes](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#delete-errors-from-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx#syntax) + * [Delete errors from all indexes](#delete-errors-from-all-indexes) + * [Delete errors from specific indexes](#delete-errors-from-specific-indexes) + * [Syntax](#syntax) ## Delete errors from all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx index 0426f99d7c..c3fd5f3ff1 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx index 4c93cd2d87..8f593bc293 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx index f429f6bcff..c9ae0351b8 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_delete-index-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * The index will be deleted from all the database-group nodes. * In this page: - * [Delete index example](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#delete-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/delete-index.mdx#syntax) + * [Delete index example](#delete-index-example) + * [Syntax](#syntax) ## Delete index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx index 4e222aee78..24a4bb1ef8 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-csharp.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -143,7 +143,7 @@ public DisableIndexOperation(string indexName, bool clusterWide) ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx index 746ab05918..f42084f905 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-nodejs.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -109,7 +109,7 @@ await documentStore.maintenance.send(disableIndexOp); ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx index 7b891ccebb..d4b46dd567 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-php.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -109,7 +109,7 @@ $store->maintenance()->send($disableIndexOp); ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx index c511961bc9..034eed0aad 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_disable-index-python.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#overview) - * [Which node is the index disabled on?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#which-node-is-the-index-disabled-on) - * [What happens when the index is disabled?](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#what-happens-when-the-index-is-disabled) + * [Overview](#overview) + * [Which node is the index disabled on?](#which-node-is-the-index-disabled-on) + * [What happens when the index is disabled?](#what-happens-when-the-index-is-disabled) - * [Disable index from the Client API](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-from-the-client-api) - * [Disable index - single node](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---single-node) - * [Disable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#syntax) + * [Disable index from the Client API](#disable-index-from-the-client-api) + * [Disable index - single node](#disable-index---single-node) + * [Disable index - cluster wide](#disable-index---cluster-wide) + * [Syntax](#syntax) - * [Disable index manually via the file system](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-manually-via-the-file-system) + * [Disable index manually via the file system](#disable-index-manually-via-the-file-system) ## Overview @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * When disabling an index from the **Studio** [indexes list](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) view: The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node. -* When disabling the index [manually](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disable-index-via-the-file-system): +* When disabling the index [manually](#disable-index-via-the-file-system): The index will be disabled on the [preferred node](../../../../../client-api/configuration/load-balance/overview.mdx#the-preferred-node) only, and Not on all the database-group nodes. #### What happens when the index is disabled? @@ -110,7 +110,7 @@ store.maintenance.send(disable_index_op) ## Disable index manually via the file system * It may sometimes be useful to disable an index manually, through the file system. - For example, a faulty index may load before [DisableIndexOperation](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx#disableindexoperation) gets a chance to disable it. + For example, a faulty index may load before [DisableIndexOperation](#disableindexoperation) gets a chance to disable it. Manually disabling the index will ensure that the index is not loaded. * To **manually disable** an index: diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx index a2775febbb..f5e3044502 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-csharp.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx index 621c2e63ec..b3ab68d902 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-nodejs.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx index 997762dea7..36191a1aed 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-php.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx index 708d8c7303..8abe1ca66f 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_enable-index-python.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * To learn how to disable an index, see [disable index](../../../../../client-api/operations/maintenance/indexes/disable-index.mdx). * In this page: - * [How to enable an index](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#how-to-enable-an-index) - * [Enable index from the Client API](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index-from-the-client-api) - * [Enable index - single node](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---single-node) - * [Enable index - cluster wide](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#enable-index---cluster-wide) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/enable-index.mdx#syntax) + * [How to enable an index](#how-to-enable-an-index) + * [Enable index from the Client API](#enable-index-from-the-client-api) + * [Enable index - single node](#enable-index---single-node) + * [Enable index - cluster wide](#enable-index---cluster-wide) + * [Syntax](#syntax) ## How to enable an index diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx index 15e958192d..93f3960a59 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx index 194fa2b579..965fc8c3d5 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx index aa00d20fa5..c28a2a89c6 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx index f86695b186..307603df9c 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx index d2baafcaf9..d8529c4350 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-errors-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * To learn about clearing index errors, see [delete index errors](../../../../../client-api/operations/maintenance/indexes/delete-index-errors.mdx). * In this page: - * [Get errors for all indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-all-indexes) - * [Get errors for specific indexes](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#get-errors-for-specific-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-errors.mdx#syntax) + * [Get errors for all indexes](#get-errors-for-all-indexes) + * [Get errors for specific indexes](#get-errors-for-specific-indexes) + * [Syntax](#syntax) ## Get errors for all indexes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx index 671350cba8..c1ff0ddadb 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx index 71fa11aaa3..6c710b24b0 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx index 05a9e103b6..218e602b9e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-php.mdx @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) + * [Get index names example](#get-index-names-example) ## Get index names example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx index e86703a4bd..1bdda73349 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-names-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetIndexNamesOperation` to retrieve multiple **index names** from the database. * In this page: - * [Get index names example](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#get-index-names-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index-names.mdx#syntax) + * [Get index names example](#get-index-names-example) + * [Syntax](#syntax) ## Get index names example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx index e87e0b571f..607390c08b 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-php.mdx index f901848ff9..de493677c5 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-python.mdx index c324e3105e..875f311218 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-index-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get the index state on the local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Index example](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#get-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-index.mdx#syntax) + * [Get Index example](#get-index-example) + * [Syntax](#syntax) ## Get Index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx index f05d5abfbf..029edea463 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx index f444d444bb..15e308f289 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx index 56996c3dfb..174f705673 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx index 34c5e18583..312e115833 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-indexes-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * To get a specific index state on a local node use `GetIndexStatisticsOperation`. * In this page: - * [Get Indexes example](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#get-indexes-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-indexes.mdx#syntax) + * [Get Indexes example](#get-indexes-example) + * [Syntax](#syntax) ## Get Indexes example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx index 9ff827853f..77f349695c 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx index 8435b10c26..9361b1277d 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx index d2fa71d61f..8180d4a934 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx index 9f4ee0f571..ce8ad5c817 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_get-terms-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `GetTermsOperation` to retrieve the **terms of an index-field**. * In this page: - * [Get Terms example](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#get-terms-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/get-terms.mdx#syntax) + * [Get Terms example](#get-terms-example) + * [Syntax](#syntax) ## Get Terms example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx index 974984aede..4f8ebbb266 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-csharp.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx index 04f615feb4..4c1512ba91 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-nodejs.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx index 3782d749dc..b8b51ced5b 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-php.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx index e75506f9bb..2e52cff22c 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_index-has-changed-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; on the server to avoid any unwanted changes to the existing indexed data. * In this page: - * [Check if index has changed](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#check-if-index-has-changed) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/index-has-changed.mdx#syntax) + * [Check if index has changed](#check-if-index-has-changed) + * [Syntax](#syntax) ## Check if index has changed diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx index 79fdf3d095..0f04730ffe 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx index 05544da750..3e7d69f423 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx index c6a4034ec3..8c8f88937c 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx index fd7ad51212..ddbcaa23c4 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_put-indexes-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; For a general description of Operations see [what are operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Ways to deploy indexes - short summary](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#ways-to-deploy-indexes---short-summary) - * [Put indexes operation with IndexDefinition](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinition) - * [Put indexes operation with IndexDefinitionBuilder](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#put-indexes-operation-with-indexdefinitionbuilder) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/put-indexes.mdx#syntax) + * [Ways to deploy indexes - short summary](#ways-to-deploy-indexes---short-summary) + * [Put indexes operation with IndexDefinition](#put-indexes-operation-with-indexdefinition) + * [Put indexes operation with IndexDefinitionBuilder](#put-indexes-operation-with-indexdefinitionbuilder) + * [Syntax](#syntax) ## Ways to deploy indexes - short summary diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx index 32564305aa..5d5e163906 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_reset-index-php.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; will put it back to the **normal** running state on the local node where the action was performed. * In this page: - * [Reset index](../../../../../client-api/operations/maintenance/indexes/reset-index.mdx#reset-index) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/reset-index.mdx#syntax) + * [Reset index](#reset-index) + * [Syntax](#syntax) ## Reset index diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx index f5bb188103..5ff3e542da 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-csharp.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx index 965351ae94..9f8f378b5e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-nodejs.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx index 779b275563..15676966f5 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-php.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx index e645f480f2..f7f124bbe6 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-lock-python.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; Locking an index is not a security measure, the index can be unlocked at any time. * In this page: - * [Lock modes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#lock-modes) - * [Sample usage flow](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#sample-usage-flow) - * [Set lock mode - single index](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---single-index) - * [Set lock mode - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#set-lock-mode---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-lock.mdx#syntax) + * [Lock modes](#lock-modes) + * [Sample usage flow](#sample-usage-flow) + * [Set lock mode - single index](#set-lock-mode---single-index) + * [Set lock mode - multiple indexes](#set-lock-mode---multiple-indexes) + * [Syntax](#syntax) ## Lock modes diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx index 7f875b0d11..595f7bd417 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-csharp.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx index 76e601122b..6012fcf834 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-nodejs.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx index 0ca03bdf2a..9c1a709b7a 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-php.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx index 0cf2d12046..bc7506e7bd 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_set-index-priority-python.mdx @@ -20,10 +20,10 @@ import CodeBlock from '@theme/CodeBlock'; * Setting the priority can also be done from the [indexes list view](../../../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) in the Studio. * In this page: - * [Index priority](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#index-priority) - * [Set priority - single index](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---single-index) - * [Set priority - multiple indexes](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#set-priority---multiple-indexes) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/set-index-priority.mdx#syntax) + * [Index priority](#index-priority) + * [Set priority - single index](#set-priority---single-index) + * [Set priority - multiple indexes](#set-priority---multiple-indexes) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx index 24595073f8..935fc1204c 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx index f6d9a7b91b..3b32ef6b88 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-php.mdx index 14ef2aae9e..b70cb2c25e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-php.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-python.mdx index 2fe3efecd1..94c86dbd14 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-index-python.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; The index is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume index example](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#resume-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-index.mdx#syntax) + * [Resume index example](#resume-index-example) + * [Syntax](#syntax) ## Resume index example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx index 3b9784baba..4013b8689d 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-csharp.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx index 64bd9cb18b..a5048570c3 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-nodejs.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx index 26f607769e..7a23a6382d 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx index 745ccb26f2..a5f5959c6a 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_start-indexing-python.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; Indexing is resumed on the local node the browser is opened on, even if it is Not the preferred node. * In this page: - * [Resume indexing example](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#resume-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/start-indexing.mdx#syntax) + * [Resume indexing example](#resume-indexing-example) + * [Syntax](#syntax) ## Resume indexing example diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx index b159519f88..029f8269c0 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx index 60db5fe885..807841aaef 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx index b6986b2db1..b822eda2b2 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx index 680d333d17..0e495c8486 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-index-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause indexing for ALL indexes in the database use [StopIndexingOperation](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#overview) - * [Pause index example](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#pause-index-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx#syntax) + * [Overview](#overview) + * [Pause index example](#pause-index-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx index 0980efe6c6..d77178e55e 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx index 99620f9bf5..3e43f11785 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx index 88d0d1d7e0..28887a5003 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx index df4617a7f6..058b46e519 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/indexes/content/_stop-indexing-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To pause only a specific index use the [StopIndexOperation](../../../../../client-api/operations/maintenance/indexes/stop-index.mdx). * In this page: - * [Overview](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#overview) - * [Pause indexing example](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#pause-indexing-example) - * [Syntax](../../../../../client-api/operations/maintenance/indexes/stop-indexing.mdx#syntax) + * [Overview](#overview) + * [Pause indexing example](#pause-indexing-example) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx index 238952e037..2fefe04bad 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/ongoing-tasks/content/_ongoing-task-operations-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Ongoing tasks can also be managed via the [Tasks list view](../../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#ongoing-tasks---view) in the Studio. * In this page: - * [Get ongoing task info](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#get-ongoing-task-info) - * [Delete ongoing task](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#delete-ongoing-task) - * [Toggle ongoing task state](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#toggle-ongoing-task-state) - * [Syntax](../../../../../client-api/operations/maintenance/ongoing-tasks/ongoing-task-operations.mdx#syntax) + * [Get ongoing task info](#get-ongoing-task-info) + * [Delete ongoing task](#delete-ongoing-task) + * [Toggle ongoing task state](#toggle-ongoing-task-state) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx index 55f1ffe37b..c31f12be57 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded to the server from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#put-custom-sorter) - * [Syntax](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#syntax) + * [Put custom sorter](#put-custom-sorter) + * [Syntax](#syntax) ## Put custom sorter diff --git a/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx index 3672828b09..2a947549a4 100644 --- a/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/maintenance/sorters/content/_put-sorter-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded to the server from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#put-custom-sorter) - * [Syntax](../../../../../client-api/operations/maintenance/sorters/put-sorter.mdx#syntax) + * [Put custom sorter](#put-custom-sorter) + * [Syntax](#syntax) ## Put custom sorter diff --git a/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-csharp.mdx index 0ff0844c73..ee8ce1a90e 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-csharp.mdx @@ -13,9 +13,9 @@ This is usually not the case for NoSQL databases where set based operations are The same queries and indexes that are used for data retrieval are used for the set based operations. The syntax defining which documents to work on is exactly the same as you'd specified for those documents to be pulled from the store. In this page: -[Syntax overview](../../../../client-api/operations/patching/set-based.mdx#syntax-overview) -[Examples](../../../../client-api/operations/patching/set-based.mdx#examples) -[Additional notes](../../../../client-api/operations/patching/set-based.mdx#additional-notes) +[Syntax overview](#syntax-overview) +[Examples](#examples) +[Additional notes](#additional-notes) diff --git a/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-java.mdx b/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-java.mdx index ac9cdc38a8..cf9f60c909 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-java.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-java.mdx @@ -13,9 +13,9 @@ This is usually not the case for NoSQL databases where set based operations are The same queries and indexes that are used for data retrieval are used for the set based operations. The syntax defining which documents to work on is exactly the same as you'd specified for those documents to be pulled from the store. In this page: -[Syntax overview](../../../../client-api/operations/patching/set-based.mdx#syntax-overview) -[Examples](../../../../client-api/operations/patching/set-based.mdx#examples) -[Additional notes](../../../../client-api/operations/patching/set-based.mdx#additional-notes) +[Syntax overview](#syntax-overview) +[Examples](#examples) +[Additional notes](#additional-notes) diff --git a/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-nodejs.mdx index c99225cd8d..5599978e5b 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/content/_set-based-nodejs.mdx @@ -11,21 +11,21 @@ import CodeBlock from '@theme/CodeBlock'; Set-based patching can also be done from the [Studio](../../../../studio/database/documents/patch-view.mdx). * In this page: - * [Overview](../../../../client-api/operations/patching/set-based.mdx#overview) - * [Defining set-based patching](../../../../client-api/operations/patching/set-based.mdx#defining-set-based-patching) - * [Important characteristics](../../../../client-api/operations/patching/set-based.mdx#important-characteristics) - * [Examples](../../../../client-api/operations/patching/set-based.mdx#examples) - * [Update by collection query](../../../../client-api/operations/patching/set-based.mdx#update-by-collection-query) - * [Update by collection query - access metadata](../../../../client-api/operations/patching/set-based.mdx#update-by-collection-query---access-metadata) - * [Update by dynamic query](../../../../client-api/operations/patching/set-based.mdx#update-by-dynamic-query) - * [Update by static index query](../../../../client-api/operations/patching/set-based.mdx#update-by-static-index-query) - * [Update all documents](../../../../client-api/operations/patching/set-based.mdx#update-all-documents) - * [Update by document ID](../../../../client-api/operations/patching/set-based.mdx#update-by-document-id) - * [Update by document ID using parameters](../../../../client-api/operations/patching/set-based.mdx#update-by-document-id-using-parameters) - * [Allow updating stale results](../../../../client-api/operations/patching/set-based.mdx#allow-updating-stale-results) - * [Syntax](../../../../client-api/operations/patching/set-based.mdx#syntax) - * [Send syntax](../../../../client-api/operations/patching/set-based.mdx#send-syntax) - * [PatchByQueryOperation syntax](../../../../client-api/operations/patching/set-based.mdx#syntax) + * [Overview](#overview) + * [Defining set-based patching](#defining-set-based-patching) + * [Important characteristics](#important-characteristics) + * [Examples](#examples) + * [Update by collection query](#update-by-collection-query) + * [Update by collection query - access metadata](#update-by-collection-query---access-metadata) + * [Update by dynamic query](#update-by-dynamic-query) + * [Update by static index query](#update-by-static-index-query) + * [Update all documents](#update-all-documents) + * [Update by document ID](#update-by-document-id) + * [Update by document ID using parameters](#update-by-document-id-using-parameters) + * [Allow updating stale results](#allow-updating-stale-results) + * [Syntax](#syntax) + * [Send syntax](#send-syntax) + * [PatchByQueryOperation syntax](#syntax) ## Overview @@ -83,7 +83,7 @@ update \{ * __Patching stale indexes__: By default, set-based patch operations will only succeed if the index is Not [stale](../../../../indexes/stale-indexes.mdx). For indexes that are frequently updated, you can explicitly allow patching on stale results if needed. - An example can be seen in the [Allow updating stale results](../../../../client-api/operations/patching/set-based.mdx#allow-updating-stale-results) example. + An example can be seen in the [Allow updating stale results](#allow-updating-stale-results) example. * __Manage lengthy patch operations__: The set-based patch operation (`PatchByQueryOperation`) runs in the server background may take a long time to complete. diff --git a/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-csharp.mdx index c3c639ce97..73ff8adff7 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-csharp.mdx @@ -15,39 +15,39 @@ import CodeBlock from '@theme/CodeBlock'; * The current page covers patch operations on single documents. -* Patching has three possible interfaces: [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api), -[Session API using Defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer), -and [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api). +* Patching has three possible interfaces: [Session API](#session-api), +[Session API using Defer](#session-api-using-defer), +and [Operations API](#operations-api). -* Patching can be done from the [client API](../../../../client-api/operations/patching/single-document.mdx#examples) as well as in the [studio](../../../../studio/database/documents/patch-view.mdx). +* Patching can be done from the [client API](#examples) as well as in the [studio](../../../../studio/database/documents/patch-view.mdx). In this page: -* [API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) - * [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api) - * [Session API using Defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer) - * [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api) - * [List of script methods](../../../../client-api/operations/patching/single-document.mdx#list-of-script-methods) -* [Examples](../../../../client-api/operations/patching/single-document.mdx#examples) - * [Change value of single field](../../../../client-api/operations/patching/single-document.mdx#change-value-of-single-field) - * [Change values of two fields](../../../../client-api/operations/patching/single-document.mdx#change-values-of-two-fields) - * [Increment value](../../../../client-api/operations/patching/single-document.mdx#increment-value) - * [Add or increment](../../../../client-api/operations/patching/single-document.mdx#add-or-increment) - * [Add or patch](../../../../client-api/operations/patching/single-document.mdx#add-or-patch) - * [Add or patch to an existing array](../../../../client-api/operations/patching/single-document.mdx#add-or-patch-to-an-existing-array) - * [Add item to array](../../../../client-api/operations/patching/single-document.mdx#add-item-to-array) - * [Insert item into specific position in array](../../../../client-api/operations/patching/single-document.mdx#insert-item-into-specific-position-in-array) - * [Modify item in specific position in array](../../../../client-api/operations/patching/single-document.mdx#modify-item-in-specific-position-in-array) - * [Remove items from array](../../../../client-api/operations/patching/single-document.mdx#remove-items-from-array) - * [Loading documents in a script](../../../../client-api/operations/patching/single-document.mdx#loading-documents-in-a-script) - * [Remove property](../../../../client-api/operations/patching/single-document.mdx#remove-property) - * [Rename property](../../../../client-api/operations/patching/single-document.mdx#rename-property) - * [Add document](../../../../client-api/operations/patching/single-document.mdx#add-document) - * [Clone document](../../../../client-api/operations/patching/single-document.mdx#clone-document) - * [Increment counter](../../../../client-api/operations/patching/single-document.mdx#increment-counter) - * [Delete counter](../../../../client-api/operations/patching/single-document.mdx#delete-counter) - * [Get counter](../../../../client-api/operations/patching/single-document.mdx#get-counter) - * [Patching using inline string compilation](../../../../client-api/operations/patching/single-document.mdx#patching-using-inline-string-compilation) +* [API overview](#api-overview) + * [Session API](#session-api) + * [Session API using Defer](#session-api-using-defer) + * [Operations API](#operations-api) + * [List of script methods](#list-of-script-methods) +* [Examples](#examples) + * [Change value of single field](#change-value-of-single-field) + * [Change values of two fields](#change-values-of-two-fields) + * [Increment value](#increment-value) + * [Add or increment](#add-or-increment) + * [Add or patch](#add-or-patch) + * [Add or patch to an existing array](#add-or-patch-to-an-existing-array) + * [Add item to array](#add-item-to-array) + * [Insert item into specific position in array](#insert-item-into-specific-position-in-array) + * [Modify item in specific position in array](#modify-item-in-specific-position-in-array) + * [Remove items from array](#remove-items-from-array) + * [Loading documents in a script](#loading-documents-in-a-script) + * [Remove property](#remove-property) + * [Rename property](#rename-property) + * [Add document](#add-document) + * [Clone document](#clone-document) + * [Increment counter](#increment-counter) + * [Delete counter](#delete-counter) + * [Get counter](#get-counter) + * [Patching using inline string compilation](#patching-using-inline-string-compilation) diff --git a/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-java.mdx b/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-java.mdx index 450920f197..1b31568340 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-java.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-java.mdx @@ -9,13 +9,13 @@ The whole operation is executed on the server side and is useful as a performanc The current page deals with patch operations on single documents. -Patching has three possible interfaces: [Session API](../../../../client-api/operations/patching/single-document.mdx#session-api), [Session API using defer](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer), and [Operations API](../../../../client-api/operations/patching/single-document.mdx#operations-api). +Patching has three possible interfaces: [Session API](#session-api), [Session API using defer](#session-api-using-defer), and [Operations API](#operations-api). Patching can be done from the client as well as in the studio. In this page: -[API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) -[Examples](../../../../client-api/operations/patching/single-document.mdx#examples) +[API overview](#api-overview) +[Examples](#examples) ## API overview diff --git a/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-nodejs.mdx index 10367121ff..7c358f9cf7 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/content/_single-document-nodejs.mdx @@ -19,39 +19,39 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [API overview](../../../../client-api/operations/patching/single-document.mdx#api-overview) + * [API overview](#api-overview) - * [Examples](../../../../client-api/operations/patching/single-document.mdx#examples) - * [Modify value of single field](../../../../client-api/operations/patching/single-document.mdx#modify-value-of-single-field) - * [Modify values of two fields](../../../../client-api/operations/patching/single-document.mdx#modify-values-of-two-fields) - * [Increment value](../../../../client-api/operations/patching/single-document.mdx#increment-value) - * [Add or increment](../../../../client-api/operations/patching/single-document.mdx#add-or-increment) - * [Add or patch](../../../../client-api/operations/patching/single-document.mdx#add-or-patch) - * [Add item to array](../../../../client-api/operations/patching/single-document.mdx#add-item-to-array) - * [Add or patch an existing array](../../../../client-api/operations/patching/single-document.mdx#add-or-patch-an-existing-array) - * [Insert item into specific position in array](../../../../client-api/operations/patching/single-document.mdx#insert-item-into-specific-position-in-array) - * [Modify item in specific position in array](../../../../client-api/operations/patching/single-document.mdx#modify-item-in-specific-position-in-array) - * [Remove items from array](../../../../client-api/operations/patching/single-document.mdx#remove-items-from-array) - * [Load documents in a script](../../../../client-api/operations/patching/single-document.mdx#load-documents-in-a-script) - * [Remove property](../../../../client-api/operations/patching/single-document.mdx#remove-property) - * [Rename property](../../../../client-api/operations/patching/single-document.mdx#rename-property) - * [Add document](../../../../client-api/operations/patching/single-document.mdx#add-document) - * [Clone document](../../../../client-api/operations/patching/single-document.mdx#clone-document) - * [Create/Increment counter](../../../../client-api/operations/patching/single-document.mdx#createincrement-counter) - * [Delete counter](../../../../client-api/operations/patching/single-document.mdx#delete-counter) - * [Get counter](../../../../client-api/operations/patching/single-document.mdx#get-counter) - * [Patching using inline string compilation](../../../../client-api/operations/patching/single-document.mdx#patching-using-inline-string-compilation) + * [Examples](#examples) + * [Modify value of single field](#modify-value-of-single-field) + * [Modify values of two fields](#modify-values-of-two-fields) + * [Increment value](#increment-value) + * [Add or increment](#add-or-increment) + * [Add or patch](#add-or-patch) + * [Add item to array](#add-item-to-array) + * [Add or patch an existing array](#add-or-patch-an-existing-array) + * [Insert item into specific position in array](#insert-item-into-specific-position-in-array) + * [Modify item in specific position in array](#modify-item-in-specific-position-in-array) + * [Remove items from array](#remove-items-from-array) + * [Load documents in a script](#load-documents-in-a-script) + * [Remove property](#remove-property) + * [Rename property](#rename-property) + * [Add document](#add-document) + * [Clone document](#clone-document) + * [Create/Increment counter](#createincrement-counter) + * [Delete counter](#delete-counter) + * [Get counter](#get-counter) + * [Patching using inline string compilation](#patching-using-inline-string-compilation) - * [Syntax](../../../../client-api/operations/patching/single-document.mdx#syntax) - * [Session API syntax](../../../../client-api/operations/patching/single-document.mdx#session-api-syntax) - * [Session API using defer syntax](../../../../client-api/operations/patching/single-document.mdx#session-api-using-defer-syntax) - * [Operations API syntax](../../../../client-api/operations/patching/single-document.mdx#operations-api-syntax) - * [List of script methods syntax](../../../../client-api/operations/patching/single-document.mdx#list-of-script-methods-syntax) + * [Syntax](#syntax) + * [Session API syntax](#session-api-syntax) + * [Session API using defer syntax](#session-api-using-defer-syntax) + * [Operations API syntax](#operations-api-syntax) + * [List of script methods syntax](#list-of-script-methods-syntax) ## API overview -Patching can be performed using either of the following interfaces (detailed syntax is provided [below](../../../../client-api/operations/patching/single-document.mdx#syntax)): +Patching can be performed using either of the following interfaces (detailed syntax is provided [below](#syntax)): * **Session API** * **Session API using defer** @@ -65,7 +65,7 @@ Patching can be performed using either of the following interfaces (detailed syn * Multiple patch methods can be defined on the [session](../../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx) and are sent to the server for execution in a single batch (along with any other modified documents) only when calling [SaveChanges](../../../../client-api/session/saving-changes.mdx). -* This API includes the following patching methods (see examples [below](../../../../client-api/operations/patching/single-document.mdx#examples)): +* This API includes the following patching methods (see examples [below](#examples)): * `patch` * `addOrPatch` * `increment` diff --git a/versioned_docs/version-7.1/client-api/operations/patching/json-patch-syntax.mdx b/versioned_docs/version-7.1/client-api/operations/patching/json-patch-syntax.mdx index 03f0b620cf..fb208b615b 100644 --- a/versioned_docs/version-7.1/client-api/operations/patching/json-patch-syntax.mdx +++ b/versioned_docs/version-7.1/client-api/operations/patching/json-patch-syntax.mdx @@ -33,16 +33,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Test** whether the patching succeeded * In this page: - * [JSON Patches](../../../client-api/operations/patching/json-patch-syntax.mdx#json-patches) - * [Running JSON Patches](../../../client-api/operations/patching/json-patch-syntax.mdx#running-json-patches) - * [Patch Operations](../../../client-api/operations/patching/json-patch-syntax.mdx#patch-operations) - * [Add Document Property](../../../client-api/operations/patching/json-patch-syntax.mdx#add-operation) - * [Remove Document Property](../../../client-api/operations/patching/json-patch-syntax.mdx#remove-document-property) - * [Replace Document Property Contents](../../../client-api/operations/patching/json-patch-syntax.mdx#replace-document-property-contents) - * [Copy Document Property Contents to Another Property](../../../client-api/operations/patching/json-patch-syntax.mdx#copy-document-property-contents-to-another-property) - * [Move Document Property Contents to Another Property](../../../client-api/operations/patching/json-patch-syntax.mdx#move-document-property-contents-to-another-property) - * [Test Patching Operation](../../../client-api/operations/patching/json-patch-syntax.mdx#test-patching-operation) - * [Additional JSON Patching Options](../../../client-api/operations/patching/json-patch-syntax.mdx#additional-json-patching-options) + * [JSON Patches](#json-patches) + * [Running JSON Patches](#running-json-patches) + * [Patch Operations](#patch-operations) + * [Add Document Property](#add-operation) + * [Remove Document Property](#remove-document-property) + * [Replace Document Property Contents](#replace-document-property-contents) + * [Copy Document Property Contents to Another Property](#copy-document-property-contents-to-another-property) + * [Move Document Property Contents to Another Property](#move-document-property-contents-to-another-property) + * [Test Patching Operation](#test-patching-operation) + * [Additional JSON Patching Options](#additional-json-patching-options) ## JSON Patches diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx index 31d1262405..3eaaf309a3 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-csharp.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx index ff29acf58f..d0aa9032f7 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-java.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx index a3c5a9c645..377f371039 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/certificates/content/_put-client-certificate-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; see [Upload an existing client certificate](../../../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate). * In this article: - * [Put client certificate example](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#put-client-certificate-example) - * [Syntax](../../../../../client-api/operations/server-wide/certificates/put-client-certificate.mdx#syntax) + * [Put client certificate example](#put-client-certificate-example) + * [Syntax](#syntax) ## Put client certificate example diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx index fce920222a..d840b4c97c 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-csharp.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; the next time it makes a request to the database. * In this page: * [Put client-configuration (server-wide)](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#put-client-configuration-(server-wide)) - * [Syntax](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Put client-configuration (server-wide) diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx index 0e467c833c..6fbc9d9c8a 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/configuration/content/_put-serverwide-client-configuration-nodejs.mdx @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock'; the next time it makes a request to the database. * In this page: * [Put client-configuration (server-wide)](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#put-client-configuration-(server-wide)) - * [Syntax](../../../../../client-api/operations/server-wide/configuration/put-serverwide-client-configuration.mdx#syntax) + * [Syntax](#syntax) ## Put client-configuration (server-wide) diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-csharp.mdx index a276dc7464..4f2e2152e0 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx index 4f4f3fd485..1283ee43e5 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-php.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-php.mdx index 9b73dd3f10..6bb51d67dc 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-python.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-python.mdx index e5b058a507..8509fc89c5 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_add-database-node-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the cluster assigns a mentor node (from the existing database-group nodes) to update the new node. * In this page: - * [Add database node - random](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---random) - * [Add database node - specific](../../../../client-api/operations/server-wide/add-database-node.mdx#add-database-node---specific) - * [Syntax](../../../../client-api/operations/server-wide/add-database-node.mdx#syntax) + * [Add database node - random](#add-database-node---random) + * [Add database node - specific](#add-database-node---specific) + * [Syntax](#syntax) ## Add database node - random diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-csharp.mdx index 3671447e6b..37f6254633 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-csharp.mdx @@ -26,14 +26,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-nodejs.mdx index 60f762a229..b974e885fa 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-nodejs.mdx @@ -26,14 +26,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-php.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-php.mdx index 1786e738ff..644c21c6c3 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-php.mdx @@ -25,14 +25,14 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compact on other nodes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-on-other-nodes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) - * [Syntax](../../../../client-api/operations/server-wide/compact-database.mdx#syntax) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compact on other nodes](#compact-on-other-nodes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) + * [Syntax](#syntax) ## Examples diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-python.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-python.mdx index 5a9abb06b0..51bc805228 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_compact-database-python.mdx @@ -25,12 +25,12 @@ import CodeBlock from '@theme/CodeBlock'; An exception is thrown if the specified database doesn't exist on the server node. * In this page: - * [Examples](../../../../client-api/operations/server-wide/compact-database.mdx#examples): - * [Compact documents](../../../../client-api/operations/server-wide/compact-database.mdx#examples) - * [Compact specific indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-specific-indexes) - * [Compact all indexes](../../../../client-api/operations/server-wide/compact-database.mdx#compact-all-indexes) - * [Compaction triggers compression](../../../../client-api/operations/server-wide/compact-database.mdx#compaction-triggers-compression) - * [Compact from Studio](../../../../client-api/operations/server-wide/compact-database.mdx#compact-from-studio) + * [Examples](#examples): + * [Compact documents](#examples) + * [Compact specific indexes](#compact-specific-indexes) + * [Compact all indexes](#compact-all-indexes) + * [Compaction triggers compression](#compaction-triggers-compression) + * [Compact from Studio](#compact-from-studio) ## Examples diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-csharp.mdx index f8fda7c46f..cc89061fa4 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; To learn which operations are allowed at each level, see [Security clearance and permissions](../../../../server/security/authorization/security-clearance-and-permissions.mdx). * In this article: - * [Create new database](../../../../client-api/operations/server-wide/create-database.mdx#create-new-database) - * [Example I - Create non-sharded database](../../../../client-api/operations/server-wide/create-database.mdx#example-i---create-non-sharded-database) - * [Example II - Create sharded database](../../../../client-api/operations/server-wide/create-database.mdx#example-ii---create-sharded-database) - * [Example III - Ensure database does not exist before creating](../../../../client-api/operations/server-wide/create-database.mdx#example-iii---ensure-database-does-not-exist-before-creating) - * [Syntax](../../../../client-api/operations/server-wide/create-database.mdx#syntax) + * [Create new database](#create-new-database) + * [Example I - Create non-sharded database](#example-i---create-non-sharded-database) + * [Example II - Create sharded database](#example-ii---create-sharded-database) + * [Example III - Ensure database does not exist before creating](#example-iii---ensure-database-does-not-exist-before-creating) + * [Syntax](#syntax) ## Create new database @@ -339,9 +339,9 @@ public CreateDatabaseOperation(Action builder | Parameter | Description | |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **databaseRecord** | Instance of `DatabaseRecord` containing database configuration.
See [The Database Record](../../../../client-api/operations/server-wide/create-database.mdx#the-database-record) below. | +| **databaseRecord** | Instance of `DatabaseRecord` containing database configuration.
See [The Database Record](#the-database-record) below. | | **replicationFactor** | Number of nodes the database should be replicated to.

If not specified, the value is taken from `databaseRecord.Topology.ReplicationFactor`,
or defaults to **`1`** if that is not set.

If `Topology` is provided, the `replicationFactor` is ignored. | -| **builder** | Callback used to initialize and fluently configure a new DatabaseRecord.
Receives an `IDatabaseRecordBuilderInitializer` on which you invoke builder methods to construct the record. See [The Database Record Builder](../../../../client-api/operations/server-wide/create-database.mdx#the-database-record-builder) below. | +| **builder** | Callback used to initialize and fluently configure a new DatabaseRecord.
Receives an `IDatabaseRecordBuilderInitializer` on which you invoke builder methods to construct the record. See [The Database Record Builder](#the-database-record-builder) below. | ### The Database Record: The `DatabaseRecord` is a collection of database configurations: diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-java.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-java.mdx index cfb2afb138..c756d088d7 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-java.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_create-database-java.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; To learn which operations are allowed at each level, see [Security clearance and permissions](../../../../server/security/authorization/security-clearance-and-permissions.mdx). * In this article: - * [Create new database](../../../../client-api/operations/server-wide/create-database.mdx#create-new-database) - * [Example I - Create database](../../../../client-api/operations/server-wide/create-database.mdx#example-i---create-non-sharded-database) - * [Example II - Ensure database does not exist before creating](../../../../client-api/operations/server-wide/create-database.mdx#example-ii---ensure-database-does-not-exist-before-creating) - * [Syntax](../../../../client-api/operations/server-wide/create-database.mdx#syntax) + * [Create new database](#create-new-database) + * [Example I - Create database](#example-i---create-non-sharded-database) + * [Example II - Ensure database does not exist before creating](#example-ii---ensure-database-does-not-exist-before-creating) + * [Syntax](#syntax) ## Create new database diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx index 38df44762b..73b25abc06 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx index 3f44ee5cad..e7f8eb546d 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx index 9e2a453d62..f472089b15 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-php.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx index e9b4630154..8564dc961f 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/content/_toggle-databases-state-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Enable/Disable database from the Client API](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable/disable-database-from-the-client-api) - * [Enable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#enable-database) - * [Disable database](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database) - * [Syntax](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#syntax) - * [Disable database via the file system](../../../../client-api/operations/server-wide/toggle-databases-state.mdx#disable-database-via-the-file-system) + * [Enable database](#enable-database) + * [Disable database](#disable-database) + * [Syntax](#syntax) + * [Disable database via the file system](#disable-database-via-the-file-system) ## Enable/Disable database from the Client API diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx index c04f00aa79..eca9329f5a 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_get-logs-configuration-csharp.mdx @@ -12,8 +12,8 @@ import Panel from '@site/src/components/Panel'; * Learn more about RavenDB's logging system in the [Logging](../../../../../server/troubleshooting/logging.mdx) article. * In this article: - * [Get logs configuration](../../../../../client-api/operations/server-wide/logs/get-logs-configuration.mdx#get-logs-configuration) - * [Syntax](../../../../../client-api/operations/server-wide/logs/get-logs-configuration.mdx#syntax) + * [Get logs configuration](#get-logs-configuration) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx index e145eecf2e..e595e5b5e2 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/logs/content/_set-logs-configuration-csharp.mdx @@ -20,10 +20,10 @@ import Panel from '@site/src/components/Panel'; * Learn more about RavenDB's logging system in the [Logging](../../../../../server/troubleshooting/logging.mdx) article. * In this article: - * [Set logs configuration](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#set-logs-configuration) - * [Set Microsoft logs configuration](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#set-microsoft-logs-configuration) - * [Set Admin logs configuration](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#set-admin-logs-configuration) - * [Syntax](../../../../../client-api/operations/server-wide/logs/set-logs-configuration.mdx#syntax) + * [Set logs configuration](#set-logs-configuration) + * [Set Microsoft logs configuration](#set-microsoft-logs-configuration) + * [Set Admin logs configuration](#set-admin-logs-configuration) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx index 97b8362bde..c716cfd912 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded server-wide from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter server-wide](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#put-custom-sorter-server-wide) - * [Syntax](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#syntax) + * [Put custom sorter server-wide](#put-custom-sorter-server-wide) + * [Syntax](#syntax) ## Put custom sorter server-wide diff --git a/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx b/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx index a439af29c6..b4f9ebf959 100644 --- a/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/operations/server-wide/sorters/content/_put-sorter-server-wide-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; * A custom sorter can also be uploaded server-wide from the [Studio](../../../../../studio/database/settings/custom-sorters.mdx). * In this page: - * [Put custom sorter server-wide](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#put-custom-sorter-server-wide) - * [Syntax](../../../../../client-api/operations/server-wide/sorters/put-sorter-server-wide.mdx#syntax) + * [Put custom sorter server-wide](#put-custom-sorter-server-wide) + * [Syntax](#syntax) ## Put custom sorter server-wide diff --git a/versioned_docs/version-7.1/client-api/rest-api/document-commands/batch-commands.mdx b/versioned_docs/version-7.1/client-api/rest-api/document-commands/batch-commands.mdx index 0b2436884e..b9ee607420 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/document-commands/batch-commands.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/document-commands/batch-commands.mdx @@ -17,20 +17,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use this endpoint with the **`POST`** method to send multiple commands in one request: `/databases//bulk_docs` -* The commands are sent as a JSON array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#body). +* The commands are sent as a JSON array in the [request body](#body). * All the commands in the batch will either succeed or fail as a **single transaction**. Changes will not be visible until the entire batch completes. -* [Options](../../../client-api/rest-api/document-commands/batch-commands.mdx#batch-options) can be set to make the server wait +* [Options](#batch-options) can be set to make the server wait for indexing and replication to complete before returning. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/batch-commands.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format) - * [Commands](../../../client-api/rest-api/document-commands/batch-commands.mdx#commands) - * [Response Format](../../../client-api/rest-api/document-commands/batch-commands.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/batch-commands.mdx#more-examples) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Commands](#commands) + * [Response Format](#response-format) + * [More Examples](#more-examples) ## Basic Example @@ -113,7 +113,7 @@ Raven-Server-Version: 4.2.4.42 ## Request Format This is the general format of a cURL request with a batch of commands that _does not_ include a Put Attachment Command -(see the format for batching a Put Attachment Command [below](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command)): +(see the format for batching a Put Attachment Command [below](#put-attachment-command)): @@ -133,7 +133,7 @@ Linebreaks are added for clarity. #### Query String -The query string takes [batch options](../../../client-api/rest-api/document-commands/batch-commands.mdx#batch-options), which +The query string takes [batch options](#batch-options), which can make the server wait for indexing and replication to finish before responding. @@ -142,7 +142,7 @@ can make the server wait for indexing and replication to finish before respondin The header `Content-Type` is required and takes one of two values: * `application/json` - if the batch _does not_ include a Put Attachment Command. -* `multipart/mixed; boundary=` - if the batch [_does_](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command) +* `multipart/mixed; boundary=` - if the batch [_does_](#put-attachment-command) include a Put Attachment Command. The "separator" is an arbitrary string used to demarcate the attachment streams and commands array. @@ -172,12 +172,12 @@ using a backslash: `"` -> `\"`. The following commands can be sent using the batch command: -* [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command) -* [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command) -* [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command) -* [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command) -* [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command) -* [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command) +* [Put Document Command](#put-document-command) +* [Patch Document Command](#patch-document-command) +* [Delete Document Command](#delete-document-command) +* [Delete by Prefix Command](#delete-by-prefix-command) +* [Put Attachment Command](#put-attachment-command) +* [Delete Attachment Command](#delete-attachment-command) ### Batch Options These options, configured in the query string, make the server wait until indexing or replication have completed before responding. If these have not @@ -220,7 +220,7 @@ Linebreaks are added for clarity. Upload a new document or update an existing document. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -250,7 +250,7 @@ Format within the `Commands` array in the [request body](../../../client-api/res Update a document. A [patch](../../../client-api/operations/patching/single-document.mdx) is executed on the server side and does not involve loading the document, avoiding the cost of sending the entire document in a round trip over the network. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -280,8 +280,8 @@ Format within the `Commands` array in the [request body](../../../client-api/res | - | - | - | | **Id** | ID of a document to execute the patch on | Yes | | **ChangeVector** | The document's expected [change vector](../../../server/clustering/replication/change-vector.mdx). If it does not match the server-side change vector a concurrency exception is thrown. | No | -| **Patch** | A script that modifies the specified document. [Details below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-request). | Yes | -| **PatchIfMissing** | An alternative script to be executed if no document with the given ID is found. This will create a new document with the given ID. [Details below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-request). | No | +| **Patch** | A script that modifies the specified document. [Details below](#patch-request). | Yes | +| **PatchIfMissing** | An alternative script to be executed if no document with the given ID is found. This will create a new document with the given ID. [Details below](#patch-request). | No | | **Type** | Set to `PATCH` | Yes | #### Patch Request @@ -297,7 +297,7 @@ wrap strings. Delete a document by its ID. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -319,7 +319,7 @@ Format within the `Commands` array in the [request body](../../../client-api/res Delete all documents whose IDs begin with a certain prefix. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -390,7 +390,7 @@ Command-Type: AttachmentStream Delete an attachment in a certain document. -Format within the `Commands` array in the [request body](../../../client-api/rest-api/document-commands/batch-commands.mdx#request-format): +Format within the `Commands` array in the [request body](#request-format): @@ -441,12 +441,12 @@ Results appear in the same order as the commands in the request body. * Format within the `Results` array in the response body: - * [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command-1) - * [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command-1) - * [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command-1) - * [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command-1) - * [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command-1) - * [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command-1) + * [Put Document Command](#put-document-command-1) + * [Patch Document Command](#patch-document-command-1) + * [Delete Document Command](#delete-document-command-1) + * [Delete by Prefix Command](#delete-by-prefix-command-1) + * [Put Attachment Command](#put-attachment-command-1) + * [Delete Attachment Command](#delete-attachment-command-1) ### Put Document Command @@ -492,7 +492,7 @@ Results appear in the same order as the commands in the request body. | **@change-vector** | The document's change vector after the command was executed. Returns `null` if the command did not result in any changes. | | **@last-modified** | Date and time (UTC) of the most recent modification made to the document. | | **Type** | Same as the `Type` of the command sent - in this case `PATCH`. | -| **PatchStatus** | See [below](../../../client-api/rest-api/document-commands/batch-commands.mdx#patchstatus) | +| **PatchStatus** | See [below](#patchstatus) | | **Debug** | Should always return `null` in the context of batch commands. | #### PatchStatus @@ -600,12 +600,12 @@ Results appear in the same order as the commands in the request body. [About Northwind](../../../start/about-examples.mdx), the database used in our examples. * In this section: - * [Put Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-document-command-2) - * [Patch Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#patch-document-command-2) - * [Delete Document Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-document-command-2) - * [Delete by Prefix Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-by-prefix-command-2) - * [Put Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#put-attachment-command-2) - * [Delete Attachment Command](../../../client-api/rest-api/document-commands/batch-commands.mdx#delete-attachment-command-2) + * [Put Document Command](#put-document-command-2) + * [Patch Document Command](#patch-document-command-2) + * [Delete Document Command](#delete-document-command-2) + * [Delete by Prefix Command](#delete-by-prefix-command-2) + * [Put Attachment Command](#put-attachment-command-2) + * [Delete Attachment Command](#delete-attachment-command-2) ### Put Document Command Request: diff --git a/versioned_docs/version-7.1/client-api/rest-api/document-commands/delete-document.mdx b/versioned_docs/version-7.1/client-api/rest-api/document-commands/delete-document.mdx index 5fc0f8f445..cfd51578c6 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/document-commands/delete-document.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/document-commands/delete-document.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//docs?id=` * In this page: - * [Example](../../../client-api/rest-api/document-commands/delete-document.mdx#example) - * [Request Format](../../../client-api/rest-api/document-commands/delete-document.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/delete-document.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-all-documents.mdx b/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-all-documents.mdx index 3fe7b6375b..2c3b05df73 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-all-documents.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-all-documents.mdx @@ -20,13 +20,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query parameters can be used to page the results. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-all-documents.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-all-documents.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-all-documents.mdx#response-format) - * [Query Parameter Examples](../../../client-api/rest-api/document-commands/get-all-documents.mdx#query-parameter-examples) - * [start](../../../client-api/rest-api/document-commands/get-all-documents.mdx#start) - * [pageSize](../../../client-api/rest-api/document-commands/get-all-documents.mdx#pagesize) - * [metadataOnly](../../../client-api/rest-api/document-commands/get-all-documents.mdx#metadataonly) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [Query Parameter Examples](#query-parameter-examples) + * [start](#start) + * [pageSize](#pagesize) + * [metadataOnly](#metadataonly) ## Basic Example @@ -189,9 +189,9 @@ Linebreaks are added for clarity. In this section: -* [start](../../../client-api/rest-api/document-commands/get-all-documents.mdx#start) -* [pageSize](../../../client-api/rest-api/document-commands/get-all-documents.mdx#pagesize) -* [metadataOnly](../../../client-api/rest-api/document-commands/get-all-documents.mdx#metadataonly) +* [start](#start) +* [pageSize](#pagesize) +* [metadataOnly](#metadataonly) ### start Skip first 1,057 documents, and retrieve the rest (our version of Northwind contains 1,059 documents). diff --git a/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-id.mdx b/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-id.mdx index 6e4b690b16..ad2ed729ed 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-id.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-id.mdx @@ -21,14 +21,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; [counters](../../../document-extensions/counters/overview.mdx). * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#more-examples) - * [Get Multiple Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-multiple-documents) - * [Get Related Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-related-documents) - * [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-metadata-only) - * [Get Document Counters](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-counters) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) + * [Get Multiple Documents](#get-multiple-documents) + * [Get Related Documents](#get-related-documents) + * [Get Document Metadata Only](#get-document-metadata-only) + * [Get Document Counters](#get-document-counters) ## Basic Example @@ -187,10 +187,10 @@ Linebreaks are added for clarity. In this section: -* [Get Multiple Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-multiple-documents) -* [Get Related Documents](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-related-documents) -* [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-metadata-only) -* [Get Document Counters](../../../client-api/rest-api/document-commands/get-documents-by-id.mdx#get-document-counters) +* [Get Multiple Documents](#get-multiple-documents) +* [Get Related Documents](#get-related-documents) +* [Get Document Metadata Only](#get-document-metadata-only) +* [Get Document Counters](#get-document-counters) ### Get Multiple Documents Example cURL request: diff --git a/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-prefix.mdx b/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-prefix.mdx index bf5dd875ac..078bb7b7d5 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-prefix.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/document-commands/get-documents-by-prefix.mdx @@ -20,15 +20,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query parameters can be used to filter and page the results. * In this page: - * [Basic Example](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#request-format) - * [Response Format](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#response-format) - * [More Examples](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#more-examples) - * [Get Using `matches`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using) - * [Get Using `matches` and `exclude`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-usingand) - * [Get Using `startAfter`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using-1) - * [Page Results](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#page-results) - * [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-document-metadata-only) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) + * [Get Using `matches`](#get-using) + * [Get Using `matches` and `exclude`](#get-usingand) + * [Get Using `startAfter`](#get-using-1) + * [Page Results](#page-results) + * [Get Document Metadata Only](#get-document-metadata-only) ## Basic Example @@ -191,11 +191,11 @@ Linebreaks are added for clarity. In this section: -* [Get Using `matches`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using) -* [Get Using `matches` and `exclude`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-usingand) -* [Get Using `startAfter`](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-using-1) -* [Page Results](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#page-results) -* [Get Document Metadata Only](../../../client-api/rest-api/document-commands/get-documents-by-prefix.mdx#get-document-metadata-only) +* [Get Using `matches`](#get-using) +* [Get Using `matches` and `exclude`](#get-usingand) +* [Get Using `startAfter`](#get-using-1) +* [Page Results](#page-results) +* [Get Document Metadata Only](#get-document-metadata-only) ### Get Using `matches` cURL request: diff --git a/versioned_docs/version-7.1/client-api/rest-api/document-commands/put-documents.mdx b/versioned_docs/version-7.1/client-api/rest-api/document-commands/put-documents.mdx index 800516c5b6..e6514113a4 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/document-commands/put-documents.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/document-commands/put-documents.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//docs` * In this page: - * [Examples](../../../client-api/rest-api/document-commands/put-documents.mdx#examples) - * [Request Format](../../../client-api/rest-api/document-commands/put-documents.mdx#request-format) - * [Request Body](../../../client-api/rest-api/document-commands/put-documents.mdx#request-body) - * [Response Format](../../../client-api/rest-api/document-commands/put-documents.mdx#response-format) + * [Examples](#examples) + * [Request Format](#request-format) + * [Request Body](#request-body) + * [Response Format](#response-format) ## Examples diff --git a/versioned_docs/version-7.1/client-api/rest-api/queries/delete-by-query.mdx b/versioned_docs/version-7.1/client-api/rest-api/queries/delete-by-query.mdx index b7f1d79122..0e63a04d71 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/queries/delete-by-query.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/queries/delete-by-query.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; `/databases//queries` * In this page: - * [Example](../../../client-api/rest-api/queries/delete-by-query.mdx#example) - * [Request Format](../../../client-api/rest-api/queries/delete-by-query.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/delete-by-query.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/versioned_docs/version-7.1/client-api/rest-api/queries/patch-by-query.mdx b/versioned_docs/version-7.1/client-api/rest-api/queries/patch-by-query.mdx index a6e29d4fac..8f3c8607e3 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/queries/patch-by-query.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/queries/patch-by-query.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Patching](../../../client-api/operations/patching/set-based.mdx) occurs on the server side. * In this page: - * [Example](../../../client-api/rest-api/queries/patch-by-query.mdx#example) - * [Request Format](../../../client-api/rest-api/queries/patch-by-query.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/patch-by-query.mdx#response-format) + * [Example](#example) + * [Request Format](#request-format) + * [Response Format](#response-format) ## Example diff --git a/versioned_docs/version-7.1/client-api/rest-api/queries/query-the-database.mdx b/versioned_docs/version-7.1/client-api/rest-api/queries/query-the-database.mdx index fe9be7e8db..ba36c13406 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/queries/query-the-database.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/queries/query-the-database.mdx @@ -20,10 +20,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Queries are written in [RQL](../../../client-api/session/querying/what-is-rql.mdx), our user friendly SQL-like query language. * In this page: - * [Basic Example](../../../client-api/rest-api/queries/query-the-database.mdx#basic-example) - * [Request Format](../../../client-api/rest-api/queries/query-the-database.mdx#request-format) - * [Response Format](../../../client-api/rest-api/queries/query-the-database.mdx#response-format) - * [More Examples](../../../client-api/rest-api/queries/query-the-database.mdx#more-examples) + * [Basic Example](#basic-example) + * [Request Format](#request-format) + * [Response Format](#response-format) + * [More Examples](#more-examples) ## Basic Example @@ -237,7 +237,7 @@ you will probably need to escape all double quotes within the request body using | **IsStale** | Whether the results are [stale](../../../indexes/stale-indexes.mdx) | | **ResultEtag** | A hash of type `long` representing the results. When making another request identical to this one, this value can be sent in the `If-None-Match` header to check whether the results have been modified since this response. If not, the results will be retrieved from a local cache instead of from the server. | | **NodeTag** | The tag of the Cluster Node that responded to the query. Values are `A` to `Z`. See [Cluster Topology](../../../server/clustering/rachis/cluster-topology.mdx). | -| **Timings** | If [requested](../../../client-api/session/querying/debugging/query-timings.mdx), the duration of the query operation and each of its sub-stages. See the structure of the [`Timings` object](../../../client-api/rest-api/queries/query-the-database.mdx#the--object) and the [timings example](../../../client-api/rest-api/queries/query-the-database.mdx#get-timing-details) below. | +| **Timings** | If [requested](../../../client-api/session/querying/debugging/query-timings.mdx), the duration of the query operation and each of its sub-stages. See the structure of the [`Timings` object](#the--object) and the [timings example](#get-timing-details) below. | #### The `Timings` Object @@ -283,9 +283,9 @@ roughly add up to the duration of the parent stage because `DurationInMs` values In this section: -* [Include Related Documents](../../../client-api/rest-api/queries/query-the-database.mdx#include-related-documents) -* [Page Results](../../../client-api/rest-api/queries/query-the-database.mdx#page-results) -* [Get Timing Details](../../../client-api/rest-api/queries/query-the-database.mdx#get-timing-details) +* [Include Related Documents](#include-related-documents) +* [Page Results](#page-results) +* [Get Timing Details](#get-timing-details) ### Include Related Documents This query tells the server to include a [related document](../../../client-api/how-to/handle-document-relationships.mdx#includes). diff --git a/versioned_docs/version-7.1/client-api/rest-api/rest-api-intro.mdx b/versioned_docs/version-7.1/client-api/rest-api/rest-api-intro.mdx index 3b2cd16106..5bc4cb2fdd 100644 --- a/versioned_docs/version-7.1/client-api/rest-api/rest-api-intro.mdx +++ b/versioned_docs/version-7.1/client-api/rest-api/rest-api-intro.mdx @@ -24,10 +24,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [REST API Tutorial website](https://www.restapitutorial.com/) * In this page: - * [cURL Basics](../../client-api/rest-api/rest-api-intro.mdx#curl-basics) - * [Document Format and Structure](../../client-api/rest-api/rest-api-intro.mdx#document-format-and-structure) - * [Using cURL With HTTPS](../../client-api/rest-api/rest-api-intro.mdx#using-curl-with-https) - * [Common HTTP Status Codes](../../client-api/rest-api/rest-api-intro.mdx#common-http-status-codes) + * [cURL Basics](#curl-basics) + * [Document Format and Structure](#document-format-and-structure) + * [Using cURL With HTTPS](#using-curl-with-https) + * [Common HTTP Status Codes](#common-http-status-codes) ## cURL Basics diff --git a/versioned_docs/version-7.1/client-api/security/content/_deserialization-security-csharp.mdx b/versioned_docs/version-7.1/client-api/security/content/_deserialization-security-csharp.mdx index c58238e8be..8f10cb0ce4 100644 --- a/versioned_docs/version-7.1/client-api/security/content/_deserialization-security-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/security/content/_deserialization-security-csharp.mdx @@ -15,14 +15,14 @@ import ContentFrame from "@site/src/components/ContentFrame"; is forbidden or allowed. * In this article: - * [Securing deserialization](../../../client-api/security/deserialization-security.mdx#securing-deserialization) - * [The deserialization risk](../../../client-api/security/deserialization-security.mdx#the-deserialization-risk) - * [Direct vs. indirect gadget loading](../../../client-api/security/deserialization-security.mdx#direct-vs-indirect-gadget-loading) - * [DefaultRavenSerializationBinder](../../../client-api/security/deserialization-security.mdx#defaultravenserializationbinder) - * [RegisterForbiddenNamespace](../../../client-api/security/deserialization-security.mdx#registerforbiddennamespace) - * [RegisterForbiddenType](../../../client-api/security/deserialization-security.mdx#registerforbiddentype) - * [RegisterSafeType](../../../client-api/security/deserialization-security.mdx#registersafetype) - * [Example](../../../client-api/security/deserialization-security.mdx#example) + * [Securing deserialization](#securing-deserialization) + * [The deserialization risk](#the-deserialization-risk) + * [Direct vs. indirect gadget loading](#direct-vs-indirect-gadget-loading) + * [DefaultRavenSerializationBinder](#defaultravenserializationbinder) + * [RegisterForbiddenNamespace](#registerforbiddennamespace) + * [RegisterForbiddenType](#registerforbiddentype) + * [RegisterSafeType](#registersafetype) + * [Example](#example) @@ -52,7 +52,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; - `System.Xml.XmlDataDocument` - `System.Management.Automation.PSObject` -* Users can [customize](../../../client-api/security/deserialization-security.mdx#defaultravenserializationbinder) +* Users can [customize](#defaultravenserializationbinder) the list of namespaces and types for which deserialization is forbidden or allowed. @@ -115,7 +115,7 @@ trusted types. Create a new `DefaultRavenSerializationBinder` instance, call the registration methods to define your overrides, then configure the instance as a serialization -convention as shown in the [example](../../../client-api/security/deserialization-security.mdx#example). +convention as shown in the [example](#example). diff --git a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-csharp.mdx b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-csharp.mdx index 96e5ebf3a3..3a1b3fb586 100644 --- a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-csharp.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-nodejs.mdx index 2c07f03196..ef87b077e9 100644 --- a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-nodejs.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-php.mdx b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-php.mdx index adeb6704e2..01473e5a43 100644 --- a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-php.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **Cluster-Wide** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-python.mdx b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-python.mdx index 67cf8d5cd4..f99f334302 100644 --- a/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/cluster-transaction/content/_overview-python.mdx @@ -13,8 +13,8 @@ import CodeBlock from '@theme/CodeBlock'; * **CLUSTER-WIDE** - transaction is registered for execution on all nodes in an atomic fashion * In this page: - * [Open a cluster transaction](../../../../client-api/session/cluster-transaction/overview.mdx#open-a-cluster-transaction) - * [Cluster-wide transaction vs. Single-node transaction](../../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) + * [Open a cluster transaction](#open-a-cluster-transaction) + * [Cluster-wide transaction vs. Single-node transaction](#cluster-wide-transaction-vs-single-node-transaction) ## Open a cluster transaction diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx index 3fa6854ac2..eb8a0aecb5 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) - * [Using 'Include' in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) + * [Using 'Include' in a NoTracking session will throw](#using-) ## Disable tracking changes for a specific entity diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx index 0925884aa0..5ecf54f934 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) - * [Using 'Include' in a NoTracking session will throw](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#using-) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) + * [Using 'Include' in a NoTracking session will throw](#using-) ## Disable tracking changes for a specific entity diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx index c8d3939362..934c521f87 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-php.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) ## Disable tracking changes for a specific entity diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx index db84155333..71fb1799ae 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-disable-tracking-python.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; for a specific entity, for entities returned by a query, for all entities in a session, or globally using conventions. * In this article: - * [Disable tracking changes for a specific entity](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-changes-for-a-specific-entity) - * [Disable tracking all entities in session](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-all-entities-in-session) - * [Disable tracking query results](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#disable-tracking-query-results) - * [Customize tracking in conventions](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#customize-tracking-in-conventions) + * [Disable tracking changes for a specific entity](#disable-tracking-changes-for-a-specific-entity) + * [Disable tracking all entities in session](#disable-tracking-all-entities-in-session) + * [Disable tracking query results](#disable-tracking-query-results) + * [Customize tracking in conventions](#customize-tracking-in-conventions) ## Disable tracking changes for a specific entity @@ -120,7 +120,7 @@ session.save_changes() * You can further customize and fine-tune which entities will not be tracked by configuring the `should_ignore_entity_changes` convention method on the document store. * This customization rule will apply to all sessions opened for this document store. -* Implement rules under your [ShouldIgnoreEntityChanges](../../../../client-api/session/configuration/how-to-disable-tracking.mdx#syntax) subclass. +* Implement rules under your [ShouldIgnoreEntityChanges](#syntax) subclass. Apply the class's `check` method to control the ignore flow. **Example**: diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx index 63ca8c90a4..ed45e17156 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-csharp.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx index 11fd121412..718367eed4 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-nodejs.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx index 1d1629bf3e..41acae09a9 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-php.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx index 672387bb93..6df246bba5 100644 --- a/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/configuration/content/_how-to-enable-optimistic-concurrency-python.mdx @@ -23,8 +23,8 @@ import CodeBlock from '@theme/CodeBlock'; in a way that is suitable in a given scenario. * In this page: - * [Enable for specific session](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-session) - * [Enable globally](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-globally) + * [Enable for specific session](#enable-for-specific-session) + * [Enable globally](#enable-globally) * [Disable for specific document (when enabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#disable-for-specific-document-(when-enabled-on-session)) * [Enable for specific document (when disabled on session)](../../../../client-api/session/configuration/how-to-enable-optimistic-concurrency.mdx#enable-for-specific-document-(when-disabled-on-session)) diff --git a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-csharp.mdx b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-csharp.mdx index a42323f740..2f86d81fd1 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-csharp.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [Load](../../../client-api/session/loading-entities.mdx#load) - - [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) - - [Stream](../../../client-api/session/loading-entities.mdx#stream) - - [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) + - [Load](#load) + - [Load with Includes](#load-with-includes) + - [Load - multiple entities](#load---multiple-entities) + - [LoadStartingWith](#loadstartingwith) + - [ConditionalLoad](#conditionalload) + - [Stream](#stream) + - [IsLoaded](#isloaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-java.mdx b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-java.mdx index 95ebeba1f7..2c8ba5337d 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-java.mdx @@ -9,13 +9,13 @@ There are several methods with many overloads that allow users to download docum from the database and convert them to entities. This article will cover the following methods: -- [Load](../../../client-api/session/loading-entities.mdx#load) -- [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) -- [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) -- [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) -- [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) -- [Stream](../../../client-api/session/loading-entities.mdx#stream) -- [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) +- [Load](#load) +- [Load with Includes](#load-with-includes) +- [Load - multiple entities](#load---multiple-entities) +- [LoadStartingWith](#loadstartingwith) +- [ConditionalLoad](#conditionalload) +- [Stream](#stream) +- [IsLoaded](#isloaded) ## Load diff --git a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-nodejs.mdx index 4165150126..e8b6ae1c1f 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-nodejs.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [Load](../../../client-api/session/loading-entities.mdx#load) - - [Load with Includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [Load - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [LoadStartingWith](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [ConditionalLoad](../../../client-api/session/loading-entities.mdx#conditionalload) - - [IsLoaded](../../../client-api/session/loading-entities.mdx#isloaded) - - [Stream](../../../client-api/session/loading-entities.mdx#stream) + - [Load](#load) + - [Load with Includes](#load-with-includes) + - [Load - multiple entities](#load---multiple-entities) + - [LoadStartingWith](#loadstartingwith) + - [ConditionalLoad](#conditionalload) + - [IsLoaded](#isloaded) + - [Stream](#stream) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-php.mdx b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-php.mdx index 2b9604d565..c2bf11f496 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-php.mdx @@ -9,12 +9,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [`load`](../../../client-api/session/loading-entities.mdx#load) - - [`load` with `include`](../../../client-api/session/loading-entities.mdx#load-with-include) - - [`load` - multiple entities](../../../client-api/session/loading-entities.mdx#load---multiple-entities) - - [`loadStartingWith`](../../../client-api/session/loading-entities.mdx#loadstartingwith) - - [`conditionalLoad`](../../../client-api/session/loading-entities.mdx#conditionalload) - - [`isLoaded`](../../../client-api/session/loading-entities.mdx#isloaded) + - [`load`](#load) + - [`load` with `include`](#load-with-include) + - [`load` - multiple entities](#load---multiple-entities) + - [`loadStartingWith`](#loadstartingwith) + - [`conditionalLoad`](#conditionalload) + - [`isLoaded`](#isloaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-python.mdx b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-python.mdx index a35e62694d..71dad500c8 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_loading-entities-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_loading-entities-python.mdx @@ -9,13 +9,13 @@ import CodeBlock from '@theme/CodeBlock'; * This article covers the following methods: - - [load](../../../client-api/session/loading-entities.mdx#load) - - [load with includes](../../../client-api/session/loading-entities.mdx#load-with-includes) - - [load_starting_with](../../../client-api/session/loading-entities.mdx#load_starting_with) - - [load_starting_with_into_stream](../../../client-api/session/loading-entities.mdx#load_starting_with_into_stream) - - [conditional_load](../../../client-api/session/loading-entities.mdx#conditional_load) - - [stream](../../../client-api/session/loading-entities.mdx#stream) - - [is_loaded](../../../client-api/session/loading-entities.mdx#is_loaded) + - [load](#load) + - [load with includes](#load-with-includes) + - [load_starting_with](#load_starting_with) + - [load_starting_with_into_stream](#load_starting_with_into_stream) + - [conditional_load](#conditional_load) + - [stream](#stream) + - [is_loaded](#is_loaded) * For loading entities lazily see [perform requests lazily](../../../client-api/session/how-to/perform-operations-lazily.mdx). diff --git a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-csharp.mdx b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-csharp.mdx index 7bd2c8bf84..1aba2fcccd 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; * Be sure to wrap the Session variable with a 'using' statement to ensure proper disposal. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -58,7 +58,7 @@ IAsyncDocumentSession OpenAsyncSession(SessionOptions options); | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `string` | The Session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------------------------|-------------------------------| diff --git a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-nodejs.mdx index 7e9558b021..abfdc51aaa 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; Refer to the specific documentation for each method usage. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -38,7 +38,7 @@ openSession(sessionOptions); | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | string | The session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with session configuration options. See details [below](#session-options). | | Return Value | Description | |---------------------|--------------------------------| diff --git a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-php.mdx b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-php.mdx index febd875910..6c39e3fb8d 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-php.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; If no database is specified in the options then the [Default Database](../../../client-api/setting-up-default-database.mdx) (stored in the Document Store) is assumed. * Make sure you release allocated session resources using the `close` method or wrapping - the session object in a `try` statement ([see below](../../../client-api/session/opening-a-session.mdx#example-3---releasing-session-resources)). + the session object in a `try` statement ([see below](#example-3---releasing-session-resources)). * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session examples](../../../client-api/session/opening-a-session.mdx#open-session-examples) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session examples](#open-session-examples) ## Syntax @@ -41,7 +41,7 @@ public function openSession(SessionOptions $sessionOptions): DocumentSessionInte | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `string` | The Session will operate on this database,
overriding the default database set in the document store. | -| **options** | `sessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `sessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------|----------------------------| diff --git a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-python.mdx b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-python.mdx index 3ec2cf2384..60da6443be 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_opening-a-session-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * Be sure to wrap the session variable using a 'with' statement to ensure proper disposal. * In this page: - * [Syntax](../../../client-api/session/opening-a-session.mdx#syntax) - * [Session options](../../../client-api/session/opening-a-session.mdx#session-options) - * [Open session example](../../../client-api/session/opening-a-session.mdx#open-session-example) + * [Syntax](#syntax) + * [Session options](#session-options) + * [Open session example](#open-session-example) ## Syntax @@ -38,7 +38,7 @@ def open_session( | Parameter | Type | Description | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------| | **database** | `str` | The session will operate on this database,
overriding the default database set in the document store. | -| **options** | `SessionOptions` | An object with Session configuration options. See details [below](../../../client-api/session/opening-a-session.mdx#session-options). | +| **options** | `SessionOptions` | An object with Session configuration options. See details [below](#session-options). | | Return Value | Description | |----------------------------------------------|-------------------------------| diff --git a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-csharp.mdx b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-csharp.mdx index 273571a4ea..33414f1831 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-csharp.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-nodejs.mdx index 0bc85e3d35..096237d59a 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-nodejs.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-php.mdx b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-php.mdx index 690e396fab..ab165855fc 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-php.mdx @@ -20,8 +20,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-python.mdx b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-python.mdx index 131b8dfdc4..2b3aa06954 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_updating-entities-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_updating-entities-python.mdx @@ -19,8 +19,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Load a document & update](../../../client-api/session/updating-entities.mdx#load-a-document--update) - * [Query for documents & update](../../../client-api/session/updating-entities.mdx#query-for-documents--update) + * [Load a document & update](#load-a-document--update) + * [Query for documents & update](#query-for-documents--update) ## Load a document & update diff --git a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx index 71ebc14bf2..ab08ab218d 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-csharp.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx index cf51d7a180..3d707460a3 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-java.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx index 14f8dd9c0a..589fed0073 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-nodejs.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx index 1ba1be86b7..eac5d534c7 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-php.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx index 6cc0531f18..d75eef2df2 100644 --- a/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/content/_what-is-a-session-and-how-does-it-work-python.mdx @@ -9,18 +9,18 @@ import CodeBlock from '@theme/CodeBlock'; is the primary interface your application will interact with. * In this page: - * [Session overview](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#session-overview) - * [Unit of work pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#unit-of-work-pattern) - * [Tracking changes](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#tracking-changes) - * [Create document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#create-document-example) - * [Modify document example](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#modify-document-example) - * [Identity map pattern](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#identity-map-pattern) - * [Batching & Transactions](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#batching--transactions) - * [Concurrency control](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#concurrency-control) + * [Session overview](#session-overview) + * [Unit of work pattern](#unit-of-work-pattern) + * [Tracking changes](#tracking-changes) + * [Create document example](#create-document-example) + * [Modify document example](#modify-document-example) + * [Identity map pattern](#identity-map-pattern) + * [Batching & Transactions](#batching--transactions) + * [Concurrency control](#concurrency-control) * [Reducing server calls (best practices) for:](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#reducing-server-calls-(best-practices)-for:) - * [The N+1 problem](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#the-select-n1-problem) - * [Large query results](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#large-query-results) - * [Retrieving results on demand (Lazy)](../../../client-api/session/what-is-a-session-and-how-does-it-work.mdx#retrieving-results-on-demand-lazy) + * [The N+1 problem](#the-select-n1-problem) + * [Large query results](#large-query-results) + * [Retrieving results on demand (Lazy)](#retrieving-results-on-demand-lazy) ## Session overview diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx index 1d2fdc9a35..14639ac3b6 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx index 6fcaa38c65..b1ff90dc63 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-java.mdx @@ -12,8 +12,8 @@ operations. from the server, and it does not cause the session to track the document. * In this page: - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) - * [Example](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#example) + * [Syntax](#syntax) + * [Example](#example) ## Syntax diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx index b49bb903ca..12ca96c51c 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx index 243e5326b6..f08e27c686 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-php.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document or the attachment to the session, and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx index 001acc290d..b5b57e65f8 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-attachment-exists-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document or the attachment to the session, and the session will not track them. * In this page: - * [Check if attachment exists](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#check-if-attachment-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-attachment-exists.mdx#syntax) + * [Check if attachment exists](#check-if-attachment-exists) + * [Syntax](#syntax) ## Check if attachment exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx index f33892d369..83617e9a73 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-java.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-java.mdx index a69c605d03..72044a1f0d 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-java.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * This does not [load](../../../../client-api/session/loading-entities.mdx) the document from the server or cause the session to track it. * In this page: - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) - * [Example](../../../../client-api/session/how-to/check-if-document-exists.mdx#example) + * [Syntax](#syntax) + * [Example](#example) ## Syntax diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx index 63ca8a5abf..2684b10001 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-php.mdx index a5ccc2944b..4bfb1279c7 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-php.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document entity to the session, and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-python.mdx index daf2cca619..c0b40978bf 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-document-exists-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; the document entity to the session, and the session will not track it. * In this page: - * [Check if document exists](../../../../client-api/session/how-to/check-if-document-exists.mdx#check-if-document-exists) - * [Syntax](../../../../client-api/session/how-to/check-if-document-exists.mdx#syntax) + * [Check if document exists](#check-if-document-exists) + * [Syntax](#syntax) ## Check if document exists diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx index ecde7a2667..6842390fad 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-csharp.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx index ce1ce8b0b4..9924dfd784 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-nodejs.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx index 7d03bc04ae..3d1a89d402 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes on all tracked entities, see [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx index 4e957b7fad..2a68ef132d 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-entity-has-changed-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes to **all** tracked entities, see [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx). * In this page: - * [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#check-for-entity-changes) - * [Get entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#get-entity-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx#syntax) + * [Check for entity changes](#check-for-entity-changes) + * [Get entity changes](#get-entity-changes) + * [Syntax](#syntax) ## Check for entity changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx index e949c38a74..1a83e39801 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx index 7241697279..453dcd5c91 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * To get the list of all entities tracked by the session, see [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx index a75bf55fec..2a0f051e1c 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes on a specific **entity**, see [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx index 9eb9e1ee14..093e3e94ca 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_check-if-there-are-any-changes-on-a-session-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; To check for changes to a specific **entity**, see [Check for entity changes](../../../../client-api/session/how-to/check-if-entity-has-changed.mdx). * In this page: - * [Check for session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#check-for-session-changes) - * [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes) - * [Syntax](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#syntax) + * [Check for session changes](#check-for-session-changes) + * [Get session changes](#get-session-changes) + * [Syntax](#syntax) ## Check for session changes diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-csharp.mdx index 2e7ee57764..5924ce12f4 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * To remove only a **single entity** from tracking, see [Evict a single entity](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx). * In this article: - * [Clear the session's state](../../../../client-api/session/how-to/clear-a-session.mdx#clear-the-sessions-state) - * [Syntax](../../../../client-api/session/how-to/clear-a-session.mdx#syntax) + * [Clear the session's state](#clear-the-sessions-state) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-nodejs.mdx index 464c6e53ff..4e587e5706 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_clear-a-session-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * To remove only a **single entity** from tracking, see [Evict a single entity](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx). * In this article: - * [Clear the session's state](../../../../client-api/session/how-to/clear-a-session.mdx#clear-the-sessions-state) - * [Syntax](../../../../client-api/session/how-to/clear-a-session.mdx#syntax) + * [Clear the session's state](#clear-the-sessions-state) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-csharp.mdx index 9229817f2a..81ef9747f4 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are __executed as part of the session's SaveChanges transaction__. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-nodejs.mdx index 70a1a0963d..bd58180f8a 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are __executed as part of the session's saveChanges transaction__. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-php.mdx index 70997e97f5..16599c75d7 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are **executed as part of the session's `saveChanges` transaction**. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-python.mdx index 5810a03d23..2b53557d01 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_defer-operations-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; Thus, all deferred commands are **executed as part of the session's `save_changes` transaction**. * In this page: - * [Defer commands example](../../../../client-api/session/how-to/defer-operations.mdx#defer-commands-example) - * [Commands that can be deferred](../../../../client-api/session/how-to/defer-operations.mdx#commands-that-can-be-deferred) - * [Syntax](../../../../client-api/session/how-to/defer-operations.mdx#syntax) + * [Defer commands example](#defer-commands-example) + * [Commands that can be deferred](#commands-that-can-be-deferred) + * [Syntax](#syntax) ## Defer commands example diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx index 2e18238d01..520620848e 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-csharp.mdx @@ -17,11 +17,11 @@ import CodeBlock from '@theme/CodeBlock'; To prevent an entity from being tracked, see [DisableTracking](../../../../client-api/session/configuration/how-to-disable-tracking.mdx). * In this article: - * [Evict an entity before saving](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-before-saving) - * [Evict an entity to force reload from server](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-to-force-reload-from-server) - * [Evict an entity from the session's delete queue](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-from-the-sessions-delete-queue) - * [Limitations](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#limitations) - * [Syntax](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#syntax) + * [Evict an entity before saving](#evict-an-entity-before-saving) + * [Evict an entity to force reload from server](#evict-an-entity-to-force-reload-from-server) + * [Evict an entity from the session's delete queue](#evict-an-entity-from-the-sessions-delete-queue) + * [Limitations](#limitations) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx index 9e73f3bd99..30f9b4b3b8 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_evict-entity-from-a-session-nodejs.mdx @@ -17,11 +17,11 @@ import CodeBlock from '@theme/CodeBlock'; To prevent an entity from being tracked, see [DisableTracking](../../../../client-api/session/configuration/how-to-disable-tracking.mdx). * In this article: - * [Evict an entity before saving](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-before-saving) - * [Evict an entity to force reload from server](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-to-force-reload-from-server) - * [Evict an entity from the session's delete queue](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#evict-an-entity-from-the-sessions-delete-queue) - * [Limitations](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#limitations) - * [Syntax](../../../../client-api/session/how-to/evict-entity-from-a-session.mdx#syntax) + * [Evict an entity before saving](#evict-an-entity-before-saving) + * [Evict an entity to force reload from server](#evict-an-entity-to-force-reload-from-server) + * [Evict an entity from the session's delete queue](#evict-an-entity-from-the-sessions-delete-queue) + * [Limitations](#limitations) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-csharp.mdx index 9af6bc0334..3b75188557 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; The counter names are available for each entity using the `GetCountersFor()` method from the `Advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx index 9738d3119d..70e6455d78 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; The counter names are available for each entity using the `getCountersFor()` method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-php.mdx index 9cc3089246..358febe537 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-php.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-python.mdx index f6466a011f..8d5ce95f97 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-entity-counters-python.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; method from the `advanced` session operations. * In this page: - * [Get entity counters](../../../../client-api/session/how-to/get-entity-counters.mdx#get-entity-counters) - * [Syntax](../../../../client-api/session/how-to/get-entity-counters.mdx#syntax) + * [Get entity counters](#get-entity-counters) + * [Syntax](#syntax) ## Get entity counters diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx index 3df1d61e83..34d6d5b7aa 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-csharp.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes). * In this page: - * [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx#get-tracked-entities) - * [Syntax](../../../../client-api/session/how-to/get-tracked-entities.mdx#syntax) + * [Get tracked entities](#get-tracked-entities) + * [Syntax](#syntax) ## Get tracked entities diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx index a1441b1309..169e1347c7 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_get-tracked-entities-nodejs.mdx @@ -17,8 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; [Get session changes](../../../../client-api/session/how-to/check-if-there-are-any-changes-on-a-session.mdx#get-session-changes). * In this page: - * [Get tracked entities](../../../../client-api/session/how-to/get-tracked-entities.mdx#get-tracked-entities) - * [Syntax](../../../../client-api/session/how-to/get-tracked-entities.mdx#syntax) + * [Get tracked entities](#get-tracked-entities) + * [Syntax](#syntax) ## Get tracked entities diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx index 753b055695..c672be0a58 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-csharp.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx index 2e70534a58..7806e36d92 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-nodejs.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily:](../../../../client-api/session/how-to/perform-operations-lazily.mdx#requests-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadentities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadwithinclude) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#loadstartingwith) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditionalload) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#runquery) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#getcompareexchange) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#implicit) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#explicit) + * [Requests that can be executed lazily:](#requests-that-can-be-executed-lazily) + * [Load entities](#loadentities) + * [Load entities with include](#loadwithinclude) + * [Load entities starting with](#loadstartingwith) + * [Conditional load](#conditionalload) + * [Run query](#runquery) + * [Get revisions](#getrevisions) + * [Get compare-exchange value](#getcompareexchange) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#implicit) + * [Execute all requests - explicitly](#explicit) ## Operations that can be executed lazily diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-php.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-php.mdx index b05433dee0..97955a4976 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-php.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-python.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-python.mdx index 7e299c1887..bb68bfc531 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_perform-operations-lazily-python.mdx @@ -22,17 +22,17 @@ import CodeBlock from '@theme/CodeBlock'; This can help reduce the number of remote calls made to the server over the network. * In this page: - * [Requests that can be executed lazily](../../../../client-api/session/how-to/perform-operations-lazily.mdx#operations-that-can-be-executed-lazily) - * [Load entities](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities) - * [Load entities with include](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-with-include) - * [Load entities starting with](../../../../client-api/session/how-to/perform-operations-lazily.mdx#load-entities-starting-with) - * [Conditional load](../../../../client-api/session/how-to/perform-operations-lazily.mdx#conditional-load) - * [Run query](../../../../client-api/session/how-to/perform-operations-lazily.mdx#run-query) - * [Get revisions](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-revisions) - * [Get compare-exchange value](../../../../client-api/session/how-to/perform-operations-lazily.mdx#get-compare-exchange-value) - * [Multiple lazy requests](../../../../client-api/session/how-to/perform-operations-lazily.mdx#multiple-lazy-requests) - * [Execute all requests - implicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---implicitly) - * [Execute all requests - explicitly](../../../../client-api/session/how-to/perform-operations-lazily.mdx#execute-all-requests---explicitly) + * [Requests that can be executed lazily](#operations-that-can-be-executed-lazily) + * [Load entities](#load-entities) + * [Load entities with include](#load-entities-with-include) + * [Load entities starting with](#load-entities-starting-with) + * [Conditional load](#conditional-load) + * [Run query](#run-query) + * [Get revisions](#get-revisions) + * [Get compare-exchange value](#get-compare-exchange-value) + * [Multiple lazy requests](#multiple-lazy-requests) + * [Execute all requests - implicitly](#execute-all-requests---implicitly) + * [Execute all requests - explicitly](#execute-all-requests---explicitly) ## Operations that can be executed lazily diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx index 2dc6c754ed..9fdda9722d 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-csharp.mdx @@ -19,18 +19,18 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [OnBeforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforestore) - * [OnBeforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforedelete) - * [OnAfterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#onaftersavechanges) - * [OnBeforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforequery) - * [OnBeforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforeconversiontodocument) - * [OnAfterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#onafterconversiontodocument) - * [OnBeforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#onbeforeconversiontoentity) - * [OnAfterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#onafterconversiontoentity) - * [OnSessionDisposing](../../../../client-api/session/how-to/subscribe-to-events.mdx#onsessiondisposing) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [OnBeforeStore](#onbeforestore) + * [OnBeforeDelete](#onbeforedelete) + * [OnAfterSaveChanges](#onaftersavechanges) + * [OnBeforeQuery](#onbeforequery) + * [OnBeforeConversionToDocument](#onbeforeconversiontodocument) + * [OnAfterConversionToDocument](#onafterconversiontodocument) + * [OnBeforeConversionToEntity](#onbeforeconversiontoentity) + * [OnAfterConversionToEntity](#onafterconversiontoentity) + * [OnSessionDisposing](#onsessiondisposing) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-java.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-java.mdx index 3f87a301f7..0c96db83fb 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-java.mdx @@ -20,17 +20,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [beforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforestore) - * [beforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforedelete) - * [afterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#aftersavechanges) - * [beforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforequery) - * [beforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontodocument) - * [afterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontodocument) - * [beforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontoentity) - * [afterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontoentity) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [beforeStore](#beforestore) + * [beforeDelete](#beforedelete) + * [afterSaveChanges](#aftersavechanges) + * [beforeQuery](#beforequery) + * [beforeConversionToDocument](#beforeconversiontodocument) + * [afterConversionToDocument](#afterconversiontodocument) + * [beforeConversionToEntity](#beforeconversiontoentity) + * [afterConversionToEntity](#afterconversiontoentity) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx index 952ab70fa8..49883a3e6f 100644 --- a/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/how-to/content/_subscribe-to-events-nodejs.mdx @@ -20,17 +20,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; Read more about store events [here](../../../../client-api/how-to/subscribe-to-store-events.mdx). * In this article: - * [Session events](../../../../client-api/session/how-to/subscribe-to-events.mdx#session-events) - * [beforeStore](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforestore) - * [beforeDelete](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforedelete) - * [afterSaveChanges](../../../../client-api/session/how-to/subscribe-to-events.mdx#aftersavechanges) - * [beforeQuery](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforequery) - * [beforeConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontodocument) - * [afterConversionToDocument](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontodocument) - * [beforeConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#beforeconversiontoentity) - * [afterConversionToEntity](../../../../client-api/session/how-to/subscribe-to-events.mdx#afterconversiontoentity) - * [Unsubscribing from an event](../../../../client-api/session/how-to/subscribe-to-events.mdx#unsubscribing-from-an-event) - * [Syntax](../../../../client-api/session/how-to/subscribe-to-events.mdx#syntax) + * [Session events](#session-events) + * [beforeStore](#beforestore) + * [beforeDelete](#beforedelete) + * [afterSaveChanges](#aftersavechanges) + * [beforeQuery](#beforequery) + * [beforeConversionToDocument](#beforeconversiontodocument) + * [afterConversionToDocument](#afterconversiontodocument) + * [beforeConversionToEntity](#beforeconversiontoentity) + * [afterConversionToEntity](#afterconversiontoentity) + * [Unsubscribing from an event](#unsubscribing-from-an-event) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx index f2faf6fd5d..16348e4aa3 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-csharp.mdx @@ -7,11 +7,11 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [Count](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) + * [Count](#count) - * [LongCount](../../../../client-api/session/querying/how-to-count-query-results.mdx#longcount) + * [LongCount](#longcount) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [Get number of results from query stats](#get-count-from-query-stats) ## Count diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx index 7793fc996c..7e90880b81 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-nodejs.mdx @@ -7,9 +7,9 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [Count](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) + * [Count](#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [Get number of results from query stats](#get-count-from-query-stats) ## Count diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-php.mdx index 330d80edfa..59055d3cc6 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-php.mdx @@ -7,8 +7,8 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [`Count`](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [`Count`](#count) + * [Get number of results from query stats](#get-count-from-query-stats) ## `Count` diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-python.mdx index 9a77265c1b..be71f3c103 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-count-query-results-python.mdx @@ -7,8 +7,8 @@ import CodeBlock from '@theme/CodeBlock'; * The following options are available to **count query results**: - * [`count`](../../../../client-api/session/querying/how-to-count-query-results.mdx#count) - * [Get number of results from query stats](../../../../client-api/session/querying/how-to-count-query-results.mdx#get-count-from-query-stats) + * [`count`](#count) + * [Get number of results from query stats](#get-count-from-query-stats) ## `count` diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-csharp.mdx index 6f72ff4b78..298ce40339 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-csharp.mdx @@ -15,17 +15,17 @@ import CodeBlock from '@theme/CodeBlock'; * Customization methods available: - - [BeforeQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#beforequeryexecuted) - - [AfterQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterqueryexecuted) - - [AfterStreamExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterstreamexecuted) - - [NoCaching](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) - - [NoTracking](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) - - [Projection](../../../../client-api/session/querying/how-to-customize-query.mdx#projection) - - [RandomOrdering](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [Timings](../../../../client-api/session/querying/how-to-customize-query.mdx#timings) - - [WaitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) - -* [Methods return value](../../../../client-api/session/querying/how-to-customize-query.mdx#methods-return-value) + - [BeforeQueryExecuted](#beforequeryexecuted) + - [AfterQueryExecuted](#afterqueryexecuted) + - [AfterStreamExecuted](#afterstreamexecuted) + - [NoCaching](#nocaching) + - [NoTracking](#notracking) + - [Projection](#projection) + - [RandomOrdering](#randomordering) + - [Timings](#timings) + - [WaitForNonStaleResults](#waitfornonstaleresults) + +* [Methods return value](#methods-return-value) diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-java.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-java.mdx index 17f36a07cd..5c9adcde99 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-java.mdx @@ -7,14 +7,14 @@ import CodeBlock from '@theme/CodeBlock'; The following query customization options are available in the `IDocumentQueryCustomization` interface: -- [BeforeQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#beforequeryexecuted) -- [AfterQueryExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterqueryexecuted) -- [AfterStreamExecuted](../../../../client-api/session/querying/how-to-customize-query.mdx#afterstreamexecuted) -- [NoCaching](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) -- [NoTracking](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) -- [ProjectionBehavior](../../../../client-api/session/querying/how-to-customize-query.mdx#projectionbehavior) -- [RandomOrdering](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) -- [WaitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) +- [BeforeQueryExecuted](#beforequeryexecuted) +- [AfterQueryExecuted](#afterqueryexecuted) +- [AfterStreamExecuted](#afterstreamexecuted) +- [NoCaching](#nocaching) +- [NoTracking](#notracking) +- [ProjectionBehavior](#projectionbehavior) +- [RandomOrdering](#randomordering) +- [WaitForNonStaleResults](#waitfornonstaleresults) ## BeforeQueryExecuted diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx index b0846bfd60..37f493767e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-nodejs.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; - [on ("beforeQueryExecuted")](../../../../client-api/session/querying/how-to-customize-query.mdx#on-("beforequeryexecuted")) - [on ("afterQueryExecuted")](../../../../client-api/session/querying/how-to-customize-query.mdx#on-("afterqueryexecuted")) - - [noCaching](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) - - [noTracking](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) - - [projectionBehavior](../../../../client-api/session/querying/how-to-customize-query.mdx#projectionbehavior) - - [randomOrdering](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [timings](../../../../client-api/session/querying/how-to-customize-query.mdx#timings) - - [waitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) + - [noCaching](#nocaching) + - [noTracking](#notracking) + - [projectionBehavior](#projectionbehavior) + - [randomOrdering](#randomordering) + - [timings](#timings) + - [waitForNonStaleResults](#waitfornonstaleresults) ## on (beforeQueryExecuted) diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-php.mdx index 05e3077616..18d4751baf 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-php.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; [subscribing to `OnBeforeQuery`](../../../../client-api/session/how-to/subscribe-to-events.mdx). * Available customization methods : - - [`addBeforeQueryExecutedListener` and `removeBeforeQueryExecutedListener`](../../../../client-api/session/querying/how-to-customize-query.mdx#addbeforequeryexecutedlistener-and-removebeforequeryexecutedlistener) - - [`addAfterQueryExecutedListener` and `removeAfterQueryExecutedListener`](../../../../client-api/session/querying/how-to-customize-query.mdx#addafterqueryexecutedlistener-and-removeafterqueryexecutedlistener) - - [`noCaching`](../../../../client-api/session/querying/how-to-customize-query.mdx#nocaching) - - [`noTracking`](../../../../client-api/session/querying/how-to-customize-query.mdx#notracking) - - [Projection](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [`randomOrdering`](../../../../client-api/session/querying/how-to-customize-query.mdx#randomordering) - - [`waitForNonStaleResults`](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) -* [Methods return value](../../../../client-api/session/querying/how-to-customize-query.mdx#methods-return-value) + - [`addBeforeQueryExecutedListener` and `removeBeforeQueryExecutedListener`](#addbeforequeryexecutedlistener-and-removebeforequeryexecutedlistener) + - [`addAfterQueryExecutedListener` and `removeAfterQueryExecutedListener`](#addafterqueryexecutedlistener-and-removeafterqueryexecutedlistener) + - [`noCaching`](#nocaching) + - [`noTracking`](#notracking) + - [Projection](#randomordering) + - [`randomOrdering`](#randomordering) + - [`waitForNonStaleResults`](#waitfornonstaleresults) +* [Methods return value](#methods-return-value) diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-python.mdx index 59971c84cd..48ffccd90b 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-customize-query-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * Customization methods available: - - [before_query_executed](../../../../client-api/session/querying/how-to-customize-query.mdx#before_query_executed) - - [after_query_executed](../../../../client-api/session/querying/how-to-customize-query.mdx#after_query_executed) - - [after_stream_executed](../../../../client-api/session/querying/how-to-customize-query.mdx#after_stream_executed) - - [no_caching](../../../../client-api/session/querying/how-to-customize-query.mdx#no_caching) - - [no_tracking](../../../../client-api/session/querying/how-to-customize-query.mdx#no_tracking) - - [projection](../../../../client-api/session/querying/how-to-customize-query.mdx#projection) - - [random_ordering](../../../../client-api/session/querying/how-to-customize-query.mdx#random_ordering) - - [timings](../../../../client-api/session/querying/how-to-customize-query.mdx#timings) - - [wait_for_non_stale_results](../../../../client-api/session/querying/how-to-customize-query.mdx#wait_for_non_stale_results) - -* [Methods return value](../../../../client-api/session/querying/how-to-customize-query.mdx#methods-return-value) + - [before_query_executed](#before_query_executed) + - [after_query_executed](#after_query_executed) + - [after_stream_executed](#after_stream_executed) + - [no_caching](#no_caching) + - [no_tracking](#no_tracking) + - [projection](#projection) + - [random_ordering](#random_ordering) + - [timings](#timings) + - [wait_for_non_stale_results](#wait_for_non_stale_results) + +* [Methods return value](#methods-return-value) diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx index 3dd2140f50..0e9fb45f89 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-java.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-java.mdx index b1bab1beae..bc12559544 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-java.mdx @@ -11,8 +11,8 @@ from the [Document Query](../../../../client-api/session/querying/document-query * If a document doesn't contain the specified field, it is excluded from the query results. * In this page: - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) - * [Examples](../../../../client-api/session/querying/how-to-filter-by-field.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx index 984ca5bf62..ee662878cd 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-php.mdx index 84bd60c3ad..c6b6de4cc7 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A document that doesn't contain the specified field will be excluded from the query results. * In this page: - * [Filter by field name](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name) - * [Filter by field path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) + * [Filter by field name](#filter-by-field-name) + * [Filter by field path](#filter-by-field-path) + * [Syntax](#syntax) ## Filter by field name diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-python.mdx index 96eb83dec6..40347fd50e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-field-python.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; Documents that do not contain the specified field will be excluded from the query results. * In this page: - * [Filter by Field Name or Path](../../../../client-api/session/querying/how-to-filter-by-field.mdx#filter-by-field-name-or-path) - * [Syntax](../../../../client-api/session/querying/how-to-filter-by-field.mdx#syntax) - * [Examples](../../../../client-api/session/querying/how-to-filter-by-field.mdx#examples) + * [Filter by Field Name or Path](#filter-by-field-name-or-path) + * [Syntax](#syntax) + * [Examples](#examples) ## Filter by Field Name or Path diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx index 7b2fbf3277..5e12013b83 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-csharp.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx index 19d3be38ef..f7bbd65730 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-nodejs.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx index d9232aad1e..a07adee803 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * There are situations where new fields are added to some documents in a collection over time. * To find documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx index e0978388fe..495d2805c4 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-filter-by-non-existing-field-python.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * To find the documents that are missing the newly added fields you can either: * [Query the collection (dynamic query)](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-the-collection-(dynamic-query)) - * [Query a static index](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#query-a-static-index) - * [Use Studio to Run an RQL Query](../../../../client-api/session/querying/how-to-filter-by-non-existing-field.mdx#use-studio-to-run-an-rql-query) + * [Query a static index](#query-a-static-index) + * [Use Studio to Run an RQL Query](#use-studio-to-run-an-rql-query) ---- diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx index 806d3cfcc5..d61fb1f6a1 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-csharp.mdx @@ -20,8 +20,8 @@ import Panel from '@site/src/components/Panel'; In such cases, the resulting `QueryStatistics` object will remain with its default values. * In this article: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx index d45633a999..31d7888a69 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-nodejs.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx index 655fb415b4..fb36c057dd 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-php.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx index 91f6cb6f9d..aa3a188566 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-get-query-statistics-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; are returned in the `QueryStatistics` object. * In This Page: - * [Get query statistics](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#get-query-statistics) - * [Syntax](../../../../client-api/session/querying/how-to-get-query-statistics.mdx#syntax) + * [Get query statistics](#get-query-statistics) + * [Syntax](#syntax) ## Get query statistics diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx index 1413ec54da..6854efef87 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-csharp.mdx @@ -23,21 +23,21 @@ import CodeBlock from '@theme/CodeBlock'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this page: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`Spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialFieldFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteriaFactory`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`OrderByDistance`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`OrderByDistanceDescending`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`Spatial`](#section) + * [`DynamicSpatialFieldFactory`](#section-1) + * [`SpatialCriteriaFactory`](#section-2) + * [`OrderByDistance`](#section-3) + * [`OrderByDistanceDescending`](#section-4) ## Search by radius diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx index 04e23253f4..32db6d9c6f 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-java.mdx @@ -5,9 +5,9 @@ import CodeBlock from '@theme/CodeBlock'; Spatial indexes can be queried using the `spatial` method which contains a full spectrum of spatial methods. The following article will cover these methods: -- [Spatial](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial) -- [OrderByDistance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistance) -- [OrderByDistanceDescending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistancedescending) +- [Spatial](#spatial) +- [OrderByDistance](#orderbydistance) +- [OrderByDistanceDescending](#orderbydistancedescending) ## Spatial diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx index 3781ae2f63..e29cdec724 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-nodejs.mdx @@ -23,16 +23,16 @@ import CodeBlock from '@theme/CodeBlock'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this page: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistance) - * [Order by distance desc](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#orderbydistancedesc) - * [Rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#roundeddistance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#getresultingdistance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#orderbydistance) + * [Order by distance desc](#orderbydistancedesc) + * [Rounded distance](#roundeddistance) + * [Get resulting distance](#getresultingdistance) + * [Spatial API](#spatial-api) ## Search by radius diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx index ebd26896d4..e1f4275dc4 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-make-a-spatial-query-python.mdx @@ -23,21 +23,21 @@ import CodeBlock from '@theme/CodeBlock'; results are also displayed on the global map. See [spatial queries map view](../../../../studio/database/queries/spatial-queries-map-view.mdx). * In this page: - * [Search by radius](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-radius) - * [Search by shape](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#search-by-shape) - * [Circle](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#circle) - * [Polygon](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#polygon) - * [Spatial sorting](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) - * [Order by distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance) - * [Order by distance descending](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#order-by-distance-descending) - * [Sort results by rounded distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#sort-results-by-rounded-distance) - * [Get resulting distance](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#get-resulting-distance) - * [Spatial API](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api) - * [`spatial`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section) - * [`DynamicSpatialField`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-1) - * [`SpatialCriteria`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-2) - * [`order_by_distance`, `order_by_distance_wkt`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-3) - * [`order_by_distance_descending`, `order_by_distance_descending_wkt`](../../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#section-4) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Circle](#circle) + * [Polygon](#polygon) + * [Spatial sorting](#spatial-sorting) + * [Order by distance](#order-by-distance) + * [Order by distance descending](#order-by-distance-descending) + * [Sort results by rounded distance](#sort-results-by-rounded-distance) + * [Get resulting distance](#get-resulting-distance) + * [Spatial API](#spatial-api) + * [`spatial`](#section) + * [`DynamicSpatialField`](#section-1) + * [`SpatialCriteria`](#section-2) + * [`order_by_distance`, `order_by_distance_wkt`](#section-3) + * [`order_by_distance_descending`, `order_by_distance_descending_wkt`](#section-4) ## Search by radius diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx index d7ed44ad12..9965776c7c 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-group-by-query-python.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; creating auto map-reduce indexes. * In This Page: - * [Group By a Single Field](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-a-single-field) - * [Group By Multiple Fields](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-multiple-fields) - * [Select Composite GroupBy Key](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#select-composite-groupby-key) - * [Group By Array](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#group-by-array) - * [By Array Values](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-values) - * [By Array Content](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-content) - * [Sorting](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#sorting) - * [By Count](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-count) - * [By Sum](../../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-sum) + * [Group By a Single Field](#group-by-a-single-field) + * [Group By Multiple Fields](#group-by-multiple-fields) + * [Select Composite GroupBy Key](#select-composite-groupby-key) + * [Group By Array](#group-by-array) + * [By Array Values](#by-array-values) + * [By Array Content](#by-array-content) + * [Sorting](#sorting) + * [By Count](#by-count) + * [By Sum](#by-sum) ## Group By a Single Field diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx index 4fdf7472f7..34e176d008 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx index 652167ed64..36803a3e72 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx index 8531414868..71868517ff 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-php.mdx @@ -16,11 +16,11 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more about queries in this [query overview](../../../../client-api/session/querying/how-to-query.mdx). * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy Aggregation](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-aggregation) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy Aggregation](#lazy-aggregation) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx index d667aab40e..2ff448a8e0 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-perform-queries-lazily-python.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; executed lazily within a session. * In this page: - * [Lazy query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query) - * [Lazy count query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-count-query) - * [Lazy suggestions query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-suggestions-query) - * [Lazy facets query](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-facets-query) - * [Syntax](../../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#syntax) + * [Lazy query](#lazy-query) + * [Lazy count query](#lazy-count-query) + * [Lazy suggestions query](#lazy-suggestions-query) + * [Lazy facets query](#lazy-facets-query) + * [Syntax](#syntax) ## Lazy query diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx index 9634a10636..b2187c16b3 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; For projecting results when querying a **static-index** see [project index query results](../../../../indexes/querying/projections.mdx). * In this article: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) - * [Select](../../../../client-api/session/querying/how-to-project-query-results.mdx#select) - * [ProjectInto](../../../../client-api/session/querying/how-to-project-query-results.mdx#projectinto) - * [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Projections overview](#projections-overview) + * [Projection Methods](#projection-methods) + * [Select](#select) + * [ProjectInto](#projectinto) + * [SelectFields](#selectfields) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -66,11 +66,11 @@ import CodeBlock from '@theme/CodeBlock'; but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. * Only a single projection request can be made per Query (and DocumentQuery). - Learn more in [single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query). + Learn more in [single projection per query](#single-projection-per-query). **The cost of projections**: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-java.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-java.mdx index 2438925907..80350d8411 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-java.mdx @@ -6,8 +6,8 @@ import CodeBlock from '@theme/CodeBlock'; Instead of pulling full documents in query results you can just grab some pieces of data from documents. You can also transform the projected results. The projections are defined with the usage of: -- [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) -- [OfType](../../../../client-api/session/querying/how-to-project-query-results.mdx#oftype---simple-projection) +- [SelectFields](#selectfields) +- [OfType](#oftype---simple-projection) ## SelectFields diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx index 8aeaff4448..e92ad858f1 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; For projecting results when querying a **static-index** see [project index query results](../../../../indexes/querying/projections.mdx). * In this article: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) - * [SelectFields](../../../../client-api/session/querying/how-to-project-query-results.mdx#selectfields) - * [Projecting nested object types](../../../../client-api/session/querying/how-to-project-query-results.mdx#projecting-nested-object-types) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) - * [Syntax](../../../../client-api/session/querying/how-to-project-query-results.mdx#syntax) + * [Projections overview](#projections-overview) + * [SelectFields](#selectfields) + * [Projecting nested object types](#projecting-nested-object-types) + * [Single projection per query](#single-projection-per-query) + * [Syntax](#syntax) ## Projections overview @@ -30,7 +30,7 @@ import CodeBlock from '@theme/CodeBlock'; * The query can load [related documents](../../../../indexes/indexing-related-documents.mdx#what-are-related-documents) and have their data merged into the projection results. -* Content from inner objects and arrays can be projected in addition to [projecting the nested object types](../../../../client-api/session/querying/how-to-project-query-results.mdx#projecting-nested-object-types). +* Content from inner objects and arrays can be projected in addition to [projecting the nested object types](#projecting-nested-object-types). * An alias name can be given to the projected fields, and any calculations can be applied within the projection. **When to use projections**: @@ -67,7 +67,7 @@ import CodeBlock from '@theme/CodeBlock'; **The cost of projections**: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example-v---projection-with-calculations) + However, you can perform any [calculations](#example-v---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-php.mdx index 433242d4a9..6198deedb9 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-php.mdx @@ -13,13 +13,13 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) + * [Projections overview](#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) + * [Projection Methods](#projection-methods) * [`select`, `selectFields`](../../../../client-api/session/querying/how-to-project-query-results.mdx#select,-selectfields) - * [`ofType`](../../../../client-api/session/querying/how-to-project-query-results.mdx#oftype) + * [`ofType`](#oftype) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -73,12 +73,12 @@ import CodeBlock from '@theme/CodeBlock'; * Within the projection you can only filter what data will be returned from the matching documents, but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. -* Only a [single projection request](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) can be made per query. +* Only a [single projection request](#single-projection-per-query) can be made per query. ### The cost of projections: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-python.mdx index 6cf008121f..96f4fd6a62 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-project-query-results-python.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Projections overview](../../../../client-api/session/querying/how-to-project-query-results.mdx#projections-overview) + * [Projections overview](#projections-overview) - * [Projection Methods](../../../../client-api/session/querying/how-to-project-query-results.mdx#projection-methods) - * [select_fields_query_data](../../../../client-api/session/querying/how-to-project-query-results.mdx#select_fields_query_data) - * [raw_query with `select`](../../../../client-api/session/querying/how-to-project-query-results.mdx#raw_query-with-select) - * [select_fields](../../../../client-api/session/querying/how-to-project-query-results.mdx#select_fields) + * [Projection Methods](#projection-methods) + * [select_fields_query_data](#select_fields_query_data) + * [raw_query with `select`](#raw_query-with-select) + * [select_fields](#select_fields) - * [Single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query) + * [Single projection per query](#single-projection-per-query) ## Projections overview @@ -75,12 +75,12 @@ import CodeBlock from '@theme/CodeBlock'; but you cannot filter which documents will be returned. That has already been determined earlier in the query pipeline. * Only a single projection request can be made per query. - Learn more in [single projection per query](../../../../client-api/session/querying/how-to-project-query-results.mdx#single-projection-per-query). + Learn more in [single projection per query](#single-projection-per-query). ### The cost of projections: * Queries in RavenDB do not allow any computation to occur during the query phase. - However, you can perform any [calculations](../../../../client-api/session/querying/how-to-project-query-results.mdx#example---projection-with-calculations) + However, you can perform any [calculations](#example---projection-with-calculations) * inside the projection. * But while calculations within a projection are allowed, having a very complex logic can impact query performance. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-csharp.mdx index 88fae87a93..83c7f71127 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-csharp.mdx @@ -15,7 +15,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined with `Query` or `DocumentQuery` are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -29,12 +29,12 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [Session.Query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [Session.Advanced.DocumentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) - * [Session.Advanced.RawQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) - * [Custom methods and extensions for LINQ](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [Session.Query](#sessionquery) + * [Session.Advanced.DocumentQuery](#sessionadvanceddocumentquery) + * [Session.Advanced.RawQuery](#sessionadvancedrawquery) + * [Custom methods and extensions for LINQ](#custom-methods-and-extensions-for-linq) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -53,9 +53,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: - 1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) - 2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) - 3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) + 1. [Index query](#indexquery) + 2. [Dynamic query](#dynamicquery) + 3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -107,7 +107,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) and [Counters](../../../../document-extensions/counters/indexing.mdx). @@ -139,7 +139,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -152,7 +152,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -540,7 +540,7 @@ from "Employees" where FirstName = "Robert" ## Session.Advanced.RawQuery -* Queries defined with [Query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) or [DocumentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) +* Queries defined with [Query](#sessionquery) or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `RawQuery` method. @@ -588,7 +588,7 @@ List employees = await asyncSession ## Custom methods and extensions for LINQ -* Available custom methods and extensions for the session's [Query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +* Available custom methods and extensions for the session's [Query](#sessionquery) method: * [AggregateBy](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) * AnyAsync @@ -663,7 +663,7 @@ IRawDocumentQuery RawQuery(string query); | Return Value | | | - | - | -| `IRavenQueryable`
`IDocumentQuery`
`IRawDocumentQuery` | Instances exposing additional query methods and [extensions](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq) | +| `IRavenQueryable`
`IDocumentQuery`
`IRawDocumentQuery` | Instances exposing additional query methods and [extensions](#custom-methods-and-extensions-for-linq) | diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-nodejs.mdx index a6702af9ad..22a50154a3 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-nodejs.mdx @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined with the `query` method are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -27,11 +27,11 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [session.advanced.rawQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) - * [query API](../../../../client-api/session/querying/how-to-query.mdx#query-api) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#sessionquery) + * [session.advanced.rawQuery](#sessionadvancedrawquery) + * [query API](#query-api) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -50,9 +50,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: -1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) -2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) -3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) +1. [Index query](#indexquery) +2. [Dynamic query](#dynamicquery) +3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -104,7 +104,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) and [Counters](../../../../document-extensions/counters/indexing.mdx). @@ -136,7 +136,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -144,7 +144,7 @@ For each scenario, a different index type is used, as described below. ## session.query * The simplest way to issue a query is by using the session's `query` method. - Customize your query with these [API methods](../../../../client-api/session/querying/how-to-query.mdx#query-api). + Customize your query with these [API methods](#query-api). * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. @@ -341,7 +341,7 @@ from "products" limit 5, 10 // skip 5, take 10 ## session.advanced.rawQuery -* Queries defined with [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. +* Queries defined with [query](#sessionquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. @@ -369,7 +369,7 @@ const employees = await session.advanced ## query API -Available methods for the session's [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available methods for the session's [query](#sessionquery) method: - addOrder - addParameter @@ -479,7 +479,7 @@ session.rawQuery(query); | Return Value | | | - | - | -| `object` | Instance implementing `IDocumentQuery` exposing the additional [query methods](../../../../client-api/session/querying/how-to-query.mdx#query-api). | +| `object` | Instance implementing `IDocumentQuery` exposing the additional [query methods](#query-api). | * Note: Use `await` when executing the query, e.g. when calling `.all`, `.single`, `.first`, `.count`, etc. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-php.mdx index 44600ba484..3866a4359f 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-php.mdx @@ -15,7 +15,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined using `query` or `documentQuery` are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All RavenDB queries use an **index** to provide results, even when an index is not explicitly defined. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article shows examples of dynamic queries only. @@ -31,12 +31,12 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [session.advanced.documentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) - * [session.advanced.rawQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) - * [Custom methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#sessionquery) + * [session.advanced.documentQuery](#sessionadvanceddocumentquery) + * [session.advanced.rawQuery](#sessionadvancedrawquery) + * [Custom methods](#custom-methods) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -55,9 +55,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: -1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) -2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) -3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) +1. [Index query](#indexquery) +2. [Dynamic query](#dynamicquery) +3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -109,7 +109,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * RQL Example:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) @@ -142,7 +142,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -155,7 +155,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -339,8 +339,8 @@ from "Employees" where FirstName = "Robert" ## session.advanced.rawQuery -* Queries defined with [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - or [documentQuery](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) +* Queries defined with [query](#sessionquery) + or [documentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -370,7 +370,7 @@ $employees = $session ## Custom methods -Available custom methods for session's [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available custom methods for session's [query](#sessionquery) method: - [aggregateBy](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) - [count](../../../../client-api/session/querying/how-to-count-query-results.mdx) @@ -424,7 +424,7 @@ public function rawQuery(?string $className, string $query): RawDocumentQueryInt | Return Value | | | - | - | -| `DocumentQueryInterface`
`RawDocumentQueryInterface` | Interfaces exposing additional query methods and [extensions](../../../../client-api/session/querying/how-to-query.mdx#custom-methods) | +| `DocumentQueryInterface`
`RawDocumentQueryInterface` | Interfaces exposing additional query methods and [extensions](#custom-methods) | diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-python.mdx index 3928220ba0..781c2900ed 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-query-python.mdx @@ -15,7 +15,7 @@ import CodeBlock from '@theme/CodeBlock'; * Queries defined with `query` or `document_query` are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * All queries in RavenDB use an **index** to provide results, even when you don't specify one. - Learn more [below](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). + Learn more [below](#queries-always-provide-results-using-an-index). * Queries that do Not specify which index to use are called **Dynamic Queries**. This article displays examples of dynamic queries only. @@ -29,12 +29,12 @@ import CodeBlock from '@theme/CodeBlock'; * Queries are timed out after a configurable time period. See [query timeout](../../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec). * In this page: - * [Queries always provide results using an index](../../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) - * [session.query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) - * [session.advanced.document_query](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocument_query) - * [session.advanced.raw_query](../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedraw_query) - * [Custom methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods) - * [Syntax](../../../../client-api/session/querying/how-to-query.mdx#syntax) + * [Queries always provide results using an index](#queries-always-provide-results-using-an-index) + * [session.query](#sessionquery) + * [session.advanced.document_query](#sessionadvanceddocument_query) + * [session.advanced.raw_query](#sessionadvancedraw_query) + * [Custom methods](#custom-methods) + * [Syntax](#syntax) ## Queries always provide results using an index @@ -53,9 +53,9 @@ import CodeBlock from '@theme/CodeBlock'; We differentiate between the following **3 query scenarios**: -1. [Index query](../../../../client-api/session/querying/how-to-query.mdx#indexquery) -2. [Dynamic query](../../../../client-api/session/querying/how-to-query.mdx#dynamicquery) -3. [Full collection query](../../../../client-api/session/querying/how-to-query.mdx#collectionquery) +1. [Index query](#indexquery) +2. [Dynamic query](#dynamicquery) +3. [Full collection query](#collectionquery) For each scenario, a different index type is used, as described below. @@ -107,7 +107,7 @@ For each scenario, a different index type is used, as described below. * Over time, an optimal set of indexes is generated by the query optimizer to answer your queries. * Example RQL:   `from Employees where FirstName == "Laura"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). * Note: Counters and Time series are an exception to this flow. Dynamic queries on counters and time series values don't create auto-indexes. However, a static-index can be defined on [Time series](../../../../document-extensions/timeseries/indexing.mdx) and [Counters](../../../../document-extensions/counters/indexing.mdx). @@ -139,7 +139,7 @@ For each scenario, a different index type is used, as described below. * RavenDB uses the raw collection documents as the source for this query. * Example RQL:   `from Employees where id() == "employees/1-A"` - See more examples [below](../../../../client-api/session/querying/how-to-query.mdx#sessionquery). + See more examples [below](#sessionquery). @@ -151,7 +151,7 @@ For each scenario, a different index type is used, as described below. * The following examples show **dynamic queries** that do not specify which index to use. Please refer to [querying an index](../../../../indexes/querying/query-index.mdx) for other examples. -* Querying can be enhanced using these [extension methods](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq). +* Querying can be enhanced using these [extension methods](#custom-methods-and-extensions-for-linq). @@ -392,7 +392,7 @@ from "Employees" where FirstName = "Robert" ## session.advanced.raw_query -* Queries defined with [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) or [document_query](../../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocument_query) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) +* Queries defined with [query](#sessionquery) or [document_query](#sessionadvanceddocument_query) are translated by the RavenDB client to [RQL](../../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `raw_query` method. @@ -422,7 +422,7 @@ employees = list( # Execute the query ## Custom methods -Available custom methods for session's [query](../../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: +Available custom methods for session's [query](#sessionquery) method: - [aggregate_by](../../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) - [count](../../../../client-api/session/querying/how-to-count-query-results.mdx) @@ -508,7 +508,7 @@ def raw_query(self, query: str, object_type: Optional[Type[_T]] = None) -> RawDo | Return Value | | | - | - | -| `DocumentQuery[_T]`
`RawDocumentQuery[_T]` | Instances exposing additional query methods and [extensions](../../../../client-api/session/querying/how-to-query.mdx#custom-methods-and-extensions-for-linq) | +| `DocumentQuery[_T]`
`RawDocumentQuery[_T]` | Instances exposing additional query methods and [extensions](#custom-methods-and-extensions-for-linq) | diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx index f287fbb234..dc0d6576a0 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-csharp.mdx @@ -14,19 +14,19 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Streaming overview](../../../../client-api/session/querying/how-to-stream-query-results.mdx#streaming-overview) + * [Streaming overview](#streaming-overview) - * [Stream by query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-query) - * [Stream a dynamic query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-query) - * [Stream a dynamic raw query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-raw-query) - * [Stream a projected query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-projected-query) - * [Stream an index query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-an-index-query) - * [Stream related documents](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents) - * [By query syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-query-syntax) + * [Stream by query](#stream-by-query) + * [Stream a dynamic query](#stream-a-dynamic-query) + * [Stream a dynamic raw query](#stream-a-dynamic-raw-query) + * [Stream a projected query](#stream-a-projected-query) + * [Stream an index query](#stream-an-index-query) + * [Stream related documents](#stream-related-documents) + * [By query syntax](#by-query-syntax) - * [Stream by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-prefix) - * [Stream results by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-results-by-prefix) - * [By prefix syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-prefix-syntax) + * [Stream by prefix](#stream-by-prefix) + * [Stream results by prefix](#stream-results-by-prefix) + * [By prefix syntax](#by-prefix-syntax) ## Streaming overview @@ -50,7 +50,7 @@ import CodeBlock from '@theme/CodeBlock'; So calling [WaitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) is Not supported and will result in an exception. * Using [Include](../../../../client-api/how-to/handle-document-relationships.mdx#includes) to load a related document to the session in a streaming query is Not supported. - Learn how to __stream related documents__ here [below](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents). + Learn how to __stream related documents__ here [below](#stream-related-documents). diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx index 37adf6c91a..9286cf7de3 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-stream-query-results-nodejs.mdx @@ -14,19 +14,19 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Streaming overview](../../../../client-api/session/querying/how-to-stream-query-results.mdx#streaming-overview) + * [Streaming overview](#streaming-overview) - * [Stream by query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-query) - * [Stream a dynamic query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-query) - * [Stream a dynamic raw query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-dynamic-raw-query) - * [Stream a projected query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-a-projected-query) - * [Stream an index query](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-an-index-query) - * [Stream related documents](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents) - * [By query syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-query-syntax) + * [Stream by query](#stream-by-query) + * [Stream a dynamic query](#stream-a-dynamic-query) + * [Stream a dynamic raw query](#stream-a-dynamic-raw-query) + * [Stream a projected query](#stream-a-projected-query) + * [Stream an index query](#stream-an-index-query) + * [Stream related documents](#stream-related-documents) + * [By query syntax](#by-query-syntax) - * [Stream by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-by-prefix) - * [Stream results by prefix](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-results-by-prefix) - * [By prefix syntax](../../../../client-api/session/querying/how-to-stream-query-results.mdx#by-prefix-syntax) + * [Stream by prefix](#stream-by-prefix) + * [Stream results by prefix](#stream-results-by-prefix) + * [By prefix syntax](#by-prefix-syntax) ## Streaming overview @@ -50,7 +50,7 @@ import CodeBlock from '@theme/CodeBlock'; So calling [waitForNonStaleResults](../../../../client-api/session/querying/how-to-customize-query.mdx#waitfornonstaleresults) is Not supported and will result in an exception. * Using [include](../../../../client-api/session/loading-entities.mdx#load-with-includes) to load a related document to the session in a streaming query is Not supported. - Learn how to __stream related documents__ here [below](../../../../client-api/session/querying/how-to-stream-query-results.mdx#stream-related-documents). + Learn how to __stream related documents__ here [below](#stream-related-documents). diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx index 70cc313fd6..5e5ecc79b1 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-csharp.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -85,7 +85,7 @@ List products = session * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx index ba55785cca..e0c66df8eb 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-nodejs.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -85,7 +85,7 @@ const products = await session * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx index 8b7100a036..f5ea1949e9 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-php.mdx @@ -14,15 +14,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for a single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -87,7 +87,7 @@ public function suggestUsing(null|SuggestionBase|Closure $suggestionOrBuilder): * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx index 9d6ed237b1..91b67c67c6 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_how-to-work-with-suggestions-python.mdx @@ -14,17 +14,17 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * Overview: - * [What are terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#what-are-terms) - * [When to use suggestions](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#when-to-use-suggestions) + * [What are terms](#what-are-terms) + * [When to use suggestions](#when-to-use-suggestions) * Examples: - * [Suggest terms - for single term](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-single-term) - * [Suggest terms - for multiple terms](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Suggest terms - for single term](#suggest-terms---for-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) - * [The auto-index terms in Studio](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio) - * [Syntax](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax) + * [The auto-index terms in Studio](#the-auto-index-terms-in-studio) + * [Syntax](#syntax) ## What are terms @@ -82,7 +82,7 @@ products = list(session.query(object_type=Product).where_equals("name", "chaig") * Executing the above query will generate the auto-index `Auto/Products/ByName`. This auto-index will contain a list of all available terms from the document field `Name`. - The generated terms are visible in the Studio - see image [below](../../../../client-api/session/querying/how-to-work-with-suggestions.mdx#the-auto-index-terms-in-studio). + The generated terms are visible in the Studio - see image [below](#the-auto-index-terms-in-studio). * If you suspect that the term `chaig` in the query criteria is written incorrectly, you can ask RavenDB to suggest **existing terms** that are similar to `chaig`, as follows:. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-csharp.mdx index 5a6b82c493..b714a3e784 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-csharp.mdx @@ -23,17 +23,17 @@ import Panel from '@site/src/components/Panel'; For sorting results when querying a **static-index** see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -106,7 +106,7 @@ order by UnitsInStock as long * E.g. in the above example, ordering by `x => x.UnitsInStock` will result in `OrderingType.Long` because that property data type is an integer. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-nodejs.mdx index 97989ccaff..de25d0fa4a 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-nodejs.mdx @@ -21,17 +21,17 @@ import CodeBlock from '@theme/CodeBlock'; For sorting results when querying a __static-index__ see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -75,7 +75,7 @@ __Ordering Type__: * In the above example, the ordering type was set to `Long`. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-php.mdx index 4395fe40c0..c6e291fdbc 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-php.mdx @@ -21,17 +21,17 @@ import CodeBlock from '@theme/CodeBlock'; For sorting results when querying a **static-index** see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -94,7 +94,7 @@ order by UnitsInStock as long * E.g. in the above example, ordering by `UnitsInStock` will result in `OrderingType::long` because this property's data type is integer. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-python.mdx index f6c6d4f2a1..95e32830a6 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/content/_sort-query-results-python.mdx @@ -21,17 +21,17 @@ import CodeBlock from '@theme/CodeBlock'; For sorting results when querying a **static-index** see [sort index query results](../../../../indexes/querying/sorting.mdx). * In this page: - * [Order by field value](../../../../client-api/session/querying/sort-query-results.mdx#order-by-field-value) - * [Order by score](../../../../client-api/session/querying/sort-query-results.mdx#order-by-score) - * [Get resulting score](../../../../client-api/session/querying/sort-query-results.mdx#get-resulting-score) - * [Order by random](../../../../client-api/session/querying/sort-query-results.mdx#order-by-random) - * [Order by spatial](../../../../client-api/session/querying/sort-query-results.mdx#order-by-spatial) - * [Order by count (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-count-aggregation-query) - * [Order by sum (aggregation query)](../../../../client-api/session/querying/sort-query-results.mdx#order-by-sum-aggregation-query) - * [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) - * [Chain ordering](../../../../client-api/session/querying/sort-query-results.mdx#chain-ordering) - * [Custom sorters](../../../../client-api/session/querying/sort-query-results.mdx#custom-sorters) - * [Syntax](../../../../client-api/session/querying/sort-query-results.mdx#syntax) + * [Order by field value](#order-by-field-value) + * [Order by score](#order-by-score) + * [Get resulting score](#get-resulting-score) + * [Order by random](#order-by-random) + * [Order by spatial](#order-by-spatial) + * [Order by count (aggregation query)](#order-by-count-aggregation-query) + * [Order by sum (aggregation query)](#order-by-sum-aggregation-query) + * [Force ordering type](#force-ordering-type) + * [Chain ordering](#chain-ordering) + * [Custom sorters](#custom-sorters) + * [Syntax](#syntax) @@ -78,7 +78,7 @@ order by UnitsInStock as long * E.g. in the above example, ordering by `x => x.units_in_stock` will result in `OrderingType.LONG` because that property data type is an integer. -* Different ordering can be forced - see [Force ordering type](../../../../client-api/session/querying/sort-query-results.mdx#force-ordering-type) below. +* Different ordering can be forced - see [Force ordering type](#force-ordering-type) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx index d47cddc7ac..d0d949ad40 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-csharp.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; For including explanations when querying a **static-index** see [Include explanations in index query](../../../../../indexes/querying/include-explanations.mdx). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx index 0e0e0bedac..56cb59b39d 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-nodejs.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; For including explanations when querying a **static-index** see [Include explanations in index query](../../../../../indexes/querying/include-explanations.mdx). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-php.mdx index 85aefaa859..2ebfb9ff82 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-php.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-python.mdx index 5f5fc0efc1..ffc82e08ac 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_include-explanations-python.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations in a query](../../../../../client-api/session/querying/debugging/include-explanations.mdx#include-explanations-in-a-query) - * [View explanations](../../../../../client-api/session/querying/debugging/include-explanations.mdx#view-explanations) - * [Syntax](../../../../../client-api/session/querying/debugging/include-explanations.mdx#syntax) + * [Include explanations in a query](#include-explanations-in-a-query) + * [View explanations](#view-explanations) + * [Syntax](#syntax) ## Include explanations in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-csharp.mdx index a694912f6d..836844b4c6 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-csharp.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-java.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-java.mdx index e9a3379dad..c9fe49a387 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-java.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-java.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx index d74ca7eaa3..27c4b04cd7 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-nodejs.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-php.mdx index 149d462ffe..e0a8e1b47a 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-php.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-python.mdx index ff9f34b627..cc4de89b34 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/debugging/content/_query-timings-python.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; See examples below. * In this page: - * [Include timings in a query](../../../../../client-api/session/querying/debugging/query-timings.mdx#include-timings-in-a-query) - * [View timings](../../../../../client-api/session/querying/debugging/query-timings.mdx#view-timings) - * [Syntax](../../../../../client-api/session/querying/debugging/query-timings.mdx#syntax) - * [Timings in a sharded database](../../../../../client-api/session/querying/debugging/query-timings.mdx#timings-in-a-sharded-database) + * [Include timings in a query](#include-timings-in-a-query) + * [View timings](#view-timings) + * [Syntax](#syntax) + * [Timings in a sharded database](#timings-in-a-sharded-database) ## Include timings in a query diff --git a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx index 6a1947bd31..f83e0864fc 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * The main differences between `Query` and `DocumentQuery` are outlined in this article. * In this page: - * [API support](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#api-support) - * [Immutability](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#immutability) - * [Default query operator](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#default-query-operator) + * [API support](#api-support) + * [Immutability](#immutability) + * [Default query operator](#default-query-operator) ## API support diff --git a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx index 2454832fa2..907741e752 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; `documentQuery` examples as well. * In this page: - * [API support](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#api-support) - * [`query `and `documentQuery` equivalents](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#queryand-documentquery-equivalents) + * [API support](#api-support) + * [`query `and `documentQuery` equivalents](#queryand-documentquery-equivalents) ## API support diff --git a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx index 6ae3824af9..d5c740d076 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_query-vs-document-query-python.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; `document_query` examples as well. * In this page: - * [API support](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#api-support) - * [Mutability](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#mutability) - * [Default query operator](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx#default-query-operator) + * [API support](#api-support) + * [Mutability](#mutability) + * [Default query operator](#default-query-operator) ## API support diff --git a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx index a71ff8f744..2bd3286ab7 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-csharp.mdx @@ -13,10 +13,10 @@ import CodeBlock from '@theme/CodeBlock'; as it provides low-level querying capabilities. See [Query -vs- DocumentQuery](../../../../../client-api/session/querying/document-query/query-vs-document-query.mdx) for all differences. * In this page: - * [DocumentQuery examples](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#documentquery-examples) - * [Convert between DocumentQuery and Query](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#convert-between-documentquery-and-query) - * [Custom Methods and Extensions](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#custom-methods-and-extensions) - * [Syntax](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#syntax) + * [DocumentQuery examples](#documentquery-examples) + * [Convert between DocumentQuery and Query](#convert-between-documentquery-and-query) + * [Custom Methods and Extensions](#custom-methods-and-extensions) + * [Syntax](#syntax) ## DocumentQuery examples diff --git a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx index afc0499fbf..a23467eb5e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; for additional details. * In this page: - * [documentQuery examples](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#documentquery-examples) - * [Custom methods](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#custom-methods) - * [Syntax](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#syntax) + * [documentQuery examples](#documentquery-examples) + * [Custom methods](#custom-methods) + * [Syntax](#syntax) ## documentQuery examples diff --git a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx index bf3e6011af..3204eb6826 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/document-query/content/_what-is-document-query-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; `document_query` examples as well. * In this page: - * [`document_query` Examples](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#document_query-examples) - * [Convert between `document_query` and `query`](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#convert-between-document_query-and-query) - * [Available Custom Methods and Extensions](../../../../../client-api/session/querying/document-query/what-is-document-query.mdx#convert-between-document_query-and-query) + * [`document_query` Examples](#document_query-examples) + * [Convert between `document_query` and `query`](#convert-between-document_query-and-query) + * [Available Custom Methods and Extensions](#convert-between-document_query-and-query) ## `document_query` Examples diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx index f24ff0660a..85044d8302 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-csharp.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx index f739878858..36efc42489 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-nodejs.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-php.mdx index afec9ee7d4..2db6616c11 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-php.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-python.mdx index b35fc8eff4..c2e1b31463 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_boost-search-results-python.mdx @@ -27,8 +27,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Boost results - when making a full-text search](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-making-a-full-text-search) - * [Boost results - when querying with where clause](../../../../../client-api/session/querying/text-search/boost-search-results.mdx#boost-results---when-querying-with-where-clause) + * [Boost results - when making a full-text search](#boost-results---when-making-a-full-text-search) + * [Boost results - when querying with where clause](#boost-results---when-querying-with-where-clause) ## Boost results - when making a full-text search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx index 9f327739a3..96638a2ef4 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [EndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#endswith) + * [EndsWith](#endswith) * [EndsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#endswith-(case-sensitive)) - * [Negate EndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-endswith) + * [Negate EndsWith](#negate-endswith) ## EndsWith diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx index a78d599e5a..3dc15b046b 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-nodejs.mdx @@ -15,10 +15,10 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [whereEndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#whereendswith) + * [whereEndsWith](#whereendswith) * [whereEndsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#whereendswith-(case-sensitive)) - * [Negate whereEndsWith](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-whereendswith) - * [Syntax](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#syntax) + * [Negate whereEndsWith](#negate-whereendswith) + * [Syntax](#syntax) ## whereEndsWith diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-php.mdx index e35bde40b7..2102b52f58 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with) + * [where_ends_with](#where_ends_with) * [where_ends_with (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with-(case-sensitive)) - * [Negate where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-where_ends_with) + * [Negate where_ends_with](#negate-where_ends_with) ## where_ends_with diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-python.mdx index 5680751ecc..57a0295800 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_ends-with-query-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; and then query with a [prefix search](../../../../../client-api/session/querying/text-search/starts-with-query.mdx), which is much faster. * In this page: - * [where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with) + * [where_ends_with](#where_ends_with) * [where_ends_with (case-sensitive)](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#where_ends_with-(case-sensitive)) - * [Negate where_ends_with](../../../../../client-api/session/querying/text-search/ends-with-query.mdx#negate-where_ends_with) + * [Negate where_ends_with](#negate-where_ends_with) ## where_ends_with diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx index 7871aaa8cc..9e0a32f0b7 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-csharp.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; using the [default exact analyzer](../../../../../indexes/using-analyzers.mdx#ravendb) where the casing of the original text is not changed. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx index 488a5ae35e..711fd8a101 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-nodejs.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; using the [default exact analyzer](../../../../../indexes/using-analyzers.mdx#ravendb) where the casing of the original text is not changed. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-php.mdx index 1d57417b2e..fec318b8c1 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; where the casing of the original text is unchanged. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-python.mdx index 65260c6a8a..a4a01b0705 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_exact-match-query-python.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; where the casing of the original text is unchanged. * In this page: - * [Query with exact match](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match) - * [Query with exact match - nested object](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#query-with-exact-match---nested-object) - * [Syntax](../../../../../client-api/session/querying/text-search/exact-match-query.mdx#syntax) + * [Query with exact match](#query-with-exact-match) + * [Query with exact match - nested object](#query-with-exact-match---nested-object) + * [Syntax](#syntax) ## Query with exact match diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx index 4ae75bf59e..a2b87e04b7 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-csharp.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -122,7 +122,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -239,7 +239,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search options](#search-operators). diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx index 934235157f..315e9c597e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-nodejs.mdx @@ -28,12 +28,12 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-php.mdx index 4722745241..73833ded78 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-php.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -108,7 +108,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -198,7 +198,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-python.mdx index 3603b4beab..cb227fe0b8 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_full-text-search-python.mdx @@ -28,14 +28,14 @@ import CodeBlock from '@theme/CodeBlock'; the searched terms in the results. Learn more in [highlight search results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx). * In this page: - * [Search for single term](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-single-term) - * [Search for multiple terms](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-for-multiple-terms) - * [Search in multiple fields](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-multiple-fields) - * [Search in complex object](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-in-complex-object) - * [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators) - * [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-options) - * [Using wildcards](../../../../../client-api/session/querying/text-search/full-text-search.mdx#using-wildcards) - * [Syntax](../../../../../client-api/session/querying/text-search/full-text-search.mdx#syntax) + * [Search for single term](#search-for-single-term) + * [Search for multiple terms](#search-for-multiple-terms) + * [Search in multiple fields](#search-in-multiple-fields) + * [Search in complex object](#search-in-complex-object) + * [Search operators](#search-operators) + * [Search options](#search-options) + * [Using wildcards](#using-wildcards) + * [Syntax](#syntax) ## Search for single term @@ -90,7 +90,7 @@ where search(Notes, "University") * By default, the logical operator between these terms is 'OR'. -* This behavior can be modified. See section [Search operators](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search operators](#search-operators). @@ -131,7 +131,7 @@ where search(Notes, "University Sales Japanese") * By default, the logical operator between consecutive search methods is 'OR'. -* This behavior can be modified. See section [Search options](../../../../../client-api/session/querying/text-search/full-text-search.mdx#search-operators). +* This behavior can be modified. See section [Search options](#search-operators). diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx index 2aff0f33cb..320997bf38 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-csharp.mdx @@ -14,8 +14,8 @@ import CodeBlock from '@theme/CodeBlock'; * Note: this is a Lucene feature, available only for Lucene-based indexes. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx index 1700ed46b7..140fd67b1d 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx index 8e7ecb9d34..5a47583645 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Note: this is a Lucene feature, available only for Lucene-based indexes. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx index b7a0d4fce7..731332b3c4 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_fuzzy-search-python.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; * Note: this is a Lucene feature, available only for Lucene-based indexes. * In this page: - * [Fuzzy search example](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#fuzzy-search-example) - * [Syntax](../../../../../client-api/session/querying/text-search/fuzzy-search.mdx#syntax) + * [Fuzzy search example](#fuzzy-search-example) + * [Syntax](#syntax) ## Fuzzy search example diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx index 1d52ef49d8..3ada57bdad 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-csharp.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -168,7 +168,7 @@ string fragmentsHtml = builder.AppendLine("").ToString(); - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx index 3c56a7354d..016238ca5b 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-nodejs.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a __dynamic-query__. For highlighting search results when querying a __static-index__ see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -131,7 +131,7 @@ fragmentsHtml += ""; - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be __customized__ to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx index 954c3d56c7..d1fc04d268 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-php.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -134,7 +134,7 @@ $fragmentsHtml = $builder; - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx index 3aee7be7f3..2a2a2eb29e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_highlight-query-results-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * This article shows highlighting search results when making a **dynamic-query**. For highlighting search results when querying a **static-index** see [highlight index search results](../../../../../indexes/querying/highlighting.mdx). * In this page: - * [Highlight - basic example](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---basic-example) - * [Highlight tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-tags) - * [Highlight results in Studio](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight-results-in-studio) - * [Highlight - customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) - * [Highlight - projected results](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---projected-results) - * [Syntax](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#syntax) + * [Highlight - basic example](#highlight---basic-example) + * [Highlight tags](#highlight-tags) + * [Highlight results in Studio](#highlight-results-in-studio) + * [Highlight - customize tags](#highlight---customize-tags) + * [Highlight - projected results](#highlight---projected-results) + * [Syntax](#syntax) ## Highlight - basic example @@ -132,7 +132,7 @@ fragments_html = builder.append(f"\{os.linesep\}") - <span style="border-left: 10px solid powderblue"> </span>powderblue * The html tags that wrap the highlighted terms can be **customized** to any other tags. - See [customize tags](../../../../../client-api/session/querying/text-search/highlight-query-results.mdx#highlight---customize-tags) below. + See [customize tags](#highlight---customize-tags) below. diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx index fff8325ff5..02ed429c7d 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-csharp.mdx @@ -13,10 +13,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Proximity` method when running a **full-text search** by the [Search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx index a1880d69c7..241c80d8a3 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a __full-text search__ by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-php.mdx index b8aae434d8..9411af649f 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a **full-text search** by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-python.mdx index fe1f59aa8f..e65b9ba21b 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_proximity-search-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `proximity` method when running a **full-text search** by the [search](../../../../../client-api/session/querying/text-search/full-text-search.mdx) method. * In this page: - * [Why use proximity search](../../../../../client-api/session/querying/text-search/proximity-search.mdx#why-use-proximity-search) - * [How proximity works](../../../../../client-api/session/querying/text-search/proximity-search.mdx#how-proximity-works) - * [Proximity search examples](../../../../../client-api/session/querying/text-search/proximity-search.mdx#proximity-search-examples) - * [Syntax](../../../../../client-api/session/querying/text-search/proximity-search.mdx#syntax) + * [Why use proximity search](#why-use-proximity-search) + * [How proximity works](#how-proximity-works) + * [Proximity search examples](#proximity-search-examples) + * [Syntax](#syntax) ## Why use proximity search diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx index c5a42d9cb5..e2eeb1cacc 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx index 32bff0e775..88c3a5606e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-nodejs.mdx @@ -10,10 +10,10 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [whereStartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#wherestartswith) + * [whereStartsWith](#wherestartswith) * [whereStartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#wherestartswith-(case-sensitive)) - * [Negate whereStartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-wherestartswith) - * [Syntax](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#syntax) + * [Negate whereStartsWith](#negate-wherestartswith) + * [Syntax](#syntax) ## whereStartsWith diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-php.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-php.mdx index b6eb7fb103..3e9eff6bb4 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-php.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-python.mdx b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-python.mdx index d8b9ad2d9e..f3f257a8f0 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-python.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/text-search/content/_starts-with-query-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * Unless explicitly specified, the string comparisons are case-insensitive by default. * In this page: - * [StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith) + * [StartsWith](#startswith) * [StartsWith (case-sensitive)](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#startswith-(case-sensitive)) - * [Negate StartsWith](../../../../../client-api/session/querying/text-search/starts-with-query.mdx#negate-startswith) + * [Negate StartsWith](#negate-startswith) ## StartsWith diff --git a/versioned_docs/version-7.1/client-api/session/querying/what-is-rql.mdx b/versioned_docs/version-7.1/client-api/session/querying/what-is-rql.mdx index 0173ab1b68..b03b0c384e 100644 --- a/versioned_docs/version-7.1/client-api/session/querying/what-is-rql.mdx +++ b/versioned_docs/version-7.1/client-api/session/querying/what-is-rql.mdx @@ -30,29 +30,29 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [The query pipeline](../../../client-api/session/querying/what-is-rql.mdx#the-query-pipeline) + * [The query pipeline](#the-query-pipeline) - * [RQL keywords and methods](../../../client-api/session/querying/what-is-rql.mdx#rql-keywords-and-methods) + * [RQL keywords and methods](#rql-keywords-and-methods) - * [`declare`](../../../client-api/session/querying/what-is-rql.mdx#declare) - * [`from`](../../../client-api/session/querying/what-is-rql.mdx#from) - * [`where`](../../../client-api/session/querying/what-is-rql.mdx#where) - * [`group by`](../../../client-api/session/querying/what-is-rql.mdx#group-by) - * [`include`](../../../client-api/session/querying/what-is-rql.mdx#include) - * [`order by`](../../../client-api/session/querying/what-is-rql.mdx#order-by) - * [`select`](../../../client-api/session/querying/what-is-rql.mdx#select) - * [`load`](../../../client-api/session/querying/what-is-rql.mdx#load) - * [`limit`](../../../client-api/session/querying/what-is-rql.mdx#limit) - * [`update`](../../../client-api/session/querying/what-is-rql.mdx#update) + * [`declare`](#declare) + * [`from`](#from) + * [`where`](#where) + * [`group by`](#group-by) + * [`include`](#include) + * [`order by`](#order-by) + * [`select`](#select) + * [`load`](#load) + * [`limit`](#limit) + * [`update`](#update) - * [RQL comments](../../../client-api/session/querying/what-is-rql.mdx#rql-comments) + * [RQL comments](#rql-comments) ## The query pipeline The query pipeline in RavenDB includes the following main stages: -1. __Detect query source__ ([`from`](../../../client-api/session/querying/what-is-rql.mdx#from)) +1. __Detect query source__ ([`from`](#from)) * Based on your query, RavenDB will determine the appropriate data source from which to retrieve results. @@ -67,23 +67,23 @@ The query pipeline in RavenDB includes the following main stages: * Learn more about these __query scenarios__ in this [Query Overview](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index). -2. __Filter the data__ ([`where`](../../../client-api/session/querying/what-is-rql.mdx#where)) +2. __Filter the data__ ([`where`](#where)) * The index is scanned for records that match the query predicate. -3. __Include related documents__ ([`include`](../../../client-api/session/querying/what-is-rql.mdx#include)) +3. __Include related documents__ ([`include`](#include)) * [Related documents](../../../client-api/how-to/handle-document-relationships.mdx#includes) that are included in the query will be retrieved and returned to the client along with the resulting matching documents, reducing the need to do another network round trip to the database when accessing the included documents. -4. __Sort results__ ([`order by`](../../../client-api/session/querying/what-is-rql.mdx#order-by)) +4. __Sort results__ ([`order by`](#order-by)) * Query results can be sorted. For example, you can order by a field value, by the resulting documents' score, by random ordering, etc. -5. __Limit results__ ([`limit`](../../../client-api/session/querying/what-is-rql.mdx#limit)) +5. __Limit results__ ([`limit`](#limit)) * You can specify the number of results you want to get back from the query and the number of results you want to skip. -6. __Project results__ ([`select`](../../../client-api/session/querying/what-is-rql.mdx#select)) +6. __Project results__ ([`select`](#select)) * [Projections](../../../indexes/querying/projections.mdx) are specified when you need to retrieve only specific document fields, instead of the whole full document. This reduces the amount of data sent over the network and is useful when only partial data is needed. When projections are Not defined on the query - then the full document content is retrieved from the document storage. @@ -92,7 +92,7 @@ The query pipeline in RavenDB includes the following main stages: This means that the projection doesn't apply to all the documents in the database, only to the results that are actually returned. - * Data can be loaded ([`load`](../../../client-api/session/querying/what-is-rql.mdx#load)) from related documents to be used in the projected fields. + * Data can be loaded ([`load`](#load)) from related documents to be used in the projected fields. * For each record, the server extracts the requested field: If a field is stored in the index - the server will fetch it from the index. @@ -106,12 +106,12 @@ The query pipeline in RavenDB includes the following main stages: The following keywords and methods are available in RQL: -- [DECLARE](../../../client-api/session/querying/what-is-rql.mdx#declare) -- [FROM](../../../client-api/session/querying/what-is-rql.mdx#from) +- [DECLARE](#declare) +- [FROM](#from) - index -- [GROUP BY](../../../client-api/session/querying/what-is-rql.mdx#group-by) +- [GROUP BY](#group-by) - [array()](../../../client-api/session/querying/how-to-perform-group-by-query.mdx#by-array-content) -- [WHERE](../../../client-api/session/querying/what-is-rql.mdx#where) +- [WHERE](#where) - id() - [search()](../../../client-api/session/querying/text-search/full-text-search.mdx) - cmpxchg() @@ -129,7 +129,7 @@ The following keywords and methods are available in RQL: - [spatial.intersects()](../../../indexes/querying/spatial.mdx) - [moreLikeThis()](../../../client-api/session/querying/how-to-use-morelikethis.mdx) - [vector.search()](../../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx) -- [ORDER BY](../../../client-api/session/querying/what-is-rql.mdx#order-by) +- [ORDER BY](#order-by) - [ASC | ASCENDING](../../../indexes/querying/sorting.mdx#basics) - [DESC | DESCENDING](../../../indexes/querying/sorting.mdx#basics) - [AS](../../../indexes/querying/sorting.mdx#basics) @@ -140,8 +140,8 @@ The following keywords and methods are available in RQL: - [random()](../../../indexes/querying/sorting.mdx#random-ordering) - [score()](../../../indexes/querying/sorting.mdx#ordering-by-score) - [spatial.distance()](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-sorting) -- [LOAD](../../../client-api/session/querying/what-is-rql.mdx#load) -- [SELECT](../../../client-api/session/querying/what-is-rql.mdx#select) +- [LOAD](#load) +- [SELECT](#select) - DISTINCT - key() - sum() @@ -149,9 +149,9 @@ The following keywords and methods are available in RQL: - [facet()](../../../indexes/querying/faceted-search.mdx) - [timeseries()](../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#syntax) - [counter()](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) -- [LIMIT](../../../client-api/session/querying/what-is-rql.mdx#limit) -- [UPDATE](../../../client-api/session/querying/what-is-rql.mdx#update) -- [INCLUDE](../../../client-api/session/querying/what-is-rql.mdx#include) +- [LIMIT](#limit) +- [UPDATE](#update) +- [INCLUDE](#include) With the following operators: diff --git a/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-csharp.mdx b/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-csharp.mdx index 4bdf46a8fc..eff1ee8bd7 100644 --- a/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-csharp.mdx +++ b/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-csharp.mdx @@ -44,7 +44,7 @@ Task ExportAsync( | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `string` | Path to a file where exported data will be written | | **token** | `CancellationToken` | Token used to cancel the operation | @@ -64,7 +64,7 @@ Task ExportAsync( | **IncludeArtificial** | `bool` | Should artificial documents be exported.
Default: `false` | | **IncludeArchived** | `bool` | Should archived documents be exported.
Default: `true` | | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes.
Default: `false` | -| **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **MaxStepsForTransformScript** | `int` | Maximum number of steps that the transform script can process before failing.
Default: **10000** | ### Example @@ -111,7 +111,7 @@ Task ImportAsync( | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `Stream` | Stream with data to import | | **fromFile** | `string` | Path to a file from which data will be imported | | **token** | `CancellationToken` | Token used to cancel the operation | @@ -131,7 +131,7 @@ Task ImportAsync( | **IncludeArtificial** | `bool` | Should artificial documents be imported.
Default: `false` | | **IncludeArchived** | `bool` | Should archived documents be imported.
Default: `true` | | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes.
Default: `false` | -| **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](#transformscript). | | **MaxStepsForTransformScript** | `int` | Maximum number of steps that the transform script can process before failing.
Default: **10000** | ### Example diff --git a/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-java.mdx b/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-java.mdx index dd4f20fd0c..4aa61924d9 100644 --- a/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-java.mdx +++ b/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-java.mdx @@ -37,7 +37,7 @@ public Operation exportAsync(DatabaseSmugglerExportOptions options, DatabaseSmug | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `String` | Path to a file where exported data will be written | @@ -54,7 +54,7 @@ public Operation exportAsync(DatabaseSmugglerExportOptions options, DatabaseSmug | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be exported from database record. Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications` | | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | ### Example @@ -83,7 +83,7 @@ public Operation importAsync(DatabaseSmugglerImportOptions options, InputStream | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `InputStream` | Stream with data to import | | **fromFile** | `String` | Path to a file from which data will be imported | @@ -100,7 +100,7 @@ public Operation importAsync(DatabaseSmugglerImportOptions options, InputStream | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be imported. Default: `CLIENT`, `CONFLICT_SOLVER_CONFIG`, `EXPIRATION`, `EXTERNAL_REPLICATIONS`, `PERIODIC_BACKUPS`, `RAVEN_CONNECTION_STRINGS`, `RAVEN_ETLS`, `REVISIONS`, `SQL_CONNECTION_STRINGS`, `SORTERS`, `SQL_ETLS`, `HUB_PULL_REPLICATIONS`, `SINK_PULL_REPLICATIONS` | | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | diff --git a/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx b/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx index ca9f9b333d..23e3b30d17 100644 --- a/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx +++ b/versioned_docs/version-7.1/client-api/smuggler/content/_what-is-smuggler-nodejs.mdx @@ -38,7 +38,7 @@ const operation = await store.smuggler.export(options, toFile); | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerexportoptions). | +| **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](#databasesmugglerexportoptions). | | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | **toFile** | `string` | Path to a file where exported data will be written | @@ -56,7 +56,7 @@ const operation = await store.smuggler.export(options, toFile); | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | **includeArtificial** | `boolean` | ? | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | **skipRevisionCreation** | `boolean` | skip revision creation | | **encryptionKey** | `string` | Encryption key used for restore | @@ -92,7 +92,7 @@ const operation = await store.smuggler.import(options, stream); | Parameters | | | | ------------- | ------------- | ----- | -| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#databasesmugglerimportoptions). | +| **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](#databasesmugglerimportoptions). | | **stream** | `Stream` | Stream with data to import | | **fromFile** | `string` | Path to a file from which data will be imported | @@ -109,7 +109,7 @@ const operation = await store.smuggler.import(options, stream); | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | **includeArtificial** | `boolean` | ? | | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | -| **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../../client-api/smuggler/what-is-smuggler.mdx#transformscript). | +| **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](#transformscript). | | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | **skipRevisionCreation** | `boolean` | skip revision creation | | **encryptionKey** | `string` | Encryption key used for restore | diff --git a/versioned_docs/version-7.1/compare-exchange/configuration.mdx b/versioned_docs/version-7.1/compare-exchange/configuration.mdx index e4aa025243..578b2208bb 100644 --- a/versioned_docs/version-7.1/compare-exchange/configuration.mdx +++ b/versioned_docs/version-7.1/compare-exchange/configuration.mdx @@ -17,10 +17,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; see the [Configuration Overview](../server/configuration/configuration-options.mdx) article. * The following configuration options are available for compare-exchange: - * [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../compare-exchange/configuration.mdx#clustercompareexchangeexpireddeletefrequencyinsec) - * [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../compare-exchange/configuration.mdx#clustercompareexchangetombstonescleanupintervalinmin) - * [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../compare-exchange/configuration.mdx#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) - * [Cluster.DisableAtomicDocumentWrites](../compare-exchange/configuration.mdx#clusterdisableatomicdocumentwrites) + * [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](#clustercompareexchangeexpireddeletefrequencyinsec) + * [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](#clustercompareexchangetombstonescleanupintervalinmin) + * [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) + * [Cluster.DisableAtomicDocumentWrites](#clusterdisableatomicdocumentwrites) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-csharp.mdx index a6c061c27b..1144b26437 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-creation-and-update) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-nodejs.mdx index 3db6100f76..c88ebd6048 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-nodejs.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-php.mdx b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-php.mdx index 8403cad8dd..1e3f46a47e 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-php.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-php.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-python.mdx b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-python.mdx index 32f32643c3..ac51059677 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-python.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_atomic-guards-python.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; Atomic guards coordinate concurrent writes by different sessions to the same document. * In this article: - * [Atomic guard creation and update](../../compare-exchange/atomic-guards.mdx#atomic-guard-creation-and-update) - * [Atomic guard usage example](../../compare-exchange/atomic-guards.mdx#atomic-guard-usage-example) - * [Atomic guard database scope](../../compare-exchange/atomic-guards.mdx#atomic-guard-database-scope) - * [Disabling atomic guards](../../compare-exchange/atomic-guards.mdx#disabling-atomic-guards) - * [When are atomic guards removed](../../compare-exchange/atomic-guards.mdx#when-are-atomic-guards-removed) - * [Best practice when storing a document in a cluster-wide transaction](../../compare-exchange/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) + * [Atomic guard creation and update](#atomic-guard-creation-and-update) + * [Atomic guard usage example](#atomic-guard-usage-example) + * [Atomic guard database scope](#atomic-guard-database-scope) + * [Disabling atomic guards](#disabling-atomic-guards) + * [When are atomic guards removed](#when-are-atomic-guards-removed) + * [Best practice when storing a document in a cluster-wide transaction](#best-practice-when-storing-a-document-in-a-cluster-wide-transaction) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx index 053f739d98..b0f455ccc5 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more about dynamic queries in the [Query overview](../../client-api/session/querying/how-to-query.mdx). * In this article: - * [Projecting compare-exchange values in query results](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#projecting-compare-exchange-values-in-query-results) - * [Filtering by compare-exchange value](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#filtering-by-compare-exchange-value) - * [Example 1 - Filtering when the compare-exchange value is a string](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-1---filtering-when-the-compare-exchange-value-is-a-string) - * [Example 2 - Filtering when the compare-exchange value is an object](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object) - * [Syntax](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#syntax) + * [Projecting compare-exchange values in query results](#projecting-compare-exchange-values-in-query-results) + * [Filtering by compare-exchange value](#filtering-by-compare-exchange-value) + * [Example 1 - Filtering when the compare-exchange value is a string](#example-1---filtering-when-the-compare-exchange-value-is-a-string) + * [Example 2 - Filtering when the compare-exchange value is an object](#example-2---filtering-when-the-compare-exchange-value-is-an-object) + * [Syntax](#syntax) @@ -178,7 +178,7 @@ select { When filtering with `RavenQuery.CmpXchg` inside the `Where` predicate (as shown in this example), the compare-exchange value must be a _string_. If your compare-exchange value is of another type, you can still filter the results - - see the [next example](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object). + see the [next example](#example-2---filtering-when-the-compare-exchange-value-is-an-object). * Since this query uses filtering, RavenDB will automatically create an auto-index to serve it. In this case, the auto-index `Auto/Users/ByEmail` will be created. diff --git a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx index da25187038..45dc910c06 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-in-dynamic-queries-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more about dynamic queries in the [Query overview](../../client-api/session/querying/how-to-query.mdx). * In this article: - * [Projecting compare-exchange values in query results](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#projecting-compare-exchange-values-in-query-results) - * [Filtering by compare-exchange value](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#filtering-by-compare-exchange-value) - * [Example 1 - Filtering when the compare-exchange value is a string](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-1---filtering-when-the-compare-exchange-value-is-a-string) - * [Example 2 - Filtering when the compare-exchange value is an object](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object) - * [Syntax](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#syntax) + * [Projecting compare-exchange values in query results](#projecting-compare-exchange-values-in-query-results) + * [Filtering by compare-exchange value](#filtering-by-compare-exchange-value) + * [Example 1 - Filtering when the compare-exchange value is a string](#example-1---filtering-when-the-compare-exchange-value-is-a-string) + * [Example 2 - Filtering when the compare-exchange value is an object](#example-2---filtering-when-the-compare-exchange-value-is-an-object) + * [Syntax](#syntax) @@ -98,7 +98,7 @@ select { When filtering with `cmpxchg` inside the `where` predicate (as shown in this example), the compare-exchange value must be a _string_. If your compare-exchange value is of another type, you can still filter the results - - see the [next example](../../compare-exchange/cmpxchg-in-dynamic-queries.mdx#example-2---filtering-when-the-compare-exchange-value-is-an-object). + see the [next example](#example-2---filtering-when-the-compare-exchange-value-is-an-object). * Since this query uses filtering, RavenDB will automatically create an auto-index to serve it. In this case, the auto-index `Auto/Users/ByEmail` will be created. diff --git a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx index 7fb85c1b5d..e392c6c092 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-csharp.mdx @@ -25,9 +25,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Add expiration date using the **Client API**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-client-api) - * [Add expiration date using the **Studio**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-studio) - * [Syntax](../../compare-exchange/cmpxchg-expiration.mdx#syntax) + * [Add expiration date using the **Client API**](#add-expiration-date-using-the-client-api) + * [Add expiration date using the **Studio**](#add-expiration-date-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx index 19d2a3edaa..a47d6753d2 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_cmpxchg-item-expiration-nodejs.mdx @@ -25,9 +25,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Add expiration date using the **Client API**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-client-api) - * [Add expiration date using the **Studio**](../../compare-exchange/cmpxchg-expiration.mdx#add-expiration-date-using-the-studio) - * [Syntax](../../compare-exchange/cmpxchg-expiration.mdx#syntax) + * [Add expiration date using the **Client API**](#add-expiration-date-using-the-client-api) + * [Add expiration date using the **Studio**](#add-expiration-date-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-csharp.mdx index 961ac7662c..bb2236cba5 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-csharp.mdx @@ -20,17 +20,17 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Ex.1 - Create compare-exchange item - with string value](../../compare-exchange/create-cmpxchg-items.mdx#ex1---create-compare-exchange-item---with-string-value) - * [Ex.2 - Create compare-exchange item - with custom object value](../../compare-exchange/create-cmpxchg-items.mdx#ex2---create-compare-exchange-item---with-custom-object-value) - * [Ex.3 - Create compare-exchange item - with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex3---create-compare-exchange-item---with-metadata) - * [Ex.4 - Create multiple items](../../compare-exchange/create-cmpxchg-items.mdx#ex4---create-multiple-items) - * [Create item using a **store operation**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-store-operation) - * [Ex.5 - Create compare-exchange item - with string value](../../compare-exchange/create-cmpxchg-items.mdx#ex5---create-compare-exchange-item---with-string-value) - * [Ex.6 - Create compare-exchange item - with custom object value](../../compare-exchange/create-cmpxchg-items.mdx#ex6---create-compare-exchange-item---with-custom-object-value) - * [Ex.7 - Create compare-exchange item - with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex7---create-compare-exchange-item---with-metadata) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Ex.1 - Create compare-exchange item - with string value](#ex1---create-compare-exchange-item---with-string-value) + * [Ex.2 - Create compare-exchange item - with custom object value](#ex2---create-compare-exchange-item---with-custom-object-value) + * [Ex.3 - Create compare-exchange item - with metadata](#ex3---create-compare-exchange-item---with-metadata) + * [Ex.4 - Create multiple items](#ex4---create-multiple-items) + * [Create item using a **store operation**](#create-item-using-a-store-operation) + * [Ex.5 - Create compare-exchange item - with string value](#ex5---create-compare-exchange-item---with-string-value) + * [Ex.6 - Create compare-exchange item - with custom object value](#ex6---create-compare-exchange-item---with-custom-object-value) + * [Ex.7 - Create compare-exchange item - with metadata](#ex7---create-compare-exchange-item---with-metadata) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-java.mdx index ab4e00012d..305b797c34 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-java.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **store operation**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-store-operation) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **store operation**](#create-item-using-a-store-operation) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx index df539128f9..91aa83ce04 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-nodejs.mdx @@ -20,15 +20,15 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange items](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Ex.1 - Create new compare-exchange item](../../compare-exchange/create-cmpxchg-items.mdx#ex1---create-new-compare-exchange-item) - * [Ex.2 - Create new compare-exchange item with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex2---create-new-compare-exchange-item-with-metadata) - * [Ex.3 - Create multiple items](../../compare-exchange/create-cmpxchg-items.mdx#ex3---create-multiple-items) - * [Create item using a **store operation**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-store-operation) - * [Ex.4 - Create new compare-exchange item](../../compare-exchange/create-cmpxchg-items.mdx#ex4---create-new-compare-exchange-item) - * [Ex.5 - Create new compare-exchange item with metadata](../../compare-exchange/create-cmpxchg-items.mdx#ex5---create-new-compare-exchange-item-with-metadata) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Ex.1 - Create new compare-exchange item](#ex1---create-new-compare-exchange-item) + * [Ex.2 - Create new compare-exchange item with metadata](#ex2---create-new-compare-exchange-item-with-metadata) + * [Ex.3 - Create multiple items](#ex3---create-multiple-items) + * [Create item using a **store operation**](#create-item-using-a-store-operation) + * [Ex.4 - Create new compare-exchange item](#ex4---create-new-compare-exchange-item) + * [Ex.5 - Create new compare-exchange item with metadata](#ex5---create-new-compare-exchange-item-with-metadata) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-php.mdx b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-php.mdx index 95b9d42e26..a910a3a516 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-php.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-php.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-python.mdx b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-python.mdx index edca63e5c0..2950996855 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-python.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_create-cmpxchg-items-python.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; * To modify an existing compare-exchange item, see: [Update compare-exchange item](../../compare-exchange/update-cmpxchg-item.mdx). * In this article: - * [Create item using a **cluster-wide session**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-a-cluster-wide-session) - * [Create item using the **Studio**](../../compare-exchange/create-cmpxchg-items.mdx#create-item-using-the-studio) - * [Syntax](../../compare-exchange/create-cmpxchg-items.mdx#syntax) + * [Create item using a **cluster-wide session**](#create-item-using-a-cluster-wide-session) + * [Create item using the **Studio**](#create-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx index 5a30cdd7b3..c00830ae26 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx @@ -32,13 +32,13 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete multiple items](../../compare-exchange/delete-cmpxchg-items.mdx#delete-multiple-items) - * [Delete compare-exchange item using a **store operation**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-store-operation) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete multiple items](#delete-multiple-items) + * [Delete compare-exchange item using a **store operation**](#delete-compare-exchange-item-using-a-store-operation) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-java.mdx index 8ee2af06d3..2879418b96 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-java.mdx @@ -32,9 +32,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **store operation**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-store-operation) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **store operation**](#delete-compare-exchange-item-using-a-store-operation) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx index a9872a1a84..e5b22cd1d7 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx @@ -32,13 +32,13 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete multiple items](../../compare-exchange/delete-cmpxchg-items.mdx#delete-multiple-items) - * [Delete compare-exchange item using a **store operation**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-store-operation) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete multiple items](#delete-multiple-items) + * [Delete compare-exchange item using a **store operation**](#delete-compare-exchange-item-using-a-store-operation) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-php.mdx b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-php.mdx index c9eb4d051b..cb7b439d91 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-php.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-php.mdx @@ -32,11 +32,11 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-python.mdx b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-python.mdx index d53084fc3e..25fbb6f73d 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-python.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_delete-cmpxchg-items-python.mdx @@ -32,11 +32,11 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Delete compare-exchange item using a **cluster-wide session**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-item-using-a-cluster-wide-session) - * [Delete by item](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-item) - * [Delete by key and index](../../compare-exchange/delete-cmpxchg-items.mdx#delete-by-key-and-index) - * [Delete compare-exchange items using the **Studio**](../../compare-exchange/delete-cmpxchg-items.mdx#delete-compare-exchange-items-using-the-studio) - * [Syntax](../../compare-exchange/delete-cmpxchg-items.mdx#syntax) + * [Delete compare-exchange item using a **cluster-wide session**](#delete-compare-exchange-item-using-a-cluster-wide-session) + * [Delete by item](#delete-by-item) + * [Delete by key and index](#delete-by-key-and-index) + * [Delete compare-exchange items using the **Studio**](#delete-compare-exchange-items-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-csharp.mdx index fc94406a35..f2fda3165f 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-csharp.mdx @@ -16,14 +16,14 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item) - * [Get compare-exchange item lazily](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-lazily) - * [Retrieved compare-exchange items are tracked by the session](../../compare-exchange/get-cmpxchg-item.mdx#retrieved-compare-exchange-items-are-tracked-by-the-session) - * [Get item using a **store operation**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-store-operation) - * [Get compare-exchange item that has a number value and metadata](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-number-value-and-metadata) - * [Get compare-exchange item that has a custom object value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-custom-object-value) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Get compare-exchange item](#get-compare-exchange-item) + * [Get compare-exchange item lazily](#get-compare-exchange-item-lazily) + * [Retrieved compare-exchange items are tracked by the session](#retrieved-compare-exchange-items-are-tracked-by-the-session) + * [Get item using a **store operation**](#get-item-using-a-store-operation) + * [Get compare-exchange item that has a number value and metadata](#get-compare-exchange-item-that-has-a-number-value-and-metadata) + * [Get compare-exchange item that has a custom object value](#get-compare-exchange-item-that-has-a-custom-object-value) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-java.mdx index 580b3a9f03..bf98a4a09a 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-java.mdx @@ -16,10 +16,10 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **store operation**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-store-operation) - * [Get compare-exchange item that has a number value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-number-value) - * [Get compare-exchange item that has a custom object value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-custom-object-value) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **store operation**](#get-item-using-a-store-operation) + * [Get compare-exchange item that has a number value](#get-compare-exchange-item-that-has-a-number-value) + * [Get compare-exchange item that has a custom object value](#get-compare-exchange-item-that-has-a-custom-object-value) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx index 16b9e2ae06..4a3c54f253 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-nodejs.mdx @@ -16,14 +16,14 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item) - * [Get compare-exchange item lazily](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-lazily) - * [Retrieved compare-exchange items are tracked by the session](../../compare-exchange/get-cmpxchg-item.mdx#retrieved-compare-exchange-items-are-tracked-by-the-session) - * [Get item using a **store operation**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-store-operation) - * [Get compare-exchange item that has a number value and metadata](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-number-value-and-metadata) - * [Get compare-exchange item that has a custom object value](../../compare-exchange/get-cmpxchg-item.mdx#get-compare-exchange-item-that-has-a-custom-object-value) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Get compare-exchange item](#get-compare-exchange-item) + * [Get compare-exchange item lazily](#get-compare-exchange-item-lazily) + * [Retrieved compare-exchange items are tracked by the session](#retrieved-compare-exchange-items-are-tracked-by-the-session) + * [Get item using a **store operation**](#get-item-using-a-store-operation) + * [Get compare-exchange item that has a number value and metadata](#get-compare-exchange-item-that-has-a-number-value-and-metadata) + * [Get compare-exchange item that has a custom object value](#get-compare-exchange-item-that-has-a-custom-object-value) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-php.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-php.mdx index 3578ff877b..2e65f42c38 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-php.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-php.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-python.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-python.mdx index f4eed07d31..d6ea42c998 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-python.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-item-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; To get **multiple** items at once, see [Get multiple compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx). * In this article: - * [Get item using a **cluster-wide session**](../../compare-exchange/get-cmpxchg-item.mdx#get-item-using-a-cluster-wide-session) - * [Syntax](../../compare-exchange/get-cmpxchg-item.mdx#syntax) + * [Get item using a **cluster-wide session**](#get-item-using-a-cluster-wide-session) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-csharp.mdx index 6630a7562a..845b46eb03 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-csharp.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Create sample compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx#create-sample-compare-exchange-items) - * [Get compare-exchange items by list of keys](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-list-of-keys) - * [Get compare-exchange items by prefix](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-prefix) - * [Get compare-exchange items count](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-count) - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Get compare-exchange items by list of keys](#get-compare-exchange-items-by-list-of-keys) + * [Get compare-exchange items by prefix](#get-compare-exchange-items-by-prefix) + * [Get compare-exchange items count](#get-compare-exchange-items-count) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-java.mdx index f0ca9283ca..751b91e0e3 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-java.mdx @@ -19,9 +19,9 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Get compare-exchange items by list of keys](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-list-of-keys) - * [Get compare-exchange items by prefix](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-prefix) - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Get compare-exchange items by list of keys](#get-compare-exchange-items-by-list-of-keys) + * [Get compare-exchange items by prefix](#get-compare-exchange-items-by-prefix) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx index dc7d3c484d..e7d41716da 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-nodejs.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Create sample compare-exchange items](../../compare-exchange/get-cmpxchg-items.mdx#create-sample-compare-exchange-items) - * [Get compare-exchange items by list of keys](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-list-of-keys) - * [Get compare-exchange items by prefix](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-by-prefix) - * [Get compare-exchange items count](../../compare-exchange/get-cmpxchg-items.mdx#get-compare-exchange-items-count) - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Get compare-exchange items by list of keys](#get-compare-exchange-items-by-list-of-keys) + * [Get compare-exchange items by prefix](#get-compare-exchange-items-by-prefix) + * [Get compare-exchange items count](#get-compare-exchange-items-count) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-php.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-php.mdx index 7054a49319..16eb3ad106 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-php.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-php.mdx @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-python.mdx b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-python.mdx index 13c6ea60f6..43838787eb 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-python.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_get-cmpxchg-items-python.mdx @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock'; To get a **single** item, see [Get compare-exchange item](../../compare-exchange/get-cmpxchg-item.mdx). * In this article: - * [Syntax](../../compare-exchange/get-cmpxchg-items.mdx#syntax) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-csharp.mdx index 465044ae6e..f265162c30 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; which means their values can be accessed later in the same session without making additional requests to the server. * In this page: - * [Sample data](../../compare-exchange/include-cmpxchg-items.mdx#sample-data) - * [Include compare-exchange items when loading](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-loading) - * [Include compare-exchange items when querying](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-querying) - * [Syntax](../../compare-exchange/include-cmpxchg-items.mdx#syntax) + * [Sample data](#sample-data) + * [Include compare-exchange items when loading](#include-compare-exchange-items-when-loading) + * [Include compare-exchange items when querying](#include-compare-exchange-items-when-querying) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx index 1109705ad3..8f14496dbf 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_include-compare-exchange-items-nodejs.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; which means their values can be accessed later in the same session without making additional requests to the server. * In this page: - * [Sample data](../../compare-exchange/include-cmpxchg-items.mdx#sample-data) - * [Include compare-exchange items when loading](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-loading) - * [Include compare-exchange items when querying](../../compare-exchange/include-cmpxchg-items.mdx#include-compare-exchange-items-when-querying) - * [Syntax](../../compare-exchange/include-cmpxchg-items.mdx#syntax) + * [Sample data](#sample-data) + * [Include compare-exchange items when loading](#include-compare-exchange-items-when-loading) + * [Include compare-exchange items when querying](#include-compare-exchange-items-when-querying) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx index 5187eaa1c4..3b25e9641b 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-csharp.mdx @@ -13,11 +13,11 @@ import CodeBlock from '@theme/CodeBlock'; or when documents in the indexed collection(s) are modified. * In this article: - * [Create sample compare-exchange items](../../compare-exchange/indexing-cmpxchg-values.mdx#create-sample-compare-exchange-items) - * [Index compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#index-compare-exchange-values) - * [Query the index](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index) - * [Query the index and project compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index-and-project-compare-exchange-values) - * [Syntax](../../compare-exchange/indexing-cmpxchg-values.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Index compare-exchange values](#index-compare-exchange-values) + * [Query the index](#query-the-index) + * [Query the index and project compare-exchange values](#query-the-index-and-project-compare-exchange-values) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-java.mdx index f18848462a..c1b0c3b1ca 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-java.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; or when documents in the indexed collection(s) are modified. * In this page: - * [How to use](../../compare-exchange/indexing-cmpxchg-values.mdx#how-to-use) - * [Examples](../../compare-exchange/indexing-cmpxchg-values.mdx#examples) - * [Querying the Index](../../compare-exchange/indexing-cmpxchg-values.mdx#querying-the-index) + * [How to use](#how-to-use) + * [Examples](#examples) + * [Querying the Index](#querying-the-index) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx index 2561819ea3..1417eb9f85 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_indexing-compare-exchange-values-nodejs.mdx @@ -13,11 +13,11 @@ import CodeBlock from '@theme/CodeBlock'; or when documents in the indexed collection(s) are modified. * In this article: - * [Create sample compare-exchange items](../../compare-exchange/indexing-cmpxchg-values.mdx#create-sample-compare-exchange-items) - * [Index compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#index-compare-exchange-values) - * [Query the index](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index) - * [Query the index and project compare-exchange values](../../compare-exchange/indexing-cmpxchg-values.mdx#query-the-index-and-project-compare-exchange-values) - * [Syntax](../../compare-exchange/indexing-cmpxchg-values.mdx#syntax) + * [Create sample compare-exchange items](#create-sample-compare-exchange-items) + * [Index compare-exchange values](#index-compare-exchange-values) + * [Query the index](#query-the-index) + * [Query the index and project compare-exchange values](#query-the-index-and-project-compare-exchange-values) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_overview-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_overview-csharp.mdx index 3269336873..24968a1aba 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_overview-csharp.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_overview-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_overview-java.mdx index ffb644445f..13039f917f 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_overview-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_overview-java.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_overview-php.mdx b/versioned_docs/version-7.1/compare-exchange/content/_overview-php.mdx index 52f71820f2..24e0242e65 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_overview-php.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_overview-php.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_overview-python.mdx b/versioned_docs/version-7.1/compare-exchange/content/_overview-python.mdx index b68890f7f3..dd7a9b62da 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_overview-python.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_overview-python.mdx @@ -19,19 +19,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Compare-exchange items are also suitable for storing shared or global values that aren't tied to a specific document - such as configuration flags, feature toggles, or reusable identifiers stored under a unique key. - However, [unlike regular documents](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness), + However, [unlike regular documents](#why-not-use-regular-documents-to-enforce-uniqueness), compare-exchange provides atomic updates, version-based conflict prevention, and Raft-based consistency for distributed safety. -* Compare-exchange items are [not replicated externally](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. +* Compare-exchange items are [not replicated externally](#why-compare-exchange-items-are-not-replicated-to-external-databases) to other databases. * In this article: - * [What compare-exchange items are](../../compare-exchange/overview.mdx#what-compare-exchange-items-are) - * [Ways to create and manage compare-exchange items](../../compare-exchange/overview.mdx#ways-to-create-and-manage-compare-exchange-items) - * [Why compare-exchange items are not replicated to external databases](../../compare-exchange/overview.mdx#why-compare-exchange-items-are-not-replicated-to-external-databases) - * [Why not use regular documents to enforce uniqueness](../../compare-exchange/overview.mdx#why-not-use-regular-documents-to-enforce-uniqueness) - * [Example I - Email address reservation](../../compare-exchange/overview.mdx#example-i-email-address-reservation) - * [Example II - Reserve a shared resource](../../compare-exchange/overview.mdx#example-ii-reserve-a-shared-resource) - * [Use cases](../../compare-exchange/overview.mdx#use-cases) + * [What compare-exchange items are](#what-compare-exchange-items-are) + * [Ways to create and manage compare-exchange items](#ways-to-create-and-manage-compare-exchange-items) + * [Why compare-exchange items are not replicated to external databases](#why-compare-exchange-items-are-not-replicated-to-external-databases) + * [Why not use regular documents to enforce uniqueness](#why-not-use-regular-documents-to-enforce-uniqueness) + * [Example I - Email address reservation](#example-i-email-address-reservation) + * [Example II - Reserve a shared resource](#example-ii-reserve-a-shared-resource) + * [Use cases](#use-cases) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-csharp.mdx b/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-csharp.mdx index 753ff4f0fa..7cce357d44 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-csharp.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Using the Studio * In this article: - * [Update compare-exchange item using a **cluster-wide session**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-cluster-wide-session) - * [Update compare-exchange item using a **store operation**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-store-operation) - * [Update compare-exchange item using the **Studio**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-the-studio) - * [Syntax](../../compare-exchange/update-cmpxchg-item.mdx#syntax) + * [Update compare-exchange item using a **cluster-wide session**](#update-compare-exchange-item-using-a-cluster-wide-session) + * [Update compare-exchange item using a **store operation**](#update-compare-exchange-item-using-a-store-operation) + * [Update compare-exchange item using the **Studio**](#update-compare-exchange-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-java.mdx b/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-java.mdx index b92c5573cc..a254b689b9 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-java.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-java.mdx @@ -29,9 +29,9 @@ import CodeBlock from '@theme/CodeBlock'; --- * In this article: - * [Update compare-exchange item using a **store operation**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-store-operation) - * [Update compare-exchange item using the **Studio**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-the-studio) - * [Syntax](../../compare-exchange/update-cmpxchg-item.mdx#syntax) + * [Update compare-exchange item using a **store operation**](#update-compare-exchange-item-using-a-store-operation) + * [Update compare-exchange item using the **Studio**](#update-compare-exchange-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx b/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx index 6cfd17520f..dfa2e1d904 100644 --- a/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx +++ b/versioned_docs/version-7.1/compare-exchange/content/_update-cmpxchg-item-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Using the Studio * In this article: - * [Update compare-exchange item using a **cluster-wide session**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-cluster-wide-session) - * [Update compare-exchange item using a **store operation**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-a-store-operation) - * [Update compare-exchange item using the **Studio**](../../compare-exchange/update-cmpxchg-item.mdx#update-compare-exchange-item-using-the-studio) - * [Syntax](../../compare-exchange/update-cmpxchg-item.mdx#syntax) + * [Update compare-exchange item using a **cluster-wide session**](#update-compare-exchange-item-using-a-cluster-wide-session) + * [Update compare-exchange item using a **store operation**](#update-compare-exchange-item-using-a-store-operation) + * [Update compare-exchange item using the **Studio**](#update-compare-exchange-item-using-the-studio) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/data-archival/content/_archived-documents-and-other-features-csharp.mdx b/versioned_docs/version-7.1/data-archival/content/_archived-documents-and-other-features-csharp.mdx index 54f8d82e90..5e4dd3a65b 100644 --- a/versioned_docs/version-7.1/data-archival/content/_archived-documents-and-other-features-csharp.mdx +++ b/versioned_docs/version-7.1/data-archival/content/_archived-documents-and-other-features-csharp.mdx @@ -24,16 +24,16 @@ import Panel from '@site/src/components/Panel'; * Learn more below about how various RavenDB features interact with archived documents. * In this article: - * [Archived documents and indexing](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-indexing) - * [Archived documents and querying](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-querying) - * [Archived documents and data subscriptions](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-subscriptions) - * [Archived documents and document extensions](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-document-extensions) - * [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.mdx#archived-documents-and-expiration) - * [Archived documents and ETL](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-etl) - * [Archived documents and backup](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-backup) - * [Archived documents and replication](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-replication) - * [Archived documents and patching](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-patching) + * [Archived documents and indexing](#archived-documents-and-indexing) + * [Archived documents and querying](#archived-documents-and-querying) + * [Archived documents and data subscriptions](#archived-documents-and-subscriptions) + * [Archived documents and document extensions](#archived-documents-and-document-extensions) + * [Archived documents and smuggler (export/import)](#archived-documents-and-smuggler-export-import) + * [Archived documents and expiration](#archived-documents-and-expiration) + * [Archived documents and ETL](#archived-documents-and-etl) + * [Archived documents and backup](#archived-documents-and-backup) + * [Archived documents and replication](#archived-documents-and-replication) + * [Archived documents and patching](#archived-documents-and-patching) diff --git a/versioned_docs/version-7.1/data-archival/content/_enable-data-archiving-csharp.mdx b/versioned_docs/version-7.1/data-archival/content/_enable-data-archiving-csharp.mdx index 7203941dd1..a5aea83e35 100644 --- a/versioned_docs/version-7.1/data-archival/content/_enable-data-archiving-csharp.mdx +++ b/versioned_docs/version-7.1/data-archival/content/_enable-data-archiving-csharp.mdx @@ -18,8 +18,8 @@ import Panel from '@site/src/components/Panel'; Learn how to schedule documents for archival in [Schedule document archiving](../../data-archival/schedule-document-archiving.mdx). * In this article: - * [Enable archiving - from the Client API](../../data-archival/enable-data-archiving.mdx#enable-archiving-from-the-client-api) - * [Enable archiving - from the Studio](../../data-archival/enable-data-archiving.mdx#enable-archiving-from-the-studio) + * [Enable archiving - from the Client API](#enable-archiving-from-the-client-api) + * [Enable archiving - from the Studio](#enable-archiving-from-the-studio) diff --git a/versioned_docs/version-7.1/data-archival/content/_schedule-document-archiving-csharp.mdx b/versioned_docs/version-7.1/data-archival/content/_schedule-document-archiving-csharp.mdx index 185d27a642..0da0878f2b 100644 --- a/versioned_docs/version-7.1/data-archival/content/_schedule-document-archiving-csharp.mdx +++ b/versioned_docs/version-7.1/data-archival/content/_schedule-document-archiving-csharp.mdx @@ -24,10 +24,10 @@ import Panel from '@site/src/components/Panel'; These documents will be archived once the feature is enabled and the task runs - provided the scheduled time has already passed. * In this article: - * [Schedule a SINGLE document for archiving - from the Client API](../../data-archival/schedule-document-archiving.mdx#schedule-a-single-document-for-archiving-from-the-client-api) - * [Schedule a SINGLE document for archiving - from the Studio](../../data-archival/schedule-document-archiving.mdx#schedule-a-single-document-for-archiving-from-the-studio) - * [Schedule MULTIPLE documents for archiving - from the Client API](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving-from-the-client-api) - * [Schedule MULTIPLE documents for archiving - from the Studio](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving-from-the-studio) + * [Schedule a SINGLE document for archiving - from the Client API](#schedule-a-single-document-for-archiving-from-the-client-api) + * [Schedule a SINGLE document for archiving - from the Studio](#schedule-a-single-document-for-archiving-from-the-studio) + * [Schedule MULTIPLE documents for archiving - from the Client API](#schedule-multiple-documents-for-archiving-from-the-client-api) + * [Schedule MULTIPLE documents for archiving - from the Studio](#schedule-multiple-documents-for-archiving-from-the-studio) @@ -259,7 +259,7 @@ To learn more about the `PatchByQueryOperation`, see [Set-based patch operations **Example**: The following patch script, used directly in the Studio, -performs the same operation as the [Client API example](../../data-archival/schedule-document-archiving.mdx#schedule-multiple-documents-for-archiving-from-the-client-api) shown above. +performs the same operation as the [Client API example](#schedule-multiple-documents-for-archiving-from-the-client-api) shown above. ![Schedule multiple documents for archiving](../assets/schedule-multiple-documents-for-archiving.png) diff --git a/versioned_docs/version-7.1/data-archival/content/_unarchiving-documents-csharp.mdx b/versioned_docs/version-7.1/data-archival/content/_unarchiving-documents-csharp.mdx index 63bb7535ae..16ed16280b 100644 --- a/versioned_docs/version-7.1/data-archival/content/_unarchiving-documents-csharp.mdx +++ b/versioned_docs/version-7.1/data-archival/content/_unarchiving-documents-csharp.mdx @@ -17,9 +17,9 @@ import Panel from '@site/src/components/Panel'; To properly unarchive a document, use the `archived.unarchive()` method as described below. * In this article: - * [Unarchive documents - from the Client API](../../data-archival/unarchiving-documents.mdx#unarchive-documents-from-the-client-api) - * [Unarchive documents - from the Studio](../../data-archival/unarchiving-documents.mdx#unarchive-documents-from-the-studio) - * [Unarchiving documents with index-based patch queries](../../data-archival/unarchiving-documents.mdx#unarchiving-documents-with-index-based-patch-queries) + * [Unarchive documents - from the Client API](#unarchive-documents-from-the-client-api) + * [Unarchive documents - from the Studio](#unarchive-documents-from-the-studio) + * [Unarchiving documents with index-based patch queries](#unarchiving-documents-with-index-based-patch-queries) @@ -142,7 +142,7 @@ archived.unarchive(doc) **Example**: The following patch script, used directly in the Studio, -performs the same operation as the [Client API example](../../data-archival/unarchiving-documents.mdx#unarchive-documents-from-the-client-api) shown above. +performs the same operation as the [Client API example](#unarchive-documents-from-the-client-api) shown above. It will unarchive all archived documents in the _Orders_ collection. ![Unarchive documents](../assets/unarchive-documents.png) diff --git a/versioned_docs/version-7.1/data-archival/overview.mdx b/versioned_docs/version-7.1/data-archival/overview.mdx index a5e5db6bf8..d3b6e55a44 100644 --- a/versioned_docs/version-7.1/data-archival/overview.mdx +++ b/versioned_docs/version-7.1/data-archival/overview.mdx @@ -31,12 +31,12 @@ import Panel from '@site/src/components/Panel'; * To take advantage of the archiving feature, you must first **enable** it. Once enabled, you can **schedule** documents for archiving. - Learn more in the [Overview](../data-archival/overview.mdx#overview) section below. + Learn more in the [Overview](#overview) section below. * In this article: - * [Overview](../data-archival/overview.mdx#overview) - * [The archived document](../data-archival/overview.mdx#the-archived-document) - * [Licensing](../data-archival/overview.mdx#licensing) + * [Overview](#overview) + * [The archived document](#the-archived-document) + * [Licensing](#licensing) diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-csharp.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-csharp.mdx index 9129a15fb4..f07ef04c73 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-csharp.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; Use its `AttachmentsFor` interface to add attachments to documents with great speed. * In this page: - * [Usage flow](../../../document-extensions/attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../document-extensions/attachments/bulk-insert.mdx#usage-example) - * [Syntax](../../../document-extensions/attachments/bulk-insert.mdx#syntax) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-nodejs.mdx index 11bbb48bad..ab7c934bdc 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-nodejs.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; Use its `attachmentsFor` interface to add attachments to documents with great speed. * In this page: - * [Usage flow](../../../document-extensions/attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../document-extensions/attachments/bulk-insert.mdx#usage-example) - * [Syntax](../../../document-extensions/attachments/bulk-insert.mdx#syntax) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) + * [Syntax](#syntax) diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-python.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-python.mdx index 683e19c455..75a07cb056 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_bulk-insert-python.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Use `store` * In this page: - * [Usage flow](../../../document-extensions/attachments/bulk-insert.mdx#usage-flow) - * [Usage example](../../../document-extensions/attachments/bulk-insert.mdx#usage-example) + * [Usage flow](#usage-flow) + * [Usage example](#usage-example) diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx index bc2d0bcefb..9b619c5e19 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_copying-moving-renaming-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; removing the need to transfer the entire attachment binary data over the network in order to perform the action. * In this page: - * [Copy attachment](../../../document-extensions/attachments/copying-moving-renaming.mdx#copy-attachment) - * [Move attachment](../../../document-extensions/attachments/copying-moving-renaming.mdx#move-attachment) - * [Rename attachment](../../../document-extensions/attachments/copying-moving-renaming.mdx#rename-attachment) - * [Syntax](../../../document-extensions/attachments/copying-moving-renaming.mdx#syntax) + * [Copy attachment](#copy-attachment) + * [Move attachment](#move-attachment) + * [Rename attachment](#rename-attachment) + * [Syntax](#syntax) ## Copy attachment diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-csharp.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-csharp.mdx index ac45de2dc2..21eb99c0f6 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Index attachments details](../../../document-extensions/attachments/indexing.mdx#index-attachments-details) - * [Index details & content - by attachment name](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name) - * [Index details & content - all attachments](../../../document-extensions/attachments/indexing.mdx#index-details--content---all-attachments) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) + * [Index attachments details](#index-attachments-details) + * [Index details & content - by attachment name](#index-details--content---by-attachment-name) + * [Index details & content - all attachments](#index-details--content---all-attachments) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) + * [Syntax](#syntax) ## Index attachments details @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; These details can then be used when defining the index-fields. Once the index is deployed, you can query the index to find Employee documents based on these attachment properties. -* To index **attachments' content**, see the examples [below](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name). +* To index **attachments' content**, see the examples [below](#index-details--content---by-attachment-name). diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-java.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-java.mdx index 4c7f466a2e..bd6549a526 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-java.mdx @@ -14,9 +14,9 @@ import CodeBlock from '@theme/CodeBlock'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-nodejs.mdx index f567024d88..38ccd754dc 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; Auto-indexing attachments via dynamic queries is not available at this time. * In this page: - * [Index attachments details](../../../document-extensions/attachments/indexing.mdx#index-attachments-details) - * [Index details & content - by attachment name](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name) - * [Index details & content - all attachments](../../../document-extensions/attachments/indexing.mdx#index-details--content---all-attachments) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) + * [Index attachments details](#index-attachments-details) + * [Index details & content - by attachment name](#index-details--content---by-attachment-name) + * [Index details & content - all attachments](#index-details--content---all-attachments) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) + * [Syntax](#syntax) ## Index attachments details @@ -32,7 +32,7 @@ import CodeBlock from '@theme/CodeBlock'; These details can then be used when defining the index-fields. Once the index is deployed, you can query the index to find Employee documents based on these attachment properties. -* To index **attachments' content**, see the examples [below](../../../document-extensions/attachments/indexing.mdx#index-details--content---by-attachment-name). +* To index **attachments' content**, see the examples [below](#index-details--content---by-attachment-name). diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-php.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-php.mdx index eaba66cd10..201e7cde04 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-php.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-python.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-python.mdx index a111cc4312..3c111a6179 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_indexing-python.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Syntax](../../../document-extensions/attachments/indexing.mdx#syntax) - * [Examples](../../../document-extensions/attachments/indexing.mdx#examples) - * [Leveraging indexed attachments](../../../document-extensions/attachments/indexing.mdx#leveraging-indexed-attachments) + * [Syntax](#syntax) + * [Examples](#examples) + * [Leveraging indexed attachments](#leveraging-indexed-attachments) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/attachments/content/_loading-csharp.mdx b/versioned_docs/version-7.1/document-extensions/attachments/content/_loading-csharp.mdx index 45e94e529e..948ffbd003 100644 --- a/versioned_docs/version-7.1/document-extensions/attachments/content/_loading-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/attachments/content/_loading-csharp.mdx @@ -8,8 +8,8 @@ Learn in this page how to load a part of an attachment, an entire attachment, or multiple attachments. * In this page: - * [Load attachments](../../../document-extensions/attachments/loading.mdx#load-attachments) - * [Load a part of an attachment](../../../document-extensions/attachments/loading.mdx#load-a-part-of-an-attachment) + * [Load attachments](#load-attachments) + * [Load a part of an attachment](#load-a-part-of-an-attachment) ## Load attachments diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-csharp.mdx index 82c92397e3..867dc450e3 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-csharp.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -38,7 +38,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -163,7 +163,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -210,16 +210,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-java.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-java.mdx index 70d4cd51cd..ccfd1cf30a 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-java.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -37,7 +37,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be projected from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -158,7 +158,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -204,15 +204,15 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | ### Counters Bulk-Insert diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx index 5a10815080..79d98f8083 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-nodejs.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Smuggler](#counters-and-smuggler) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -37,7 +37,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -159,7 +159,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -205,16 +205,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | ### Counters Bulk-Insert diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-php.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-php.mdx index 015ec29d60..e491f907df 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-php.mdx @@ -10,12 +10,12 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL` + * [Counters and Other Features: summary](#counters-and-other-features-summary) @@ -35,7 +35,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Send the server **raw queries** for execution. * You can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get counter values from a query without downloading whole documents. @@ -150,14 +150,14 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-python.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-python.mdx index a6f4b3f16f..77fa1ad6f8 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_counters-and-other-features-python.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * How Counters trigger features' execution. * In this page: - * [Counters and Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) - * [Counters and Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) - * [Counters and Revisions](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) - * [Counters and Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) - * [Counters and Ongoing Tasks](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` - * [Counters and Other Features: summary](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-other-features-summary) - * [Counters Bulk-Insert](../../../document-extensions/counters/counters-and-other-features.mdx#counters-bulk-insert) + * [Counters and Indexing](#counters-and-indexing) + * [Counters and Queries](#counters-and-queries) + * [Counters and Revisions](#counters-and-revisions) + * [Counters and Changes API](#counters-and-changes-api) + * [Counters and Ongoing Tasks](#counters-and-ongoing-tasks) - `Backup`, `External replication`, `ETL`, `Data Subscription` + * [Counters and Other Features: summary](#counters-and-other-features-summary) + * [Counters Bulk-Insert](#counters-bulk-insert) @@ -36,7 +36,7 @@ Indexing Counters can speed-up finding them and the documents that contain them. Create queries **using code**, or send the server **raw queries** for execution. * Either way, you can query Counters **by name** but **not by value**. - This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing). + This is because queries are generally [based on indexes](../../../start/getting-started.mdx#example-iii---querying), and Counter values are [not indexed](#counters-and-indexing). * Counter values **can** be [projected](../../../indexes/querying/projections.mdx) from query results, as demonstrated in the following examples. This way a client can get Counter values from a query without downloading whole documents. @@ -119,7 +119,7 @@ Each [ongoing task](../../../studio/database/tasks/ongoing-tasks/general-info.md Both types operate as an ongoing backup routine, with a pre-set time schedule. * Logical Backup: **Backed-up Counter values**: **Distributed** - A logical backup is a higher-level implementation of [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler). + A logical backup is a higher-level implementation of [Smuggler](#counters-and-smuggler). As with Smuggler, Counters are backed-up and restored including their values on all nodes. * Snapshot: A snapshot stores all data and settings as a single binary image. @@ -165,16 +165,16 @@ and how the various features handle Counter values. | **Feature** | **Triggered by** | **Counter Value** | |-------------|:-------------|:-------------| -| [Indexing](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-indexing) | _Document Change_ | doesn't handle values | -| [LINQ Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | _Accumulated_ | -| [Raw Queries](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | -| [Smuggler](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-smuggler) | _No trigger_ | _Distributed_ | -| [Backup Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | -| [RavenDB ETL Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [External Replication task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | -| [Data Subscriptions Update Task](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-ongoing-tasks) | _Document Change_ | | -| [Changes API](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | -| [Revision creation](../../../document-extensions/counters/counters-and-other-features.mdx#counters-and-revisions) | _Document Change_ | _Accumulated_ | +| [Indexing](#counters-and-indexing) | _Document Change_ | doesn't handle values | +| [LINQ Queries](#counters-and-queries) | _No trigger_ | _Accumulated_ | +| [Raw Queries](#counters-and-queries) | _No trigger_ | `counter()` - _Accumulated_
`counterRaw()` - _Distributed_ | +| [Smuggler](#counters-and-smuggler) | _No trigger_ | _Distributed_ | +| [Backup Task](#counters-and-ongoing-tasks) | _Time Schedule_ | _Distributed_ | +| [RavenDB ETL Task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [External Replication task](#counters-and-ongoing-tasks) | _Document Change_,
_Countrer Value Modification_ | _Distributed_ | +| [Data Subscriptions Update Task](#counters-and-ongoing-tasks) | _Document Change_ | | +| [Changes API](#counters-and-changes-api) | _Countrer Value Modification_ | _Accumulated_ | +| [Revision creation](#counters-and-revisions) | _Document Change_ | _Accumulated_ | diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-csharp.mdx index 78ac478369..77db1611c6 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `CountersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`Increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`Increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `Increment` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-java.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-java.mdx index 8ca6e85d3c..c2431a76a3 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-java.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` uage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` uage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-nodejs.mdx index fad6827da4..0d6d73c910 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `Increment` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-php.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-php.mdx index 074a7e3a61..14fc5a54c8 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-python.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-python.mdx index 39e7bae3cd..c579b094bc 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_create-or-modify-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `counters_for ` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - - [`increment` usage](../../../document-extensions/counters/create-or-modify.mdx#increment-usage) - - [Example](../../../document-extensions/counters/create-or-modify.mdx#example) - - [Syntax](../../../document-extensions/counters/create-or-modify.mdx#syntax) + - [`increment` usage](#increment-usage) + - [Example](#example) + - [Syntax](#syntax) ## `increment` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-csharp.mdx index 612c1a6c01..2e562c2d25 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `CountersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`Delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`Delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `Delete ` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-java.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-java.mdx index 14ae398fe3..ef88364085 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-java.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-nodejs.mdx index 0b91b01e49..b6825c32f5 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-php.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-php.mdx index 140a5e1ff1..c28441d596 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `countersFor` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-python.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-python.mdx index e5ed6eb00a..7aaa3bc370 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_delete-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_delete-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; * For all other `counters_for` methods see this [Overview](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object). * In this page: - * [`delete ` usage](../../../document-extensions/counters/delete.mdx#delete-usage) - * [Example](../../../document-extensions/counters/delete.mdx#example) - * [Syntax](../../../document-extensions/counters/delete.mdx#syntax) + * [`delete ` usage](#delete-usage) + * [Example](#example) + * [Syntax](#syntax) ## `delete ` usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-csharp.mdx index 73d2d5aae1..52eb147828 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-csharp.mdx @@ -17,18 +17,18 @@ import Panel from '@site/src/components/Panel'; [Create subscription - include counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). * In this article: - * [Sample data](../../../document-extensions/counters/including-counters.mdx#sample-data) - * [Include counters when **loading**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-loading) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters) - * [Include counters when **querying**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-querying) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter-1) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters-1) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters-1) - * [Including multiple item types](../../../document-extensions/counters/including-counters.mdx#including-multiple-item-types) - * [Include behavior and constraints](../../../document-extensions/counters/including-counters.mdx#include-behavior-and-constraints) - * [Syntax](../../../document-extensions/counters/including-counters.mdx#syntax) + * [Sample data](#sample-data) + * [Include counters when **loading**](#include-counters-when-loading) + * [Include single counter](#include-single-counter) + * [Include multiple counters](#include-multiple-counters) + * [Include all counters](#include-all-counters) + * [Include counters when **querying**](#include-counters-when-querying) + * [Include single counter](#include-single-counter-1) + * [Include multiple counters](#include-multiple-counters-1) + * [Include all counters](#include-all-counters-1) + * [Including multiple item types](#including-multiple-item-types) + * [Include behavior and constraints](#include-behavior-and-constraints) + * [Syntax](#syntax) @@ -631,8 +631,8 @@ using (var session = store.OpenSession(new SessionOptions The following sections describe behavior that applies when including counters - whether during **load or query**: -* [Counters that don't exist at include time](../../../document-extensions/counters/including-counters.mdx#counters-that-dont-exist-at-include-time) -* [Do not mix IncludeAllCounters with individual counter includes](../../../document-extensions/counters/including-counters.mdx#do-not-mix-includeallcounters-with-individual-counter-includes) +* [Counters that don't exist at include time](#counters-that-dont-exist-at-include-time) +* [Do not mix IncludeAllCounters with individual counter includes](#do-not-mix-includeallcounters-with-individual-counter-includes) --- diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-nodejs.mdx index 0473522606..5b1c11f880 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_including-counters-nodejs.mdx @@ -17,18 +17,18 @@ import Panel from '@site/src/components/Panel'; [Create subscription - include counters](../../../client-api/data-subscriptions/creation/examples.mdx#create-subscription---include-counters). * In this article: - * [Sample data](../../../document-extensions/counters/including-counters.mdx#sample-data) - * [Include counters when **loading**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-loading) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters) - * [Include counters when **querying**](../../../document-extensions/counters/including-counters.mdx#include-counters-when-querying) - * [Include single counter](../../../document-extensions/counters/including-counters.mdx#include-single-counter-1) - * [Include multiple counters](../../../document-extensions/counters/including-counters.mdx#include-multiple-counters-1) - * [Include all counters](../../../document-extensions/counters/including-counters.mdx#include-all-counters-1) - * [Including multiple item types](../../../document-extensions/counters/including-counters.mdx#including-multiple-item-types) - * [Include behavior and constraints](../../../document-extensions/counters/including-counters.mdx#include-behavior-and-constraints) - * [Syntax](../../../document-extensions/counters/including-counters.mdx#syntax) + * [Sample data](#sample-data) + * [Include counters when **loading**](#include-counters-when-loading) + * [Include single counter](#include-single-counter) + * [Include multiple counters](#include-multiple-counters) + * [Include all counters](#include-all-counters) + * [Include counters when **querying**](#include-counters-when-querying) + * [Include single counter](#include-single-counter-1) + * [Include multiple counters](#include-multiple-counters-1) + * [Include all counters](#include-all-counters-1) + * [Including multiple item types](#including-multiple-item-types) + * [Include behavior and constraints](#include-behavior-and-constraints) + * [Syntax](#syntax) @@ -411,8 +411,8 @@ const product = await session.load("products/1-A", { The following sections describe behavior that applies when including counters - whether during **load or query**: -* [Counters that don't exist at include time](../../../document-extensions/counters/including-counters.mdx#counters-that-dont-exist-at-include-time) -* [Do not mix IncludeAllCounters with individual counter includes](../../../document-extensions/counters/including-counters.mdx#do-not-mix-includeallcounters-with-individual-counter-includes) +* [Counters that don't exist at include time](#counters-that-dont-exist-at-include-time) +* [Do not mix IncludeAllCounters with individual counter includes](#do-not-mix-includeallcounters-with-individual-counter-includes) --- diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-csharp.mdx index b29f514b68..5668586e49 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-csharp.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-java.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-java.mdx index e342f170a1..7427114c1b 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-java.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-nodejs.mdx index 9ddac7ee83..0282b47914 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-nodejs.mdx @@ -11,10 +11,10 @@ that inherits from `AbstractCountersIndexCreationTask ` or `AbstractRawJavaScrip * Auto-indexes for counters are not available at this time. * In this page: - * [Usage](../../../document-extensions/counters/indexing.mdx#usage) - * [AbstractCsharpCountersIndexCreationTask ](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section-1) - * [Querying the Index](../../../document-extensions/counters/indexing.mdx#querying-the-index) + * [Usage](#usage) + * [AbstractCsharpCountersIndexCreationTask ](#section) + * [CounterNamesFor](#section-1) + * [Querying the Index](#querying-the-index) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-php.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-php.mdx index 59042cb3e6..132f160803 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-php.mdx @@ -11,9 +11,9 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-python.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-python.mdx index 3b10b00c0d..781e452cfc 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_indexing-python.mdx @@ -11,9 +11,9 @@ that inherits from `AbstractCountersIndexCreationTask` or `AbstractJavaScriptCou * Auto-indexes for counters are not available at this time. * In this page: - * [Syntax](../../../document-extensions/counters/indexing.mdx#syntax) - * [AbstractJavaScriptCountersIndexCreationTask](../../../document-extensions/counters/indexing.mdx#section) - * [CounterNamesFor](../../../document-extensions/counters/indexing.mdx#section) + * [Syntax](#syntax) + * [AbstractJavaScriptCountersIndexCreationTask](#section) + * [CounterNamesFor](#section) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-csharp.mdx index 79d7abb12d..6c69d0fc15 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-csharp.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `CountersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `CountersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-java.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-java.mdx index 9ee2f16a00..b7842ae2e2 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-java.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `CountersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `CountersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-nodejs.mdx index 55125a4171..0b88a42de5 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-nodejs.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `countersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `countersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-php.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-php.mdx index 53a3b68c47..d7e4b02565 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-php.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `countersFor` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `countersFor` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-python.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-python.mdx index b4ee656dbd..59ad374ad2 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_overview-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_overview-python.mdx @@ -18,10 +18,10 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: * [Why use Counters?](../../../document-extensions/counters/overview.mdx#why-use-counters?) - * [Overview](../../../document-extensions/counters/overview.mdx#overview) - * [Managing Counters](../../../document-extensions/counters/overview.mdx#managing-counters) - * [Counter Methods and the `counters_for` object](../../../document-extensions/counters/overview.mdx#counter-methods-and-the--object) - * [Managing Counters using `Operations`](../../../document-extensions/counters/overview.mdx#managing-counters-using-) + * [Overview](#overview) + * [Managing Counters](#managing-counters) + * [Counter Methods and the `counters_for` object](#counter-methods-and-the--object) + * [Managing Counters using `Operations`](#managing-counters-using-) ## Why use Counters? @@ -115,7 +115,7 @@ for example. RavenDB doesn't limit the number of Counters you can create. -Note that the Counter names are stored in the document metadata and [do impact the size of the document](../../../document-extensions/counters/overview.mdx#counters-cost). +Note that the Counter names are stored in the document metadata and [do impact the size of the document](#counters-cost). #### The `HasCounters` Flag diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx index c3fcf41ec3..21deaafddf 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-csharp.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-java.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-java.mdx index 80b4df4ea1..5749da8aea 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-java.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx index 91c3d4f505..65fa2968d0 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-nodejs.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [Get usage](../../../document-extensions/counters/retrieve-counter-values.mdx#get-usage) - * [Get example](../../../document-extensions/counters/retrieve-counter-values.mdx#get-example) - * [Get syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#get-syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [GetAll usage](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-usage) - * [GetAll example](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-exmaple) - * [GetAll Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#getall-syntax) + * [Get a single Counter's value](#get-a-single-counter) + * [Get usage](#get-usage) + * [Get example](#get-example) + * [Get syntax](#get-syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [GetAll usage](#getall-usage) + * [GetAll example](#getall-exmaple) + * [GetAll Syntax](#getall-syntax) ## Get a single Counter's value diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-php.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-php.mdx index 1b539f803f..784d3d8f61 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-php.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get values of specific counters](../../../document-extensions/counters/retrieve-counter-values.mdx#get-values-of-specific-counters) - * [`get` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage) - * [`get` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example) - * [`get` syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [`getAll` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage-1) - * [`getAll` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example-1) - * [`getAll` Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax-1) + * [Get values of specific counters](#get-values-of-specific-counters) + * [`get` usage](#usage) + * [`get` example](#example) + * [`get` syntax](#syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [`getAll` usage](#usage-1) + * [`getAll` example](#example-1) + * [`getAll` Syntax](#syntax-1) ## Get values of specific counters diff --git a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-python.mdx b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-python.mdx index 39ae484137..62c5a82f10 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/content/_retrieve-counter-values-python.mdx @@ -12,15 +12,15 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Get a single Counter's value](../../../document-extensions/counters/retrieve-counter-values.mdx#get-a-single-counter) - * [`get` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage) - * [`get` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example) - * [`get` syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax) - - * [Get all Counters of a document](../../../document-extensions/counters/retrieve-counter-values.mdx#get-all-counters-of-a-document) - * [`get_all` usage](../../../document-extensions/counters/retrieve-counter-values.mdx#usage-1) - * [`get_all` example](../../../document-extensions/counters/retrieve-counter-values.mdx#example-1) - * [`get_all` Syntax](../../../document-extensions/counters/retrieve-counter-values.mdx#syntax-1) + * [Get a single Counter's value](#get-a-single-counter) + * [`get` usage](#usage) + * [`get` example](#example) + * [`get` syntax](#syntax) + + * [Get all Counters of a document](#get-all-counters-of-a-document) + * [`get_all` usage](#usage-1) + * [`get_all` example](#example-1) + * [`get_all` Syntax](#syntax-1) ## Get a single Counter's value diff --git a/versioned_docs/version-7.1/document-extensions/counters/counters-in-clusters.mdx b/versioned_docs/version-7.1/document-extensions/counters/counters-in-clusters.mdx index 02e94661ba..ee0e2b16ed 100644 --- a/versioned_docs/version-7.1/document-extensions/counters/counters-in-clusters.mdx +++ b/versioned_docs/version-7.1/document-extensions/counters/counters-in-clusters.mdx @@ -21,14 +21,14 @@ import Panel from '@site/src/components/Panel'; * When conflicting actions (such as _Delete_ and _Increment_) may occur, and how they are resolved * In this article: - * [Counter value modification](../../document-extensions/counters/counters-in-clusters.mdx#counter-value-modification) - * [Value modification and replication flow](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication-flow) - * [Reading a Counter's value](../../document-extensions/counters/counters-in-clusters.mdx#reading-a-counters-value) - * [Counter name modification](../../document-extensions/counters/counters-in-clusters.mdx#counter-name-modification) - * [Concurrent value modification](../../document-extensions/counters/counters-in-clusters.mdx#concurrent-value-modification) - * [Concurrent `Delete` and `Increment`](../../document-extensions/counters/counters-in-clusters.mdx#concurrent-delete-and-increment) - * [In a single-node system](../../document-extensions/counters/counters-in-clusters.mdx#in-a-single-node-system) - * [In a multi-node cluster](../../document-extensions/counters/counters-in-clusters.mdx#in-a-multi-node-cluster) + * [Counter value modification](#counter-value-modification) + * [Value modification and replication flow](#value-modification-and-replication-flow) + * [Reading a Counter's value](#reading-a-counters-value) + * [Counter name modification](#counter-name-modification) + * [Concurrent value modification](#concurrent-value-modification) + * [Concurrent `Delete` and `Increment`](#concurrent-delete-and-increment) + * [In a single-node system](#in-a-single-node-system) + * [In a multi-node cluster](#in-a-multi-node-cluster) @@ -57,7 +57,7 @@ In the following example: | ProductLikes | **B** | **33** | | ProductLikes | C | 10 | -After a Counter’s value is modified on a node, that node [replicates](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication) +After a Counter’s value is modified on a node, that node [replicates](#value-modification-and-replication) the updated value to all other nodes in the cluster. In the above example: * The "ProductLikes" Counter was incremented by 5 on node B. @@ -104,7 +104,7 @@ In the following example: **The same Counter can be concurrently modified by multiple clients**. -As explained in the [Value modification and replication flow](../../document-extensions/counters/counters-in-clusters.mdx#value-modification-and-replication-flow) section, +As explained in the [Value modification and replication flow](#value-modification-and-replication-flow) section, each node manages its own portion of a Counter’s value independently. As a result: diff --git a/versioned_docs/version-7.1/document-extensions/overview-extensions.mdx b/versioned_docs/version-7.1/document-extensions/overview-extensions.mdx index fbfd9d7169..6eeefe77f1 100644 --- a/versioned_docs/version-7.1/document-extensions/overview-extensions.mdx +++ b/versioned_docs/version-7.1/document-extensions/overview-extensions.mdx @@ -28,8 +28,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; [dedicated to this subject](../sharding/document-extensions.mdx). * In this page: - * [Document Extensions](../document-extensions/overview-extensions.mdx#document-extensions) - * [Studio Document Extension Views](../document-extensions/overview-extensions.mdx#studio-document-extension-views) + * [Document Extensions](#document-extensions) + * [Studio Document Extension Views](#studio-document-extension-views) ## Document Extensions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-csharp.mdx index 3e9f9d128f..db7f1a1da5 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed from the [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * From the **Client API**, revisions can be configured and managed by: - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-java.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-java.mdx index 517669054d..035a2a35d0 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-java.mdx @@ -11,8 +11,8 @@ import CodeBlock from '@theme/CodeBlock'; * Learn about revisions here: [Docuument Revisions Overview](../../../../document-extensions/revisions/overview.mdx) * In this page: - * [Revisions Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Revisions Session methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Revisions Store Operations](#revisions-store-operations) + * [Revisions Session methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-nodejs.mdx index eb28887268..e589e7d003 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-nodejs.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed from the [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * From the **Client API**, revisions can be configured and managed by: - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions Store Operations diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-php.mdx index 290f891ca8..341d26454e 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-php.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed using [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * Find below a list of methods that revisions can be configured and managed by. - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions `store` Operations diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-python.mdx index aa1deb7104..0a936c618e 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/content/_overview-python.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Document revisions can be managed using [Studio](../../../../studio/database/settings/document-revisions.mdx) or from the **Client API**. * Find below a list of methods that revisions can be configured and managed by. - * [Store Operations](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-store-operations) - * [Session Methods](../../../../document-extensions/revisions/client-api/overview.mdx#revisions-session-methods) + * [Store Operations](#revisions-store-operations) + * [Session Methods](#revisions-session-methods) ## Revisions `store` Operations diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx index 2ae9b0d582..b55c12267c 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-csharp.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx index a9d1c3f942..9649d445ff 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; using the Configure Revisions Operation. * In this page: - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) - * [RevisionsCollectionConfiguration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) - * [RevisionsConfiguration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionsconfiguration) - * [ConfigureRevisionsOperation](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#configurerevisionsoperation) - * [Example](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#example) + * [Syntax](#syntax) + * [RevisionsCollectionConfiguration](#revisionscollectionconfiguration) + * [RevisionsConfiguration](#revisionsconfiguration) + * [ConfigureRevisionsOperation](#configurerevisionsoperation) + * [Example](#example) ## Syntax @@ -27,13 +27,13 @@ settings. To configure the revisions settings for a database and/or the collections in that database, follow these steps: -[1.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) +[1.](#revisionscollectionconfiguration) Create a RevisionsCollectionConfiguration` object for each desired collection. -[2.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionsconfiguration) +[2.](#revisionsconfiguration) Put those `RevisionsCollectionConfiguration` objects in a `RevisionsConfiguration` object. -[3.](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#configurerevisionsoperation) +[3.](#configurerevisionsoperation) Send that RevisionsConfiguration` to the server. ### RevisionsCollectionConfiguration @@ -96,7 +96,7 @@ configuration. Note that when this object is sent to the server, it overrides the configurations for **all** collections, including all existing configurations currently on the server. If a collection is not listed in `collections` and `defaultConfig` has not been set, the -default values listed in the table [above](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#revisionscollectionconfiguration) +default values listed in the table [above](#revisionscollectionconfiguration) are applied. ### ConfigureRevisionsOperation diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx index 5beaf93ab7..706b43473c 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-nodejs.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx index a0b187130a..a8ba2c6fe0 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-php.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx index edd592a21b..f067fee783 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_configure-revisions-python.mdx @@ -22,9 +22,9 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Replace configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#replace-configuration) - * [Modify configuration](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#modify-configuration) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/configure-revisions.mdx#syntax) + * [Replace configuration](#replace-configuration) + * [Modify configuration](#modify-configuration) + * [Syntax](#syntax) ## Replace configuration diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx index 1d035bf9ee..d056609af9 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-csharp.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx index 830c7d26d5..2b57d9a678 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-nodejs.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx index 31e5ac31f6..0a835b0367 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_conflict-revisions-configuration-php.mdx @@ -20,9 +20,9 @@ import CodeBlock from '@theme/CodeBlock'; revisions for conflicting documents of this collection that exceed this age will be purged. * In this page: - * [Configure revisions for conflicts - Example](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#configure-revisions-for-conflicts---example) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#syntax) - * [Storage consideration](../../../../../document-extensions/revisions/client-api/operations/conflict-revisions-configuration.mdx#storage-consideration) + * [Configure revisions for conflicts - Example](#configure-revisions-for-conflicts---example) + * [Syntax](#syntax) + * [Storage consideration](#storage-consideration) ## Configure revisions for conflicts - Example diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx index 93ecff8acc..f0f0cc1318 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_delete-revisions-csharp.mdx @@ -19,11 +19,11 @@ import CodeBlock from '@theme/CodeBlock'; To operate on a different database see [switch operations to different database](../../../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx). * In this page: - * [Delete all revisions - single document](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-all-revisions---single-document) - * [Delete revisions - multiple documents](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions---multiple-documents) - * [Delete revisions by time frame](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions-by-time-frame) - * [Delete revisions by change vectors](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#delete-revisions-by-change-vectors) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx#syntax) + * [Delete all revisions - single document](#delete-all-revisions---single-document) + * [Delete revisions - multiple documents](#delete-revisions---multiple-documents) + * [Delete revisions by time frame](#delete-revisions-by-time-frame) + * [Delete revisions by change vectors](#delete-revisions-by-change-vectors) + * [Syntax](#syntax) ## Delete all revisions - single document diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx index b939e97f83..34e00c5698 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-csharp.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [GetCountFor](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx index fd2f34531d..bd0181b2cb 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-nodejs.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [getCountFor](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx index 340c2acb32..fb984e7578 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-php.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [get_count_for](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx index e001b90934..dfa4c019e0 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/operations/content/_get-revisions-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * To only COUNT the number of revisions without getting them, use the [get_count_for](../../../../../document-extensions/revisions/client-api/session/counting.mdx) session method. * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#get-all-revisions) - * [Paging results](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#paging-results) - * [Syntax](../../../../../document-extensions/revisions/client-api/operations/get-revisions.mdx#syntax) + * [Get all revisions](#get-all-revisions) + * [Paging results](#paging-results) + * [Syntax](#syntax) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx index 7ece213782..7440bf2e06 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-csharp.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the advance session method `GetCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx index 2c16073f83..b37e4e853a 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-nodejs.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the advance session method `getCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-php.mdx index 42316254e4..807e435fe6 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-php.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the session `advanced` method `getCountFor`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-python.mdx index 803dc2f4ed..632cd5234c 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_counting-python.mdx @@ -8,8 +8,8 @@ import CodeBlock from '@theme/CodeBlock'; * You can get the number of revisions a document has by using the session `advanced` method `get_count_for`. * In this page: - * [Get revisions count](../../../../../document-extensions/revisions/client-api/session/counting.mdx#get-revisions-count) - * [syntax](../../../../../document-extensions/revisions/client-api/session/counting.mdx#syntax) + * [Get revisions count](#get-revisions-count) + * [syntax](#syntax) ## Get revisions count diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-csharp.mdx index e14515fbda..1336e84a2a 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-csharp.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a SINGLE revision can be included per document. - To include MULTIPLE revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include MULTIPLE revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include SINGLE or MULTIPLE document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -512,8 +512,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx index 70a7d963eb..33f022fa2b 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-nodejs.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a SINGLE revision can be included per document. - To include MULTIPLE revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include MULTIPLE revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include SINGLE or MULTIPLE document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -388,8 +388,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-php.mdx index cb0428e279..5533aa9bb9 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_including-php.mdx @@ -16,16 +16,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **Change vector** - use this to include **one or more** revisions * In this article: - * [Overview:](../../../../../document-extensions/revisions/client-api/session/including.mdx#overview) - * [Why include revisions](../../../../../document-extensions/revisions/client-api/session/including.mdx#why-include-revisions) - * [Including by creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time) - * [Including by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - * [Include revisions when Loading](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-loading) - * [Include revisions when Querying - High-level query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-high-level-query) - * [Include revisions when Querying - Raw query](../../../../../document-extensions/revisions/client-api/session/including.mdx#include-revisions-when-querying-raw-query) - * [View included revisions in Studio](../../../../../document-extensions/revisions/client-api/session/including.mdx#view-included-revisions-in-studio) - * [Patching the revision change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) - * [Syntax](../../../../../document-extensions/revisions/client-api/session/including.mdx#syntax) + * [Overview:](#overview) + * [Why include revisions](#why-include-revisions) + * [Including by creation time](#including-by-creation-time) + * [Including by change vector](#including-by-change-vector) + * [Include revisions when Loading](#include-revisions-when-loading) + * [Include revisions when Querying - High-level query](#include-revisions-when-querying-high-level-query) + * [Include revisions when Querying - Raw query](#include-revisions-when-querying-raw-query) + * [View included revisions in Studio](#view-included-revisions-in-studio) + * [Patching the revision change vector](#patching-the-revision-change-vector) + * [Syntax](#syntax) @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by creation time: * When specifying a creation time, only a **single** revision can be included per document. - To include **multiple** revisions, use [change vectors](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) instead. + To include **multiple** revisions, use [change vectors](#including-by-change-vector) instead. * You can pass local time or UTC, either way the server will convert it to UTC. @@ -63,7 +63,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; #### Including by change vector: -* Unlike using [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), which limits you to a **single** revision, +* Unlike using [creation time](#including-by-creation-time), which limits you to a **single** revision, including by change vector allows you to include **one or more** revisions per document. * Each time a document is modified, its [Change Vector](../../../../../server/clustering/replication/change-vector.mdx) is updated. @@ -74,7 +74,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * To include single or multiple document revisions by their change vectors: * When modifying the document, store its updated change vector in a property in the document. - This can be done by [patching](../../../../../document-extensions/revisions/client-api/session/including.mdx#patching-the-revision-change-vector) the document from the Client API or from the Studio. + This can be done by [patching](#patching-the-revision-change-vector) the document from the Client API or from the Studio. * Specify the **path** to this property when including the revisions, see examples below. @@ -493,8 +493,8 @@ The included revisions will be listed in a dedicated **Revisions Tab** under the -* When [including revisions by change vector](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-change-vector) - rather than by [creation time](../../../../../document-extensions/revisions/client-api/session/including.mdx#including-by-creation-time), +* When [including revisions by change vector](#including-by-change-vector) + rather than by [creation time](#including-by-creation-time), you need to specify the path to a document property that contains the revision change vector(s). * The example below shows how to retrieve a revision's change vector and patch it into a document property diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx index c28a13e13b..8a3c7bc981 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx index 2c8aacefca..18091068c2 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-php.mdx index fe28da7797..bb38aae3df 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-php.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-python.mdx index 3952370bc2..bb063b677e 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/client-api/session/content/_loading-python.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * These methods can also be executed lazily, see [get revisions lazily](../../../../../client-api/session/how-to/perform-operations-lazily.mdx#getrevisions). * In this page: - * [Get all revisions](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-all-revisions) - * [Get revisions metadata](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-metadata) - * [Get revisions by creation time](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-creation-time) - * [Get revisions by change vector](../../../../../document-extensions/revisions/client-api/session/loading.mdx#get-revisions-by-change-vector) + * [Get all revisions](#get-all-revisions) + * [Get revisions metadata](#get-revisions-metadata) + * [Get revisions by creation time](#get-revisions-by-creation-time) + * [Get revisions by change vector](#get-revisions-by-change-vector) ## Get all revisions diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-csharp.mdx index 64fef25d5d..00b3a747c0 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-csharp.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -218,8 +218,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-nodejs.mdx index 877cfa40e5..c08ce132c6 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-nodejs.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -218,8 +218,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-python.mdx index 910c5a6e6c..9f29cc3e81 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_overview-python.mdx @@ -18,21 +18,21 @@ import CodeBlock from '@theme/CodeBlock'; * **Automatic revisions creation**: When revisions settings are defined and enabled for a collection, a document revision is automatically created whenever documents are created, modified, or deleted. To configure revisions settings, and set limits for the number of revisions retained per document, - apply a [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) to all and/or specific collections. + apply a [Revisions configuration](#revisions-configuration) to all and/or specific collections. * **Manual revisions creation**: When revisions settings are disabled, you can still create revisions manually. - See [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) below. + See [Force revision creation](#force-revision-creation) below. * In this page: - * [Revisions configuration](../../../document-extensions/revisions/overview.mdx#revisions-configuration) - * [Defining a revisions configuration](../../../document-extensions/revisions/overview.mdx#defining-a-revisions-configuration) - * [Default settings and collection-specific configurations](../../../document-extensions/revisions/overview.mdx#default-settings-and-collection-specific-configurations) - * [Revisions configuration options](../../../document-extensions/revisions/overview.mdx#revisions-configuration-options) - * [Revisions configuration execution](../../../document-extensions/revisions/overview.mdx#revisions-configuration-execution) - * [Enabling and disabling revisions for existing documents](../../../document-extensions/revisions/overview.mdx#enabling-and-disabling-revisions-for-existing-documents) - * [How it works](../../../document-extensions/revisions/overview.mdx#how-it-works) - * [Revisions storage](../../../document-extensions/revisions/overview.mdx#revisions-storage) - * [Force revision creation](../../../document-extensions/revisions/overview.mdx#force-revision-creation) + * [Revisions configuration](#revisions-configuration) + * [Defining a revisions configuration](#defining-a-revisions-configuration) + * [Default settings and collection-specific configurations](#default-settings-and-collection-specific-configurations) + * [Revisions configuration options](#revisions-configuration-options) + * [Revisions configuration execution](#revisions-configuration-execution) + * [Enabling and disabling revisions for existing documents](#enabling-and-disabling-revisions-for-existing-documents) + * [How it works](#how-it-works) + * [Revisions storage](#revisions-storage) + * [Force revision creation](#force-revision-creation) ## Revisions configuration @@ -245,8 +245,8 @@ However, you can also **force the creation** of a document revision, whether the This is useful when you choose to disable automatic revisions creation but still want to create a revision for a specific document, e.g. take a snapshot of the document as a precaution before editing it. -* You can force the creation of a revision via the [Studio](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-studio) - or use the [Client API](../../../document-extensions/revisions/overview.mdx#force-revision-creation-via-the-client-api). +* You can force the creation of a revision via the [Studio](#force-revision-creation-via-the-studio) + or use the [Client API](#force-revision-creation-via-the-client-api). * A revision **will** be created even if the revisions configuration is disabled for the document's collection. * A revision **will** be created even if the document has not been modified (unless the document has revisions and the latest revision contains the current document contents). diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx index bb06b071bf..a2b04a3bd6 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-csharp.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx index ae08fe701d..6468260c5d 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-nodejs.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-php.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-php.mdx index b1874fdfd3..561cabf15a 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-php.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-python.mdx b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-python.mdx index c7701ce3e3..b91f67d265 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/content/_revisions-and-other-features-python.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; * How revisions are supported by other features * In this page: - * [Revisions and Counters](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-counters) - * [Revisions and Time Series](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-time-series) - * [Revisions and Attachments](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-attachments) - * [Revisions and Replication](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-replication) - * [Revisions and ETL](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-etl) - * [Revisions and Backup](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-backup) - * [Revisions and Data Subscriptions](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-and-data-subscriptions) - * [Revisions Import and Export](../../../document-extensions/revisions/revisions-and-other-features.mdx#revisions-import-and-export) + * [Revisions and Counters](#revisions-and-counters) + * [Revisions and Time Series](#revisions-and-time-series) + * [Revisions and Attachments](#revisions-and-attachments) + * [Revisions and Replication](#revisions-and-replication) + * [Revisions and ETL](#revisions-and-etl) + * [Revisions and Backup](#revisions-and-backup) + * [Revisions and Data Subscriptions](#revisions-and-data-subscriptions) + * [Revisions Import and Export](#revisions-import-and-export) ## Revisions and Counters diff --git a/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx b/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx index faa6af3411..52284f8e48 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/content/_revert-documents-to-specific-revisions-csharp.mdx @@ -12,11 +12,11 @@ import Panel from '@site/src/components/Panel'; see [Revert documents to specific time](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx). * In this article: - * [Overview](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#overview) - * [Revert documents](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-documents) - * [Revert single document](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-single-document) - * [Revert multiple documents](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-multiple-documents) - * [Syntax](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#syntax) + * [Overview](#overview) + * [Revert documents](#revert-documents) + * [Revert single document](#revert-single-document) + * [Revert multiple documents](#revert-multiple-documents) + * [Syntax](#syntax) @@ -62,7 +62,7 @@ import Panel from '@site/src/components/Panel'; The change-vector of a revision can be obtained via: - * The Client API - follow the code in the examples [below](../../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-revisions.mdx#revert-single-document) + * The Client API - follow the code in the examples [below](#revert-single-document) * Or from the document view in the Studio ![Get revision CV](../assets/get-cv-for-revision.png) diff --git a/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx b/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx index fd65202796..331b2c8f42 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx @@ -28,11 +28,11 @@ import Panel from '@site/src/components/Panel'; and facilitate instant recovery without the need to search and retrieve a stored backup. * In this article: - * [The revisions settings view](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#the-revisions-settings-view) - * [Revert documents](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents) - * [Point in time](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#point-in-time) - * [Time Window](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#time-window) - * [Content reverted](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#content-reverted) + * [The revisions settings view](#the-revisions-settings-view) + * [Revert documents](#revert-documents) + * [Point in time](#point-in-time) + * [Time Window](#time-window) + * [Content reverted](#content-reverted) @@ -44,7 +44,7 @@ import Panel from '@site/src/components/Panel'; In the Studio, go to _Settings > Document Revisions_. From this view you can: * [Set](../../../studio/database/settings/document-revisions.mdx#revisions-configuration) revision configurations * [Enforce](../../../studio/database/settings/document-revisions.mdx#enforce-configuration) revision configurations - * [Revert](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents) documents to revisions + * [Revert](#revert-documents) documents to revisions 2. **Revision configurations**: * The ability to revert documents to their past revisions depends on revisions being created. @@ -54,7 +54,7 @@ import Panel from '@site/src/components/Panel'; 3. **Revert documents**: Click the _Revert Revisions_ button to revert documents from all or selected collections to a specified point in time. - Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#revert-documents). + Learn more [below](#revert-documents). @@ -62,9 +62,9 @@ import Panel from '@site/src/components/Panel'; ![Revert Revisions](./assets/revert-revisions-2.png) -1. Enter the **Point in Time** to which you would like to revert the documents. Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#point-in-time). +1. Enter the **Point in Time** to which you would like to revert the documents. Learn more [below](#point-in-time). -2. Enter the **Time Window**. Learn more [below](../../../document-extensions/revisions/revert-documents-to-revisions/revert-documents-to-specific-time.mdx#time-window). +2. Enter the **Time Window**. Learn more [below](#time-window). 3. Revert **All collections** in the database, or toggle to select **Specific collections** to revert. diff --git a/versioned_docs/version-7.1/document-extensions/revisions/revisions-bin-cleaner.mdx b/versioned_docs/version-7.1/document-extensions/revisions/revisions-bin-cleaner.mdx index 9dc92b8106..10ec6e968b 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/revisions-bin-cleaner.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/revisions-bin-cleaner.mdx @@ -22,10 +22,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * For a complete list of deletion methods, see [All ways to delete revisions](../../studio/database/document-extensions/revisions/all-revisions.mdx#all-ways-to-delete-revisions). * In this page: - * [The revisions bin cleaner](../../document-extensions/revisions/revisions-bin-cleaner.mdx#the-revisions-bin-cleaner) - * [Setting the revisions bin cleaner - from the Studio](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-studio) - * [Setting the revisions bin cleaner - from the Client API](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-client-api) - * [Syntax](../../document-extensions/revisions/revisions-bin-cleaner.mdx#syntax) + * [The revisions bin cleaner](#the-revisions-bin-cleaner) + * [Setting the revisions bin cleaner - from the Studio](#setting-the-revisions-bin-cleaner---from-the-studio) + * [Setting the revisions bin cleaner - from the Client API](#setting-the-revisions-bin-cleaner---from-the-client-api) + * [Syntax](#syntax) ## The revisions bin cleaner @@ -42,8 +42,8 @@ ALL the revisions associated with the deleted document are **permanently deleted * **Entries age to keep** - The cleaner deletes revision entries older than this value. * The cleaner task can be managed from: - * The [Revisions bin cleaner view](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio - * The [Client API](../../document-extensions/revisions/revisions-bin-cleaner.mdx#setting-the-revisions-bin-cleaner---from-the-client-api). + * The [Revisions bin cleaner view](#setting-the-revisions-bin-cleaner---from-the-studio) in the Studio + * The [Client API](#setting-the-revisions-bin-cleaner---from-the-client-api). * When working with a secure server: * Configuring the Revisions Bin Cleaner is logged in the [audit log](../../server/security/audit-log/audit-log-overview.mdx). diff --git a/versioned_docs/version-7.1/document-extensions/revisions/troubleshooting.mdx b/versioned_docs/version-7.1/document-extensions/revisions/troubleshooting.mdx index 3c7e85aaf2..0b570b154f 100644 --- a/versioned_docs/version-7.1/document-extensions/revisions/troubleshooting.mdx +++ b/versioned_docs/version-7.1/document-extensions/revisions/troubleshooting.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`ThrowRevisionKeyTooBig` exception](../../document-extensions/revisions/troubleshooting.mdx#throwrevisionkeytoobig-exception) + * [`ThrowRevisionKeyTooBig` exception](#throwrevisionkeytoobig-exception) ## `ThrowRevisionKeyTooBig` exception diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx index 4c9784b36e..b58dac757a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; but without the overhead associated with the _Session_, resulting in significantly improved performance. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#examples) - * [Append single entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-single-entry) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-entries) - * [Append multiple values per entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-values-per-entry) - * [Append multiple time series](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) - * [Syntax](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append single entry](#append-single-entry) + * [Append multiple entries](#append-multiple-entries) + * [Append multiple values per entry](#append-multiple-values-per-entry) + * [Append multiple time series](#append-multiple-time-series) + * [Syntax](#syntax) @@ -41,7 +41,7 @@ import CodeBlock from '@theme/CodeBlock'; * To append multiple entries, call `Append` as many times as needed. * Ensure there is at least a 1-millisecond interval between each timestamp. * The client converts all timestamps to **UTC** before sending the batch to the server. -* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) below. +* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](#append-multiple-time-series) below. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx index 4096f6adc3..7af153503b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/bulk-insert/content/_append-in-bulk-nodejs.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; but without the overhead associated with the _Session_, resulting in significantly improved performance. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#examples) - * [Append single entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-single-entry) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-entries) - * [Append multiple values per entry](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-values-per-entry) - * [Append multiple time series](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) - * [Syntax](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append single entry](#append-single-entry) + * [Append multiple entries](#append-multiple-entries) + * [Append multiple values per entry](#append-multiple-values-per-entry) + * [Append multiple time series](#append-multiple-time-series) + * [Syntax](#syntax) @@ -41,7 +41,7 @@ import CodeBlock from '@theme/CodeBlock'; * To append multiple entries, call `append` as many times as needed. * Ensure there is at least a 1-millisecond interval between each timestamp. * The client converts all timestamps to **UTC** before sending the batch to the server. -* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](../../../../../document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.mdx#append-multiple-time-series) below. +* Multiple time series can be appended in the same `BulkInsertOperation`. See this [example](#append-multiple-time-series) below. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx index 5de832d7c5..fde7db2fd4 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-csharp.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; * The server treats timestamps passed in the scripts as **UTC**, no conversion is applied by the client to local time. * In this page: - * [JavaScript time series API methods](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#javascript-time-series-api-methods) - * [timeseries - choose a time series](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section) - * [timeseries.append - append an entry](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-1) - * [timeseries.delete - delete entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) - * [timeseries.get - get entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) - * [Examples](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#examples) + * [JavaScript time series API methods](#javascript-time-series-api-methods) + * [timeseries - choose a time series](#section) + * [timeseries.append - append an entry](#section-1) + * [timeseries.delete - delete entries](#section-2) + * [timeseries.get - get entries](#section-3) + * [Examples](#examples) ## JavaScript time series API methods diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx index a8a8dd226f..896c752a4e 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_javascript-support-nodejs.mdx @@ -17,12 +17,12 @@ import CodeBlock from '@theme/CodeBlock'; * The server treats timestamps passed in the scripts as **UTC**, no conversion is applied by the client to local time. * In this page: - * [JavaScript time series API methods](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#javascript-time-series-api-methods) - * [timeseries - choose a time series](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section) - * [timeseries.append - append an entry](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-1) - * [timeseries.delete - delete entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) - * [timeseries.get - get entries](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) - * [Examples](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#examples) + * [JavaScript time series API methods](#javascript-time-series-api-methods) + * [timeseries - choose a time series](#section) + * [timeseries.append - append an entry](#section-1) + * [timeseries.delete - delete entries](#section-2) + * [timeseries.get - get entries](#section-3) + * [Examples](#examples) ## JavaScript time series API methods diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx index c2735d6b84..d10029fab8 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; you need to register the time series types on the server. * In this page: - * [Named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#named-values) - * [Define time series type](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#define-time-series-type) - * [Examples](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#examples) - * [Register time series type](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#register-time-series-type) - * [Usage](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#usage) - * [Syntax](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#syntax) + * [Named values](#named-values) + * [Define time series type](#define-time-series-type) + * [Examples](#examples) + * [Register time series type](#register-time-series-type) + * [Usage](#usage) + * [Syntax](#syntax) ## Named values diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx index 47f7dc5d7a..a9830e3332 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_named-time-series-values-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; you need to register the named values on the server. * In this page: - * [Named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#named-values) - * [Define time series class with named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#define-time-series-class-with-named-values) - * [Examples](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#examples) - * [Register time series named values](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#register-time-series-named-values) - * [Usage](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#usage) - * [Syntax](../../../../document-extensions/timeseries/client-api/named-time-series-values.mdx#syntax) + * [Named values](#named-values) + * [Define time series class with named values](#define-time-series-class-with-named-values) + * [Examples](#examples) + * [Register time series named values](#register-time-series-named-values) + * [Usage](#usage) + * [Syntax](#syntax) ## Named values diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-csharp.mdx index aebb944f2c..02d3eec7cf 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-csharp.mdx @@ -12,10 +12,10 @@ You can use the API to **append** (create and update), **get**, **delete**, **include**, **patch** and **query** time series data. * In this page: - * [Creating and Removing Time Series](../../../../document-extensions/timeseries/client-api/overview.mdx#creating-and-removing-time-series) - * [`session` Methods -vs- `document-store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#session-methods--vs--document-store-operations) - * [Available Time Series `session` methods](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-session-methods) - * [Available Time Series `store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-store-operations) + * [Creating and Removing Time Series](#creating-and-removing-time-series) + * [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations) + * [Available Time Series `session` methods](#available-time-series-session-methods) + * [Available Time Series `store` Operations](#available-time-series-store-operations) ## Creating and Removing Time Series diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx index bd2dc85c4b..32bcf14b1b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/content/_overview-nodejs.mdx @@ -12,10 +12,10 @@ You can use the API to **append** (create and update), **get**, **delete**, **include**, **patch** and **query** time series data. * In this page: - * [Creating and Removing Time Series](../../../../document-extensions/timeseries/client-api/overview.mdx#creating-and-removing-time-series) - * [`session` Methods -vs- `document-store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#session-methods--vs--document-store-operations) - * [Available Time Series `session` methods](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-session-methods) - * [Available Time Series `store` Operations](../../../../document-extensions/timeseries/client-api/overview.mdx#available-time-series-store-operations) + * [Creating and Removing Time Series](#creating-and-removing-time-series) + * [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations) + * [Available Time Series `session` methods](#available-time-series-session-methods) + * [Available Time Series `store` Operations](#available-time-series-store-operations) ## Creating and Removing Time Series diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx index b61a2ca8f7..c3f2b88b97 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#delete-multiple-entries) - * [Append & Delete entries in the same batch](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Append & Delete entries in the same batch](#append--delete-entries-in-the-same-batch) + * [Syntax](#syntax) ## Usage @@ -39,7 +39,7 @@ import CodeBlock from '@theme/CodeBlock'; **Note**: * All the added Append and Delete operations will be executed in a single-node transaction. -* Delete actions are executed **before** Append actions. As seen in [this example](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch). +* Delete actions are executed **before** Append actions. As seen in [this example](#append--delete-entries-in-the-same-batch). * Appending entries to a time series that doesn't yet exist yet will create the time series. * An exception will be thrown if the specified document does Not exist. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx index a0084dd06b..8ebd11426b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_append-and-delete-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#delete-multiple-entries) - * [Append & delete entries in the same batch](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Append & delete entries in the same batch](#append--delete-entries-in-the-same-batch) + * [Syntax](#syntax) ## Usage @@ -39,7 +39,7 @@ import CodeBlock from '@theme/CodeBlock'; **Note**: * All the added Append and Delete operations will be executed in a single-node transaction. - * Delete actions are executed **before** Append actions. As seen in [this example](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx#append--delete-entries-in-the-same-batch). + * Delete actions are executed **before** Append actions. As seen in [this example](#append--delete-entries-in-the-same-batch). * Appending entries to a time series that doesn't yet exist yet will create the time series. * An exception will be thrown if the specified document does Not exist. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx index ec6f818d54..ae4a8859cd 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-csharp.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Get entries - from single time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-single-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax) - * [Get entries - from multiple time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-multiple-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax-1) + * [Get entries - from single time series](#get-entries---from-single-time-series) + * [Example](#example) + * [Syntax](#syntax) + * [Get entries - from multiple time series](#get-entries---from-multiple-time-series) + * [Example](#example-1) + * [Syntax](#syntax-1) ## Get entries - from single time series diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx index dff1839e1d..02aeb7d15a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_get-nodejs.mdx @@ -13,12 +13,12 @@ import CodeBlock from '@theme/CodeBlock'; * For a general _Operations_ overview, see [What are Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Get entries - from single time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-single-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax) - * [Get entries - from multiple time series](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#get-entries---from-multiple-time-series) - * [Example](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#example-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/get.mdx#syntax-1) + * [Get entries - from single time series](#get-entries---from-single-time-series) + * [Example](#example) + * [Syntax](#syntax) + * [Get entries - from multiple time series](#get-entries---from-multiple-time-series) + * [Example](#example-1) + * [Syntax](#syntax-1) ## Get entries - from single time series diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx index 5857407554..abad5f6079 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-csharp.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * Patching time series entries on a single document can also be performed via the [Session](../../../../../document-extensions/timeseries/client-api/session/patch.mdx). * In this page: - * [Patch time series data - single document](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---single-document) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax) - * [Patch time series data - multiple documents](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---multiple-documents) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage-1) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax-1) + * [Patch time series data - single document](#patch-time-series-data---single-document) + * [Usage](#usage) + * [Examples](#examples) + * [Syntax](#syntax) + * [Patch time series data - multiple documents](#patch-time-series-data---multiple-documents) + * [Usage](#usage-1) + * [Examples](#examples-1) + * [Syntax](#syntax-1) ## Patch time series data - single document diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx index f57aa23abc..c022a6c42b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/operations/content/_patch-nodejs.mdx @@ -13,14 +13,14 @@ import CodeBlock from '@theme/CodeBlock'; * Patching time series entries on a single document can also be performed via the [session](../../../../../document-extensions/timeseries/client-api/session/patch.mdx). * In this page: - * [Patch time series data - single document](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---single-document) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax) - * [Patch time series data - multiple documents](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#patch-time-series-data---multiple-documents) - * [Usage](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#usage-1) - * [Examples](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#examples-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx#syntax-1) + * [Patch time series data - single document](#patch-time-series-data---single-document) + * [Usage](#usage) + * [Examples](#examples) + * [Syntax](#syntax) + * [Patch time series data - multiple documents](#patch-time-series-data---multiple-documents) + * [Usage](#usage-1) + * [Examples](#examples-1) + * [Syntax](#syntax-1) ## Patch time series data - single document diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx index 228dadb0c9..e68653c5ad 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-csharp.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [`Append` usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [`Append` usage](#append-usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## `Append` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx index edb8c3db3c..a95d377b69 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-nodejs.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [`append` usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [`append` usage](#append-usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## `append` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-php.mdx index b435457c03..cbc4465e96 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-php.mdx @@ -21,10 +21,10 @@ import CodeBlock from '@theme/CodeBlock'; * Append entries directly on the _Store_ via [Operations](../../../../../client-api/operations/what-are-operations.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) + * [Usage](#usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-python.mdx index 76f29b4e80..99986e292b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_append-python.mdx @@ -27,11 +27,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Append time series operations](../../../../../document-extensions/timeseries/client-api/operations/append-and-delete.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/append.mdx#usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/append.mdx#examples) - * [Append entries with a single value](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-a-single-value) - * [Append entries with multiple values](../../../../../document-extensions/timeseries/client-api/session/append.mdx#append-entries-with-multiple-values) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/append.mdx#syntax) + * [Usage](#usage) + * [Examples](#examples) + * [Append entries with a single value](#append-entries-with-a-single-value) + * [Append entries with multiple values](#append-entries-with-multiple-values) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx index e5ab3ef769..9c9f5695be 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; To remove the whole time series simply delete all its entries. * In this page: - * [`Delete` usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#examples) - * [Delete single entry](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-single-entry) - * [Delete range of entries](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-range-of-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [`Delete` usage](#delete-usage) + * [Examples](#examples) + * [Delete single entry](#delete-single-entry) + * [Delete range of entries](#delete-range-of-entries) + * [Syntax](#syntax) ## `Delete` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx index 688d691cf8..a17f231e7a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * **Delete the whole time series** * In this page: - * [`delete` usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-usage) - * [Examples](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#examples) - * [Delete single entry](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-single-entry) - * [Delete range of entries](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-range-of-entries) - * [Delete time series](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#delete-time-series-1) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [`delete` usage](#delete-usage) + * [Examples](#examples) + * [Delete single entry](#delete-single-entry) + * [Delete range of entries](#delete-range-of-entries) + * [Delete time series](#delete-time-series-1) + * [Syntax](#syntax) ## `Delete` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-php.mdx index 95d589e3b3..867e055792 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-php.mdx @@ -9,8 +9,8 @@ import CodeBlock from '@theme/CodeBlock'; * A time series is removed when all of its entries are deleted. * In this page: - * [usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#usage) - * [Example](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#example) + * [usage](#usage) + * [Example](#example) ## usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-python.mdx index 87374cf760..943e014fdf 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_delete-python.mdx @@ -10,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; * A time series is removed when all of its entries are deleted. * In this page: - * [usage](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#usage) - * [Example](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#example) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/delete.mdx#syntax) + * [usage](#usage) + * [Example](#example) + * [Syntax](#syntax) ## usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx index 91c7b711e1..edca271545 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-csharp.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx index 981d2f5f19..75a16147f7 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-nodejs.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-php.mdx index 906080ac2c..e01239271b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-php.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-python.mdx index b384e3be53..c75b21680f 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_patch-python.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; where multiple documents can be handled at a time. Learn more in [Patching time series operations](../../../../../document-extensions/timeseries/client-api/operations/patch.mdx). * In this page: - * [Usage](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#usage) - * [Patching examples](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-examples) - * [Append multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#append-multiple-entries) - * [Delete multiple entries](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#delete-multiple-entries) - * [Syntax](../../../../../document-extensions/timeseries/client-api/session/patch.mdx#syntax) + * [Usage](#usage) + * [Patching examples](#patching-examples) + * [Append multiple entries](#append-multiple-entries) + * [Delete multiple entries](#delete-multiple-entries) + * [Syntax](#syntax) ## Usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx index d3c63ae569..2cb25c8d48 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-csharp.mdx @@ -15,18 +15,18 @@ import CodeBlock from '@theme/CodeBlock'; which can be provided to a `RawQuery` or executed from the Studio's [Query view](../../../../../studio/database/queries/query-view.mdx). * In this page: - * [Query](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query) - * [Query usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-usage) - * [Query examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-examples) - * [Query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax) - * [DocumentQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery) - * [DocumentQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-usage) - * [DocumentQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-examples) - * [DocumentQuery Syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#documentquery-syntax) - * [RawQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery) - * [RawQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-usage) - * [RawQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-examples) - * [RawQuery syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-syntax) + * [Query](#query) + * [Query usage](#query-usage) + * [Query examples](#query-examples) + * [Query syntax](#query-syntax) + * [DocumentQuery](#documentquery) + * [DocumentQuery usage](#documentquery-usage) + * [DocumentQuery examples](#documentquery-examples) + * [DocumentQuery Syntax](#documentquery-syntax) + * [RawQuery](#rawquery) + * [RawQuery usage](#rawquery-usage) + * [RawQuery examples](#rawquery-examples) + * [RawQuery syntax](#rawquery-syntax) diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx index 8ed03038fa..d52eedd9f5 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/content/_querying-nodejs.mdx @@ -14,14 +14,14 @@ import CodeBlock from '@theme/CodeBlock'; which can be provided to a `rawQuery` or executed from the Studio's [Query view](../../../../../studio/database/queries/query-view.mdx). * In this page: - * [Query](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query) - * [Query usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-usage) - * [Query examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-examples) - * [Query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax) - * [RawQuery](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery) - * [RawQuery usage](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-usage) - * [RawQuery examples](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-examples) - * [RawQuery syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#rawquery-syntax) + * [Query](#query) + * [Query usage](#query-usage) + * [Query examples](#query-examples) + * [Query syntax](#query-syntax) + * [RawQuery](#rawquery) + * [RawQuery usage](#rawquery-usage) + * [RawQuery examples](#rawquery-examples) + * [RawQuery syntax](#rawquery-syntax) @@ -482,7 +482,7 @@ select timeseries( |------------|----------|----------------------| | **query** | `string` | The RQL query string | -The return value is the same as listed under the [query syntax](../../../../../document-extensions/timeseries/client-api/session/querying.mdx#query-syntax). +The return value is the same as listed under the [query syntax](#query-syntax). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx index 82ed393a5a..3b2d4a69d7 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-csharp.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `TimeSeriesFor.Get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in: [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`Get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`Get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `Get` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx index 65dcab69e6..91736958df 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-nodejs.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `timeSeriesFor.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `get` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx index 634f7aa654..1c02956b31 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-php.mdx @@ -16,19 +16,19 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `timeSeriesFor.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. * In this page: - * [`get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `get` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx index 8472fc1c14..6d3a930757 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-entries-python.mdx @@ -16,20 +16,20 @@ import CodeBlock from '@theme/CodeBlock'; * When getting the time series entries, you can also _include_ the series' **parent document** and/or **documents referred to by the entry tag**. - Learn more [below](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents). + Learn more [below](#include-parent-and-tagged-documents). * Calling `time_series_for.get` will result in a trip to the server unless the series' parent document was loaded (or queried for) with the time series included beforehand. Learn more in: [Including time series](../../../../../../document-extensions/timeseries/client-api/session/include/overview.mdx). * In this page: - * [`Get` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-usage) - * [Examples](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#examples) - * [Get all entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-all-entries) - * [Get range of entries](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-range-of-entries) - * [Get entries with multiple values](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#get-entries-with-multiple-values) - * [Include parent and tagged documents](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#include-parent-and-tagged-documents) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#syntax) + * [`Get` usage](#get-usage) + * [Examples](#examples) + * [Get all entries](#get-all-entries) + * [Get range of entries](#get-range-of-entries) + * [Get entries with multiple values](#get-entries-with-multiple-values) + * [Include parent and tagged documents](#include-parent-and-tagged-documents) + * [Syntax](#syntax) ## `Get` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx index a119f865b9..7a171e4964 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-csharp.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `Advanced.GetTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`GetTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`GetTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `GetTimeSeriesFor` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx index dac7f2e4b1..7e6a0a9b5e 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-nodejs.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.getTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`GetTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`GetTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `getTimeSeriesFor` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx index 883b04f351..b8f23898c0 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-php.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.getTimeSeriesFor` to get the names of all time series for the specified entity. * In this page: - * [`getTimeSeriesFor` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#gettimeseriesfor-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`getTimeSeriesFor` usage](#gettimeseriesfor-usage) + * [Example](#example) + * [Syntax](#syntax) ## `getTimeSeriesFor` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx index 547217bc1c..19382f5aea 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/get/content/_get-names-python.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use `advanced.get_time_series_for` to get the names of all time series for the specified entity. * In this page: - * [`get_time_series_for` usage](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#get_time_series_for-usage) - * [Example](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#example) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/get/get-names.mdx#syntax) + * [`get_time_series_for` usage](#get_time_series_for-usage) + * [Example](#example) + * [Syntax](#syntax) ## `get_time_series_for` usage diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx index 290b4be501..4b17d3b2ea 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; without any additional server calls. * In this page: - * [Include time series when making a raw query](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#include-time-series-when-making-a-raw-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#syntax) + * [Include time series when making a raw query](#include-time-series-when-making-a-raw-query) + * [Syntax](#syntax) ## Include time series when making a raw query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx index 17234c800f..e0d9622a0e 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-raw-queries-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; without any additional server calls. * In this page: - * [Include time series when making a raw query](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#include-time-series-when-making-a-raw-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx#syntax) + * [Include time series when making a raw query](#include-time-series-when-making-a-raw-query) + * [Syntax](#syntax) ## Include time series when making a raw query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx index ce6d837e6a..3a2ad360a7 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when loading a document](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#include-time-series-when-loading-a-document) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#syntax) + * [Include time series when loading a document](#include-time-series-when-loading-a-document) + * [Syntax](#syntax) ## Include time series when loading a document diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx index 5d4b285950..be96ff6baf 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-load-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when loading a document](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#include-time-series-when-loading-a-document) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-load.mdx#syntax) + * [Include time series when loading a document](#include-time-series-when-loading-a-document) + * [Syntax](#syntax) ## Include time series when loading a document diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx index 440399f7c0..867e266cf3 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-csharp.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when making a query](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#include-time-series-when-making-a-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#syntax) + * [Include time series when making a query](#include-time-series-when-making-a-query) + * [Syntax](#syntax) ## Include time series when making a query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx index 29bf72b12c..a1ab83ff58 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/client-api/session/include/content/_with-session-query-nodejs.mdx @@ -12,8 +12,8 @@ import CodeBlock from '@theme/CodeBlock'; and can be provided instantly when requested without any additional server calls. * In this page: - * [Include time series when making a query](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#include-time-series-when-making-a-query) - * [Syntax](../../../../../../document-extensions/timeseries/client-api/session/include/with-session-query.mdx#syntax) + * [Include time series when making a query](#include-time-series-when-making-a-query) + * [Syntax](#syntax) ## Include time series when making a query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-csharp.mdx index 3a5e3e859e..88a3fa8688 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-csharp.mdx @@ -10,17 +10,17 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB time series are stored and managed as document extensions, achieving much greater speed and efficiency compared to storing them as JSON-formatted data within a document. * In this page: - * [Time series architecture](../../../document-extensions/timeseries/design.mdx#time-series-architecture) - * [Time series as a document extension](../../../document-extensions/timeseries/design.mdx#time-series-as-a--document-extension) - * [The `HasTimeSeries` flag](../../../document-extensions/timeseries/design.mdx#the--flag) - * [The time series entry](../../../document-extensions/timeseries/design.mdx#the-time-series-entry) - * [Segmentation](../../../document-extensions/timeseries/design.mdx#segmentation) - * [Compression](../../../document-extensions/timeseries/design.mdx#compression) - * [Updating time series](../../../document-extensions/timeseries/design.mdx#updating-time-series) - * [Document change](../../../document-extensions/timeseries/design.mdx#document-change) - * [No conflicts](../../../document-extensions/timeseries/design.mdx#no-conflicts) - * [Transactions](../../../document-extensions/timeseries/design.mdx#transactions) - * [Case insensitive](../../../document-extensions/timeseries/design.mdx#case-insensitive) + * [Time series architecture](#time-series-architecture) + * [Time series as a document extension](#time-series-as-a--document-extension) + * [The `HasTimeSeries` flag](#the--flag) + * [The time series entry](#the-time-series-entry) + * [Segmentation](#segmentation) + * [Compression](#compression) + * [Updating time series](#updating-time-series) + * [Document change](#document-change) + * [No conflicts](#no-conflicts) + * [Transactions](#transactions) + * [Case insensitive](#case-insensitive) ## Time series architecture @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; * The document and the time series reference each another: * The document's metadata keeps a reference to the time series **name**. The time series **data** itself is stored in a separate location. - * The [segments](../../../document-extensions/timeseries/design.mdx#segmentation) containing the time series data keep a reference to the document ID. + * The [segments](#segmentation) containing the time series data keep a reference to the document ID. ### The `HasTimeSeries` flag * When a document has one or more time series, diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-nodejs.mdx index 8082b97622..33967b5c53 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_design-nodejs.mdx @@ -10,17 +10,17 @@ import CodeBlock from '@theme/CodeBlock'; * RavenDB time series are stored and managed as document extensions, achieving much greater speed and efficiency compared to storing them as JSON-formatted data within a document. * In this page: - * [Time series architecture](../../../document-extensions/timeseries/design.mdx#time-series-architecture) - * [Time series as a document extension](../../../document-extensions/timeseries/design.mdx#time-series-as-a--document-extension) - * [The `HasTimeSeries` flag](../../../document-extensions/timeseries/design.mdx#the--flag) - * [The time series entry](../../../document-extensions/timeseries/design.mdx#the-time-series-entry) - * [Segmentation](../../../document-extensions/timeseries/design.mdx#segmentation) - * [Compression](../../../document-extensions/timeseries/design.mdx#compression) - * [Updating time series](../../../document-extensions/timeseries/design.mdx#updating-time-series) - * [Document change](../../../document-extensions/timeseries/design.mdx#document-change) - * [No conflicts](../../../document-extensions/timeseries/design.mdx#no-conflicts) - * [Transactions](../../../document-extensions/timeseries/design.mdx#transactions) - * [Case insensitive](../../../document-extensions/timeseries/design.mdx#case-insensitive) + * [Time series architecture](#time-series-architecture) + * [Time series as a document extension](#time-series-as-a--document-extension) + * [The `HasTimeSeries` flag](#the--flag) + * [The time series entry](#the-time-series-entry) + * [Segmentation](#segmentation) + * [Compression](#compression) + * [Updating time series](#updating-time-series) + * [Document change](#document-change) + * [No conflicts](#no-conflicts) + * [Transactions](#transactions) + * [Case insensitive](#case-insensitive) ## Time series architecture @@ -31,7 +31,7 @@ import CodeBlock from '@theme/CodeBlock'; * The document and the time series reference each another: * The document's metadata keeps a reference to the time series **name**. The time series **data** itself is stored in a separate location. - * The [segments](../../../document-extensions/timeseries/design.mdx#segmentation) containing the time series data keep a reference to the document ID. + * The [segments](#segmentation) containing the time series data keep a reference to the document ID. ### The `HasTimeSeries` flag * When a document has one or more time series, diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-csharp.mdx index 16de1783f5..3e6b127581 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-csharp.mdx @@ -10,15 +10,15 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Map index - index all time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-single-collection) - * [Map index - index all time series from all collections](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-all-collections) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Map index - index all time series from single collection](#map-index---index-all-time-series-from-single-collection) + * [Map index - index all time series from all collections](#map-index---index-all-time-series-from-all-collections) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -50,7 +50,7 @@ from entry in segment * Values & timestamp of a time series entry * The entry tag * Content from a document referenced by the tag - * Properties of the containing segment (see **[`TimeSeriesSegment`](../../../document-extensions/timeseries/indexing.mdx#section-5)**) + * Properties of the containing segment (see **[`TimeSeriesSegment`](#section-5)**) * Document index: @@ -80,16 +80,16 @@ from entry in segment There are two main ways to create a time series index: 1. Create a class that inherits from one of the following abstract index creation task classes: - * [`AbstractTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section) + * [`AbstractTimeSeriesIndexCreationTask`](#section) for [map](../../../indexes/map-indexes.mdx) and [map-reduce](../../../indexes/map-reduce-indexes.mdx) time series indexes. - * [`AbstractMultiMapTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section-1) + * [`AbstractMultiMapTimeSeriesIndexCreationTask`](#section-1) for [multi-map](../../../indexes/multi-map-indexes.mdx) time series indexes. - * [`AbstractJavaScriptTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section-2) + * [`AbstractJavaScriptTimeSeriesIndexCreationTask`](#section-2) for static [javascript indexes](../../../indexes/javascript-indexes.mdx). 2. Deploy a time series index definition via [PutIndexesOperation](../../../client-api/operations/maintenance/indexes/put-indexes.mdx): - * Create a [`TimeSeriesIndexDefinition`](../../../document-extensions/timeseries/indexing.mdx#section-3) directly. - * Create a strongly typed index definition using [`TimeSeriesIndexDefinitionBuilder`](../../../document-extensions/timeseries/indexing.mdx#section-4). + * Create a [`TimeSeriesIndexDefinition`](#section-3) directly. + * Create a strongly typed index definition using [`TimeSeriesIndexDefinitionBuilder`](#section-4). @@ -102,7 +102,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-nodejs.mdx index 56d10e47a9..74a6f3844f 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-nodejs.mdx @@ -10,15 +10,15 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Map index - index all time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-single-collection) - * [Map index - index all time series from all collections](../../../document-extensions/timeseries/indexing.mdx#map-index---index-all-time-series-from-all-collections) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Map index - index all time series from single collection](#map-index---index-all-time-series-from-single-collection) + * [Map index - index all time series from all collections](#map-index---index-all-time-series-from-all-collections) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -40,7 +40,7 @@ import CodeBlock from '@theme/CodeBlock'; * Values & timestamp of a time series entry * The entry tag * Content from a document referenced by the tag - * Properties of the containing segment (see **[segment properties](../../../document-extensions/timeseries/indexing.mdx#segment-properties)**) + * Properties of the containing segment (see **[segment properties](#segment-properties)**) * Document index: @@ -61,9 +61,9 @@ import CodeBlock from '@theme/CodeBlock'; There are two main ways to create a time series index: -1. Create a class that inherits from the abstract index class [`AbstractRawJavaScriptTimeSeriesIndexCreationTask`](../../../document-extensions/timeseries/indexing.mdx#section). +1. Create a class that inherits from the abstract index class [`AbstractRawJavaScriptTimeSeriesIndexCreationTask`](#section). -2. Create a [`TimeSeriesIndexDefinition`](../../../document-extensions/timeseries/indexing.mdx#section-1) +2. Create a [`TimeSeriesIndexDefinition`](#section-1) and deploy the time series index definition via [PutIndexesOperation](../../../client-api/operations/maintenance/indexes/put-indexes.mdx). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-php.mdx index 12e10e45bc..28cac6ba4a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-php.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -100,7 +100,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-python.mdx index 578928c705..14fef78a5e 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_indexing-python.mdx @@ -10,13 +10,13 @@ import CodeBlock from '@theme/CodeBlock'; * Indexing allows for fast retrieval of the indexed time series data when querying a time series. * In this page: - * [Time series indexes vs Document indexes](../../../document-extensions/timeseries/indexing.mdx#time-series-indexes-vs-document-indexes) - * [Ways to create a time series index](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) - * [Examples of time series indexes](../../../document-extensions/timeseries/indexing.mdx#examples-of-time-series-indexes) - * [Map index - index single time series from single collection](../../../document-extensions/timeseries/indexing.mdx#map-index---index-single-time-series-from-single-collection) - * [Multi-Map index - index time series from several collections](../../../document-extensions/timeseries/indexing.mdx#multi-map-index---index-time-series-from-several-collections) - * [Map-Reduce index](../../../document-extensions/timeseries/indexing.mdx#map-reduce-index) - * [Syntax](../../../document-extensions/timeseries/indexing.mdx#syntax) + * [Time series indexes vs Document indexes](#time-series-indexes-vs-document-indexes) + * [Ways to create a time series index](#ways-to-create-a-time-series-index) + * [Examples of time series indexes](#examples-of-time-series-indexes) + * [Map index - index single time series from single collection](#map-index---index-single-time-series-from-single-collection) + * [Multi-Map index - index time series from several collections](#multi-map-index---index-time-series-from-several-collections) + * [Map-Reduce index](#map-reduce-index) + * [Syntax](#syntax) ## Time series indexes vs Document indexes @@ -100,7 +100,7 @@ There are two main ways to create a time series index: * In addition, we index the containing document id (`DocumentID`), which is obtained from the segment, and some content from the document referenced by the entry's Tag (`EmployeeName`). -* Each tab below presents one of the different [ways](../../../document-extensions/timeseries/indexing.mdx#ways-to-create-a-time-series-index) the index can be defined. +* Each tab below presents one of the different [ways](#ways-to-create-a-time-series-index) the index can be defined. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx index 40b95ba56b..e4e91ef7a9 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-csharp.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx index bb25a54a65..481be1efa2 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-nodejs.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-php.mdx index ee00a617c8..48927b8f8a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-php.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-python.mdx index f43509620d..a1e305095d 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_rollup-and-retention-python.mdx @@ -15,11 +15,11 @@ Many time series applications produce massive amounts of data at a steady rate. Controlling the duration for which time series data is kept before deletion. * In this page: - * [Time series policies](../../../document-extensions/timeseries/rollup-and-retention.mdx#time-series-policies) - * [Examples](../../../document-extensions/timeseries/rollup-and-retention.mdx#examples) - * [Create time series policy](../../../document-extensions/timeseries/rollup-and-retention.mdx#create-time-series-policies) - * [Retrieve rollup data](../../../document-extensions/timeseries/rollup-and-retention.mdx#retrieve-rollup-data) - * [Syntax](../../../document-extensions/timeseries/rollup-and-retention.mdx#syntax) + * [Time series policies](#time-series-policies) + * [Examples](#examples) + * [Create time series policy](#create-time-series-policies) + * [Retrieve rollup data](#retrieve-rollup-data) + * [Syntax](#syntax) ## Time series policies diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx index e98afc66bb..a438877c8c 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; or they have their own pages describing their interaction with time series (such as [indexing](../../../document-extensions/timeseries/indexing.mdx)). * In this page: - * [General features](../../../document-extensions/timeseries/time-series-and-other-features.mdx#general-features) - * [Smuggler](../../../document-extensions/timeseries/time-series-and-other-features.mdx#smuggler) - * [Ongoing tasks](../../../document-extensions/timeseries/time-series-and-other-features.mdx#ongoing-tasks) - * [Revisions](../../../document-extensions/timeseries/time-series-and-other-features.mdx#revisions) + * [General features](#general-features) + * [Smuggler](#smuggler) + * [Ongoing tasks](#ongoing-tasks) + * [Revisions](#revisions) ## General features diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx index 3e308bfa21..ba1c9cb870 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/content/_time-series-and-other-features-nodejs.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; or they have their own pages describing their interaction with time series (such as [indexing](../../../document-extensions/timeseries/indexing.mdx)). * In this page: - * [General features](../../../document-extensions/timeseries/time-series-and-other-features.mdx#general-features) - * [Smuggler](../../../document-extensions/timeseries/time-series-and-other-features.mdx#smuggler) - * [Ongoing tasks](../../../document-extensions/timeseries/time-series-and-other-features.mdx#ongoing-tasks) - * [Revisions](../../../document-extensions/timeseries/time-series-and-other-features.mdx#revisions) + * [General features](#general-features) + * [Smuggler](#smuggler) + * [Ongoing tasks](#ongoing-tasks) + * [Revisions](#revisions) ## General features diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx index ec2739d411..42712f2ed4 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Javascript Support](../../../../document-extensions/timeseries/client-api/javascript-support.mdx) has been extended to support incremental time series. -* You can use the Javascript [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#timeseriesincrement) +* You can use the Javascript [timeseries.increment](#timeseriesincrement) method to create and modify incremental time series and their entries. The method behaves the same way it does when it is called [using C#](../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx). @@ -32,9 +32,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [timeseries.get](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) * In this page: - * [The `timeseries` Interface](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#the-timeseries-interface) - * [`timeseries.increment`](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#timeseriesincrement) - * [Usage Sample](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#usage-sample) + * [The `timeseries` Interface](#the-timeseries-interface) + * [`timeseries.increment`](#timeseriesincrement) + * [Usage Sample](#usage-sample) @@ -49,7 +49,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; | name | `string` | Incremental time series Name (e.g. `INC:StockPrice`) | * Use one of the following methods to access the chosen time series: - * [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#the-timeseries-interface) + * [timeseries.increment](#the-timeseries-interface) * [timeseries.delete](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-2) * [timeseries.get](../../../../document-extensions/timeseries/client-api/javascript-support.mdx#section-3) diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx index 242a636808..6ed4cf776e 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Using this method, you can retrieve node values from incremental time series entries. * In this page: - * [`GetTimeSeriesOperation`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#gettimeseriesoperation) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/operations/get.mdx#usage-sample) + * [`GetTimeSeriesOperation`](#gettimeseriesoperation) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#usage-sample) ## `GetTimeSeriesOperation` diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx index 32446f9fe3..9b5e823a67 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx @@ -19,10 +19,10 @@ Delete a range of incremental time series entries using `IncrementalTimeSeriesFo * You can delete a **single entry** or a **range of entries**. * In this page: - * [`IncrementalTimeSeriesFor.Delete`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#incrementaltimeseriesfordelete) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx#code-samples) + * [`IncrementalTimeSeriesFor.Delete`](#incrementaltimeseriesfordelete) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#code-samples) ## `IncrementalTimeSeriesFor.Delete` diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx index 1d770d095d..6bac859df2 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx @@ -29,9 +29,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`IncrementalTimeSeriesFor.Get`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#incrementaltimeseriesforget) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#usage-flow) + * [`IncrementalTimeSeriesFor.Get`](#incrementaltimeseriesforget) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) * [Code Samples](../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#code-samples) diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx index a2fff94be1..fc3a1d940b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx @@ -25,10 +25,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; `session.SaveChanges`, to create multiple entries in a single transaction. * In this page: - * [`IncrementalTimeSeriesFor.Increment`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#timeseriesforappend) - * [Syntax](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#syntax) - * [Usage Flow](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#usage-flow) - * [Code Samples](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx#code-samples) + * [`IncrementalTimeSeriesFor.Increment`](#timeseriesforappend) + * [Syntax](#syntax) + * [Usage Flow](#usage-flow) + * [Code Samples](#code-samples) ## `IncrementalTimeSeriesFor.Increment` diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx index 485e11536e..7959c79247 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx @@ -27,9 +27,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * and Increase a value by some delta. * In this page: - * [Session API Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#session-api-methods) - * [IncrementalTimeSeriesFor Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#methods) - * [Additional Session Methods](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#additional-session-methods) + * [Session API Methods](#session-api-methods) + * [IncrementalTimeSeriesFor Methods](#methods) + * [Additional Session Methods](#additional-session-methods) ## Session API Methods ### `IncrementalTimeSeriesFor` Methods diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/overview.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/overview.mdx index 7fc579aca2..8560c5417b 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/overview.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/incremental-time-series/overview.mdx @@ -29,9 +29,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and via [Studio](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series). * In this page: - * [What are Incremental Time Series and Why Use Them](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#what-are-incremental-time-series-and-why-use-them) - * [Incremental Time Series -vs- Non-incremental Time Series](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#incremental-time-series--vs--non-incremental-time-series) - * [Incremental Time Series Structure](../../../document-extensions/timeseries/incremental-time-series/overview.mdx#incremental-time-series-structure) + * [What are Incremental Time Series and Why Use Them](#what-are-incremental-time-series-and-why-use-them) + * [Incremental Time Series -vs- Non-incremental Time Series](#incremental-time-series--vs--non-incremental-time-series) + * [Incremental Time Series Structure](#incremental-time-series-structure) diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/overview.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/overview.mdx index e8a9956cf2..d7642ec819 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/overview.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/overview.mdx @@ -28,20 +28,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Time series data is **compressed** to lower storage usage and transaction time. * In this page: - * [Overview](../../document-extensions/timeseries/overview.mdx#overview) - * [RavenDB's Time Series Implementation](../../document-extensions/timeseries/overview.mdx#ravendbs-time-series-implementation) - * [Distributed Time Series](../../document-extensions/timeseries/overview.mdx#distributed-time-series) - * [Time Series as Document Extensions](../../document-extensions/timeseries/overview.mdx#time-series-as-document-extensions) - * [Time Series Features](../../document-extensions/timeseries/overview.mdx#time-series-features) - * [Time Series Data](../../document-extensions/timeseries/overview.mdx#time-series-data) - * [Separate Name and Data Storage](../../document-extensions/timeseries/overview.mdx#separate-name-and-data-storage) - * [Time Series Segments](../../document-extensions/timeseries/overview.mdx#time-series-segments) - * [Transactions Performance](../../document-extensions/timeseries/overview.mdx#transactions-performance) - * [Common-Queries Performance](../../document-extensions/timeseries/overview.mdx#common-queries-performance) - * [Time Series Entries](../../document-extensions/timeseries/overview.mdx#time-series-entries) - * [Timestamps](../../document-extensions/timeseries/overview.mdx#timestamps) - * [Values](../../document-extensions/timeseries/overview.mdx#values) - * [Tags](../../document-extensions/timeseries/overview.mdx#tags) + * [Overview](#overview) + * [RavenDB's Time Series Implementation](#ravendbs-time-series-implementation) + * [Distributed Time Series](#distributed-time-series) + * [Time Series as Document Extensions](#time-series-as-document-extensions) + * [Time Series Features](#time-series-features) + * [Time Series Data](#time-series-data) + * [Separate Name and Data Storage](#separate-name-and-data-storage) + * [Time Series Segments](#time-series-segments) + * [Transactions Performance](#transactions-performance) + * [Common-Queries Performance](#common-queries-performance) + * [Time Series Entries](#time-series-entries) + * [Timestamps](#timestamps) + * [Values](#values) + * [Tags](#tags) ## Overview @@ -94,7 +94,7 @@ Notable time series features include - * **Highly-Efficient Storage Management** Time series data is [compressed](../../document-extensions/timeseries/design.mdx#compression) - and [segmented](../../document-extensions/timeseries/overview.mdx#time-series-segments) to minimize storage usage and transmission time. + and [segmented](#time-series-segments) to minimize storage usage and transmission time. * **A Thorough Set of API Methods** The [time series API](../../document-extensions/timeseries/client-api/overview.mdx) includes a variety of `session methods` and `store operations`. * **Full GUI Support** @@ -102,7 +102,7 @@ Notable time series features include - * **Time Series Indexing** Time series can be [indexed](../../document-extensions/timeseries/indexing.mdx). * **Time Series Querying and Aggregation** - * [High-performance common queries](../../document-extensions/timeseries/overview.mdx#common-queries-performance) + * [High-performance common queries](#common-queries-performance) The results of a set of common queries are prepared in advance in time series segments' headers, so the response to querying for a series minimum value, for example, is returned nearly instantly. * [LINQ and raw RQL queries](../../document-extensions/timeseries/querying/overview-and-syntax.mdx) @@ -125,10 +125,10 @@ Notable time series features include - ## Time Series Data Time series **names** are kept in their parent documents' metadata, while their -**data** is kept [separately](../../document-extensions/timeseries/overview.mdx#separate-name-and-data-storage). +**data** is kept [separately](#separate-name-and-data-storage). Time series data is **compressed** and composed of consecutive -[segments](../../document-extensions/timeseries/overview.mdx#time-series-segments) and -[entries](../../document-extensions/timeseries/overview.mdx#time-series-entries). +[segments](#time-series-segments) and +[entries](#time-series-entries). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx index bf0e24a5b8..4fb1ea586a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-csharp.mdx @@ -12,16 +12,16 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Group by dynamic criteria](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#group-by-dynamic-criteria) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) - * [Syntax](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#syntax) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Group by dynamic criteria](#group-by-dynamic-criteria) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) + * [Syntax](#syntax) ## Grouping and aggregation options diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx index fcfeddad06..6b4cb727d2 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-nodejs.mdx @@ -12,14 +12,14 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) ## Grouping and aggregation options diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx index c685a79942..99456fec1d 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_aggregation-and-projections-php.mdx @@ -10,14 +10,14 @@ import CodeBlock from '@theme/CodeBlock'; such as an hour or a week. * In this page: - * [Grouping and aggregation options](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#grouping-and-aggregation-options) - * [Examples](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#examples) - * [Aggregate entries with single value](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-single-value) - * [Aggregate entries with multiple values](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-with-multiple-values) - * [Aggregate entries without grouping by time frame](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-without-grouping-by-time-frame) - * [Aggregate entries filtered by referenced document](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#aggregate-entries-filtered-by-referenced-document) - * [Secondary grouping by tag](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#secondary-grouping-by-tag) - * [Project document data in addition to aggregated data](../../../../document-extensions/timeseries/querying/aggregation-and-projections.mdx#project-document-data-in-addition-to-aggregated-data) + * [Grouping and aggregation options](#grouping-and-aggregation-options) + * [Examples](#examples) + * [Aggregate entries with single value](#aggregate-entries-with-single-value) + * [Aggregate entries with multiple values](#aggregate-entries-with-multiple-values) + * [Aggregate entries without grouping by time frame](#aggregate-entries-without-grouping-by-time-frame) + * [Aggregate entries filtered by referenced document](#aggregate-entries-filtered-by-referenced-document) + * [Secondary grouping by tag](#secondary-grouping-by-tag) + * [Project document data in addition to aggregated data](#project-document-data-in-addition-to-aggregated-data) ## Grouping and aggregation options diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx index db1a0ce715..caff435b91 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx index a8646ada3d..634a82341c 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx index a91e80170b..6b27c8b1c4 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-php.mdx @@ -9,12 +9,12 @@ import CodeBlock from '@theme/CodeBlock'; such as those collected in the last 7 days. * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx index ab5d0bf799..fd54d0e3da 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_choosing-query-range-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries and their syntax, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Choose range in a query](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range-in-a-query) - * [Specify range](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#specify-range) - * [Retrieve first or last entries](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#retrieve-first-or-last-entries) - * [Choose range - RQL syntax](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#choose-range---rql-syntax) - * [`between` and `and`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and-) - * [`first` and `last`](../../../../document-extensions/timeseries/querying/choosing-query-range.mdx#and--1) + * [Choose range in a query](#choose-range-in-a-query) + * [Specify range](#specify-range) + * [Retrieve first or last entries](#retrieve-first-or-last-entries) + * [Choose range - RQL syntax](#choose-range---rql-syntax) + * [`between` and `and`](#and-) + * [`first` and `last`](#and--1) ## Choose range in a query diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-csharp.mdx index 2cb42b54a6..1a00c3c2fb 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-csharp.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx index 3834e2d6ae..5456c0cf5a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; * For an overview of the available time series queries, please refer to [Time series querying](../../../../document-extensions/timeseries/client-api/session/querying.mdx). * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-php.mdx index 000c2f9ed5..6f373aadbe 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-php.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; you can filter the time series entries by their **values**, **tag**, or by the contents of a **document referenced in the tag**. * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-python.mdx index 0ff2cb3a8a..97593a4a9a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_filtering-python.mdx @@ -9,9 +9,9 @@ In addition to limiting time series query results by specifying the [range of en you can filter the time series entries by their **values**, **tag**, or by the contents of a **document referenced in the tag**. * In this page: - * [Filter by value](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-value) - * [Filter by tag](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-tag) - * [Filter by referenced document](../../../../document-extensions/timeseries/querying/filtering.mdx#filter-by-referenced-document) + * [Filter by value](#filter-by-value) + * [Filter by tag](#filter-by-tag) + * [Filter by referenced document](#filter-by-referenced-document) ## Filter by value diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx index aa202e76f8..cc9952cff1 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-csharp.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-java.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-java.mdx index 6f74171f6b..a624a042f4 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-java.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx index df0f6d1715..b357fcb810 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_gap-filling-nodejs.mdx @@ -15,8 +15,8 @@ import CodeBlock from '@theme/CodeBlock'; either side. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/gap-filling.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/gap-filling.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx index 7d05540ca3..9175ece3f6 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-csharp.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -141,8 +141,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx index 406541fdcc..cfb80c5c2a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-nodejs.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -166,8 +166,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx index 2fa03898bc..0cbdccc2fb 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-php.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -140,8 +140,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx index 06112a58f9..c6218031fc 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_overview-and-syntax-python.mdx @@ -13,15 +13,15 @@ import CodeBlock from '@theme/CodeBlock'; * Queries can be executed as dynamic queries or over [time series indexes](../../../../document-extensions/timeseries/indexing.mdx). * In this page: - * [Time series query capabilities](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#time-series-query-capabilities) - * [Server and client queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#server-and-client-queries) - * [Dynamic and index queries](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#dynamic-and-index-queries) - * [Scaling query results](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) - * [RQL syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#rql-syntax) - * [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) - * [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) - * [Combine time series and custom functions](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#combine-time-series-and-custom-functions) - * [Use Studio To experiment](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#use-studio-to-experiment) + * [Time series query capabilities](#time-series-query-capabilities) + * [Server and client queries](#server-and-client-queries) + * [Dynamic and index queries](#dynamic-and-index-queries) + * [Scaling query results](#scaling-query-results) + * [RQL syntax](#rql-syntax) + * [`select timeseries` syntax](#section) + * [`declare timeseries` syntax](#section-1) + * [Combine time series and custom functions](#combine-time-series-and-custom-functions) + * [Use Studio To experiment](#use-studio-to-experiment) ## Time series query capabilities @@ -141,8 +141,8 @@ where Birthday < '1994-01-01' Then, you can query their time series entries using either of the following two equivalent syntaxes: -* [`select timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section) -* [`declare timeseries` syntax](../../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#section-1) +* [`select timeseries` syntax](#section) +* [`declare timeseries` syntax](#section-1) ### `select timeseries` This syntax allows you to encapsulate your query's time series functionality in a `select timeseries` section. diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx index 3fc119b2ee..7f3379035a 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; 2. Stream time series query results. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx index 1f249c966b..17a1cf6c06 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_stream-timeseries-java.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; 2. Stream time series query results. * In this page: - * [Syntax](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#syntax) - * [Examples](../../../../document-extensions/timeseries/querying/stream-timeseries.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx index d6cf333203..0d8529bdbc 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-csharp.mdx @@ -24,17 +24,17 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) - * [Syntax](../../../../document-extensions/timeseries/querying/using-indexes.mdx#syntax) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) + * [Syntax](#syntax) ## Sample Index @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx index a051729e29..4c6d93a2f7 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-nodejs.mdx @@ -24,16 +24,16 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) ## Sample Index @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will in the shape of the defined index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-php.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-php.mdx index 553e1a5486..286530ec41 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-php.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-php.mdx @@ -24,16 +24,16 @@ import CodeBlock from '@theme/CodeBlock'; * When querying a **time series index**: each item in the results is of the type defined by the **index-entry** in the index definition, - (unless results are [projected](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results)). + (unless results are [projected](#project-results)). The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) ## Sample Index @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-python.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-python.mdx index 3799e370b0..c37b18e8ce 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-python.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/content/_using-indexes-python.mdx @@ -28,13 +28,13 @@ import CodeBlock from '@theme/CodeBlock'; The documents themselves are not returned. * In this page: - * [Sample index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#sample-index) - * [Querying the index](../../../../document-extensions/timeseries/querying/using-indexes.mdx#querying-the-index) - * [Query all time series entries](../../../../document-extensions/timeseries/querying/using-indexes.mdx#query-all-time-series-entries) - * [Filter query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#filter-query-results) - * [Order query results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#order-query-results) - * [Project results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results) - * [Syntax](../../../../document-extensions/timeseries/querying/using-indexes.mdx#syntax) + * [Sample index](#sample-index) + * [Querying the index](#querying-the-index) + * [Query all time series entries](#query-all-time-series-entries) + * [Filter query results](#filter-query-results) + * [Order query results](#order-query-results) + * [Project results](#project-results) + * [Syntax](#syntax) ## Sample Index @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * When querying this time series index: * The resulting items correspond to the time series entries that match the query predicate. * Each item in the results will be of type `TsIndex.IndexEntry`, which is the index-entry. - Different result types may be returned when the query [projects the results](../../../../document-extensions/timeseries/querying/using-indexes.mdx#project-results). + Different result types may be returned when the query [projects the results](#project-results). diff --git a/versioned_docs/version-7.1/document-extensions/timeseries/querying/statistics.mdx b/versioned_docs/version-7.1/document-extensions/timeseries/querying/statistics.mdx index 359a7b9dc9..ad2ef968ca 100644 --- a/versioned_docs/version-7.1/document-extensions/timeseries/querying/statistics.mdx +++ b/versioned_docs/version-7.1/document-extensions/timeseries/querying/statistics.mdx @@ -22,8 +22,8 @@ one measure for the first values in each entry, another measure for the second values in each entry, and so on. * In this page: - * [Syntax](../../../document-extensions/timeseries/querying/statistics.mdx#syntax) - * [Examples](../../../document-extensions/timeseries/querying/statistics.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax @@ -47,7 +47,7 @@ series or range of time series entries. It takes one `double` value that is grea 0 and less than or equal to 100. This represents the percent of the time series values that should be smaller than the result. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Slope * RQL method: `slope()` @@ -63,7 +63,7 @@ the time series, grouping the entries into whole numbers of time units. The difference in time is measured in milliseconds. Use [scaling](../../../document-extensions/timeseries/querying/overview-and-syntax.mdx#scaling-query-results) to adjust the results to your preferred units. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Standard Deviation * RQL method: `stddev()` @@ -72,7 +72,7 @@ See examples [below](../../../document-extensions/timeseries/querying/statistics These methods return the [standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) of time series values. -See examples [below](../../../document-extensions/timeseries/querying/statistics.mdx#examples). +See examples [below](#examples). ### Result Format Queries with these methods return results with the following format: diff --git a/versioned_docs/version-7.1/indexes/additional-assemblies.mdx b/versioned_docs/version-7.1/indexes/additional-assemblies.mdx index 1138885ca2..b43d9eeb90 100644 --- a/versioned_docs/version-7.1/indexes/additional-assemblies.mdx +++ b/versioned_docs/version-7.1/indexes/additional-assemblies.mdx @@ -30,11 +30,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; all of the index's Additional Assemblies. * In this page: - * [Syntax](../indexes/additional-assemblies.mdx#syntax) - * [Examples](../indexes/additional-assemblies.mdx#examples) - * [Basic Example](../indexes/additional-assemblies.mdx#basic-example) - * [Complex Example](../indexes/additional-assemblies.mdx#complex-example) - * [Pre-Release Packages](../indexes/additional-assemblies.mdx#pre-release-packages) + * [Syntax](#syntax) + * [Examples](#examples) + * [Basic Example](#basic-example) + * [Complex Example](#complex-example) + * [Pre-Release Packages](#pre-release-packages) ## Syntax diff --git a/versioned_docs/version-7.1/indexes/content/_boosting-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_boosting-csharp.mdx index bc754e4316..b3c3da96d0 100644 --- a/versioned_docs/version-7.1/indexes/content/_boosting-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_boosting-csharp.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -284,7 +284,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** * When using **Corax** as the underlying indexing engine, a boost factor can only be assigned - to the [index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + to the [index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an _index-field_ is Not supported. * When using **Lucene**, a boost factor can be assigned to both the index-field and the whole index-entry. diff --git a/versioned_docs/version-7.1/indexes/content/_boosting-java.mdx b/versioned_docs/version-7.1/indexes/content/_boosting-java.mdx index 95e8765ded..5f9a1b97a9 100644 --- a/versioned_docs/version-7.1/indexes/content/_boosting-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_boosting-java.mdx @@ -8,7 +8,7 @@ a basic score is calculated for each document in the results by the underlying e Providing a **boost value** to some fields allows you to prioritize the resulting documents. The boost value is integrated with the basic score, making the document rank higher. -Automatic ordering of the results by the score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +Automatic ordering of the results by the score is [configurable](#automatic-score-based-ordering). From the index perspective we can associate to an index entry a boosting factor. The higher value it has, the more relevant term will be. To do this, we must use the `Boost` method. diff --git a/versioned_docs/version-7.1/indexes/content/_boosting-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_boosting-nodejs.mdx index efc4f24547..8bf72e6c8b 100644 --- a/versioned_docs/version-7.1/indexes/content/_boosting-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_boosting-nodejs.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -160,7 +160,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** - * When using **Corax** as the underlying indexing engine, you can only [assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + * When using **Corax** as the underlying indexing engine, you can only [assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an index-field is Not supported. * When using **Lucene**, you can assign a boost factor to both the index-field and the whole index-entry. diff --git a/versioned_docs/version-7.1/indexes/content/_boosting-php.mdx b/versioned_docs/version-7.1/indexes/content/_boosting-php.mdx index 5a96af9b0b..db0514d9f5 100644 --- a/versioned_docs/version-7.1/indexes/content/_boosting-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_boosting-php.mdx @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; * Providing a **boost value** to selected fields allows prioritization of the resulting documents. The boos value is integrated with the basic score, increasing the document rank. -* The automatic ordering of results by their score is [configurable](../../indexes/boosting.mdx#automatic-score-based-ordering). +* The automatic ordering of results by their score is [configurable](#automatic-score-based-ordering). * Boosting can be achieved in the following ways: @@ -22,10 +22,10 @@ import CodeBlock from '@theme/CodeBlock'; By applying a boost factor in the index definition, as described in this article. * In this page: - * [Assign a boost factor to an index-field](../../indexes/boosting.mdx#assign-a-boost-factor-to-an-index-field) - * [Assign a boost factor to the index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry) - * [Automatic score-based ordering](../../indexes/boosting.mdx#automatic-score-based-ordering) - * [Corax vs Lucene: boosting differences](../../indexes/boosting.mdx#automatic-score-based-ordering) + * [Assign a boost factor to an index-field](#assign-a-boost-factor-to-an-index-field) + * [Assign a boost factor to the index-entry](#assign-a-boost-factor-to-the-index-entry) + * [Automatic score-based ordering](#automatic-score-based-ordering) + * [Corax vs Lucene: boosting differences](#automatic-score-based-ordering) ## Assign a boost factor to an index-field @@ -294,7 +294,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * **Boosting features available:** * When using **Corax** as the underlying indexing engine, a boost factor can only be assigned - to the [index-entry](../../indexes/boosting.mdx#assign-a-boost-factor-to-the-index-entry). + to the [index-entry](#assign-a-boost-factor-to-the-index-entry). Applying a boost factor to an _index-field_ is Not supported. * When using **Lucene**, a boost factor can be assigned to both the index-field and the whole index-entry. diff --git a/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-csharp.mdx index 6856468b70..8046059128 100644 --- a/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-csharp.mdx @@ -9,25 +9,25 @@ import CodeBlock from '@theme/CodeBlock'; For a general overview of indexes, see [What are indexes](../../indexes/what-are-indexes.mdx). * You can either: - * [create a Static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or - * let the RavenDB server [create an Auto-index](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) for you based on query patterns. + * [create a Static-index](#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or + * let the RavenDB server [create an Auto-index](#creating-auto-indexes) for you based on query patterns. * Static-indexes can be created: * using the Client API, as outlined in this article, or * from the [Indexes list view](../../studio/database/indexes/indexes-list-view.mdx) in the Studio. * In this page: - * [Static-indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Define a static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) - * [Deploy a static-index](../../indexes/creating-and-deploying.mdx#deploy-a-static-index) - * [Deploy single index](../../indexes/creating-and-deploying.mdx#deploy-single-index) - * [Deploy multiple indexes](../../indexes/creating-and-deploying.mdx#deploy-multiple-indexes) - * [Deploy syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) - * [Deployment behavior](../../indexes/creating-and-deploying.mdx#deployment-behavior) - * [Creating a static-index - Example](../../indexes/creating-and-deploying.mdx#create-a-static-index---example) - * [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Creating auto-indexes](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) - * [Disabling auto-indexes](../../indexes/creating-and-deploying.mdx#disabling-auto-indexes) + * [Static-indexes](#static-indexes) + * [Define a static-index](#define-a-static-index) + * [Deploy a static-index](#deploy-a-static-index) + * [Deploy single index](#deploy-single-index) + * [Deploy multiple indexes](#deploy-multiple-indexes) + * [Deploy syntax](#deploy-syntax) + * [Deployment behavior](#deployment-behavior) + * [Creating a static-index - Example](#create-a-static-index---example) + * [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation) + * [Auto-indexes](#auto-indexes) + * [Creating auto-indexes](#creating-auto-indexes) + * [Disabling auto-indexes](#disabling-auto-indexes) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; ##### Define a static-index using a custom class * To define a static-index using a custom class inherit from `AbstractIndexCreationTask`. -* This method is recommended over the [Creating an index using an operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) method +* This method is recommended over the [Creating an index using an operation](#create-a-static-index---using-an-operation) method for its simplicity and the following advantages: * **Strongly-typed syntax**: Provides strong typing when defining the index, making it easier to work with. @@ -65,7 +65,7 @@ public class Orders_ByTotal : AbstractIndexCreationTask `} -* A complete example of creating a static-index is provided [below](../../indexes/creating-and-deploying.mdx#create-a-static-index---example). +* A complete example of creating a static-index is provided [below](#create-a-static-index---example). @@ -105,13 +105,13 @@ public class Orders_ByTotal : AbstractIndexCreationTask * To begin indexing data, the index must be deployed to the server. * This section provides options for deploying indexes that inherit from `AbstractIndexCreationTask`. * To create and deploy an index using the `IndexDefinition` class via `PutIndexesOperation`, - see [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation). + see [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation). ##### Deploy single index * Use `Execute()` or `ExecuteIndex()` to deploy a single index. * The following examples deploy index `Ordes/ByTotal` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -156,7 +156,7 @@ await store.ExecuteIndexAsync(new Orders_ByTotal()); If it fails, it will repeat the execution by calling the `Execute` method for each index, one by one, in separate requests. * The following examples deploy indexes `Ordes/ByTotal` and `Employees/ByLastName` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -401,7 +401,7 @@ public static void Main(string[] args) * When using this operation: - * Unlike the [naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) used with indexes inheriting from `AbstractIndexCreationTask`, + * Unlike the [naming convention](#naming-convention) used with indexes inheriting from `AbstractIndexCreationTask`, you can choose any string-based name for the index. However, when querying, you must use that string-based name rather than the index class type. diff --git a/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-java.mdx b/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-java.mdx index 1c1717746a..157f5545f2 100644 --- a/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-java.mdx @@ -26,40 +26,40 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes created by issuing a query are called `dynamic` or `Auto` indexes. * They can be easily identified. Their name starts with the `Auto/` prefix. - * If no [Auto-Index](../../indexes/creating-and-deploying.mdx#auto-indexes) exists to satisfy a query, + * If no [Auto-Index](#auto-indexes) exists to satisfy a query, a new Auto-Index will be created and maintained automatically. * Indexes created explicitly by the user are called `static`. * [To use a Static Index in a query](../../indexes/querying/query-index.mdx), **you must specify the index in the query definition**. If you don't specify the index, RavenDB will look for an auto-index and potentially create a new one. * Static Indexes can be defined to do calculations, conversions, and various other processes behind the scenes, to prevent - doing these costly processes at query time (see [Using AbstractIndexCreationTask](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask), + doing these costly processes at query time (see [Using AbstractIndexCreationTask](#using-abstractindexcreationtask), our [map-indexes](../../indexes/map-indexes.mdx) article, [indexing multiple collections](../../indexes/multi-map-indexes.mdx), and [map-reduce indexing](../../indexes/map-reduce-indexes.mdx)). * In this page: - * [Static indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Using AbstractIndexCreationTask](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask) - * [Naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) - * [Sending to server](../../indexes/creating-and-deploying.mdx#sending-to-server) - * [Creating an index with custom configuration](../../indexes/creating-and-deploying.mdx#creating-an-index-with-custom-configuration) - * [Using assembly scanner](../../indexes/creating-and-deploying.mdx#using-assembly-scanner) - * [Example](../../indexes/creating-and-deploying.mdx#example) - * [Using maintenance operations](../../indexes/creating-and-deploying.mdx#using-maintenance-operations) - * [IndexDefinitionBuilder](../../indexes/creating-and-deploying.mdx#indexdefinitionbuilder) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Naming convention](../../indexes/creating-and-deploying.mdx#naming-convention-1) - * [Auto indexes and indexing state](../../indexes/creating-and-deploying.mdx#auto-indexes-and-indexing-state) - * [If indexes exhaust system resources](../../indexes/creating-and-deploying.mdx#if-indexes-exhaust-system-resources) + * [Static indexes](#static-indexes) + * [Using AbstractIndexCreationTask](#using-abstractindexcreationtask) + * [Naming convention](#naming-convention) + * [Sending to server](#sending-to-server) + * [Creating an index with custom configuration](#creating-an-index-with-custom-configuration) + * [Using assembly scanner](#using-assembly-scanner) + * [Example](#example) + * [Using maintenance operations](#using-maintenance-operations) + * [IndexDefinitionBuilder](#indexdefinitionbuilder) + * [Auto-indexes](#auto-indexes) + * [Naming convention](#naming-convention-1) + * [Auto indexes and indexing state](#auto-indexes-and-indexing-state) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) ## Static indexes -There are a couple of ways to create a `static index` and send it to the server. We can use [maintenance operations](../../indexes/creating-and-deploying.mdx#using-maintenance-operations) or create a [custom class](../../indexes/creating-and-deploying.mdx#using-abstractindexcreationtask). +There are a couple of ways to create a `static index` and send it to the server. We can use [maintenance operations](#using-maintenance-operations) or create a [custom class](#using-abstractindexcreationtask). --- diff --git a/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-nodejs.mdx index 115ae0d962..de899f305b 100644 --- a/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_creating-and-deploying-nodejs.mdx @@ -9,25 +9,25 @@ import CodeBlock from '@theme/CodeBlock'; For a general overview of indexes, see [What are indexes](../../indexes/what-are-indexes.mdx). * You can either: - * [create a Static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or - * let the RavenDB server [create an Auto-index](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) for you based on query patterns. + * [create a Static-index](#define-a-static-index) yourself, which involves **Defining** the index and **Deploying** it to the RavenDB server, or + * let the RavenDB server [create an Auto-index](#creating-auto-indexes) for you based on query patterns. * Static-indexes can be created: * using the Client API, as outlined in this article, or * from the [Indexes list view](../../studio/database/indexes/indexes-list-view.mdx) in the Studio. * In this page: - * [Static-indexes](../../indexes/creating-and-deploying.mdx#static-indexes) - * [Define a static-index](../../indexes/creating-and-deploying.mdx#define-a-static-index) - * [Deploy a static-index](../../indexes/creating-and-deploying.mdx#deploy-a-static-index) - * [Deploy single index](../../indexes/creating-and-deploying.mdx#deploy-single-index) - * [Deploy multiple indexes](../../indexes/creating-and-deploying.mdx#deploy-multiple-indexes) - * [Deploy syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) - * [Deployment behavior](../../indexes/creating-and-deploying.mdx#deployment-behavior) - * [Creating a static-index - Example](../../indexes/creating-and-deploying.mdx#create-a-static-index---example) - * [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) - * [Auto-indexes](../../indexes/creating-and-deploying.mdx#auto-indexes) - * [Creating auto-indexes](../../indexes/creating-and-deploying.mdx#creating-auto-indexes) - * [Disabling auto-indexes](../../indexes/creating-and-deploying.mdx#disabling-auto-indexes) + * [Static-indexes](#static-indexes) + * [Define a static-index](#define-a-static-index) + * [Deploy a static-index](#deploy-a-static-index) + * [Deploy single index](#deploy-single-index) + * [Deploy multiple indexes](#deploy-multiple-indexes) + * [Deploy syntax](#deploy-syntax) + * [Deployment behavior](#deployment-behavior) + * [Creating a static-index - Example](#create-a-static-index---example) + * [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation) + * [Auto-indexes](#auto-indexes) + * [Creating auto-indexes](#creating-auto-indexes) + * [Disabling auto-indexes](#disabling-auto-indexes) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; ##### Define a static-index using a custom class * To define a static-index using a custom class, extend the `AbstractJavaScriptIndexCreationTask` class. -* This method is recommended over the [Creating an index using an operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation) method +* This method is recommended over the [Creating an index using an operation](#create-a-static-index---using-an-operation) method for its simplified index definition, offering a straightforward way to define the index. @@ -58,7 +58,7 @@ import CodeBlock from '@theme/CodeBlock'; `} -* A complete example of creating a static-index is provided [below](../../indexes/creating-and-deploying.mdx#create-a-static-index---example). +* A complete example of creating a static-index is provided [below](#create-a-static-index---example). @@ -100,13 +100,13 @@ import CodeBlock from '@theme/CodeBlock'; * To begin indexing data, the index must be deployed to the server. * This section provides options for deploying indexes that inherit from `AbstractJavaScriptIndexCreationTask`. * To create and deploy an index using the `IndexDefinition` class via `PutIndexesOperation`, - see [Creating a static-index - using an Operation](../../indexes/creating-and-deploying.mdx#create-a-static-index---using-an-operation). + see [Creating a static-index - using an Operation](#create-a-static-index---using-an-operation). ##### Deploy single index * Use `execute()` or `executeIndex()` to deploy a single index. * The following examples deploy index `Ordes/ByTotal` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -132,7 +132,7 @@ await documentStore.executeIndex(new Orders_ByTotal()); If it fails, it will repeat the execution by calling the `execute` method for each index, one by one, in separate requests. * The following examples deploy indexes `Ordes/ByTotal` and `Employees/ByLastName` to the default database defined in your _DocumentStore_ object. - See the [syntax](../../indexes/creating-and-deploying.mdx#deploy-syntax) section below for all available overloads. + See the [syntax](#deploy-syntax) section below for all available overloads. @@ -275,7 +275,7 @@ async function main() \{ * When using this operation: - * Unlike the [naming convention](../../indexes/creating-and-deploying.mdx#naming-convention) used with indexes inheriting from `AbstractJavaScriptIndexCreationTask`, + * Unlike the [naming convention](#naming-convention) used with indexes inheriting from `AbstractJavaScriptIndexCreationTask`, you can choose any string-based name for the index. However, when querying, you must use that string-based name rather than the index class type. diff --git a/versioned_docs/version-7.1/indexes/content/_extending-indexes-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_extending-indexes-csharp.mdx index 510e0ac2c6..cf6757e2e2 100644 --- a/versioned_docs/version-7.1/indexes/content/_extending-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_extending-indexes-csharp.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/versioned_docs/version-7.1/indexes/content/_extending-indexes-java.mdx b/versioned_docs/version-7.1/indexes/content/_extending-indexes-java.mdx index 46bf6b4534..13f21647e0 100644 --- a/versioned_docs/version-7.1/indexes/content/_extending-indexes-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_extending-indexes-java.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/versioned_docs/version-7.1/indexes/content/_extending-indexes-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_extending-indexes-nodejs.mdx index f72a842b7a..58d2e5a594 100644 --- a/versioned_docs/version-7.1/indexes/content/_extending-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_extending-indexes-nodejs.mdx @@ -14,7 +14,7 @@ import CodeBlock from '@theme/CodeBlock'; * The indexing process will execute the LINQ code and the invoked additional source code. * Adding this custom code can be done from [Studio](../../studio/database/indexes/create-map-index.mdx#additional-sources) or from code using the _additional sources_ feature. - See [example](../../indexes/extending-indexes.mdx#including-additional-sources-from-client-code) below. + See [example](#including-additional-sources-from-client-code) below. * Advantages: * **Readability**: Index work logic is clearer and more readable diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-csharp.mdx index 7bb5c596c8..9fe58fe3e8 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-csharp.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -90,7 +90,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-nodejs.mdx index 29893dc8d0..a769b7a1fb 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-nodejs.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -92,7 +92,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-php.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-php.mdx index f1ac73dacc..78293f5e57 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-php.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -168,7 +168,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-python.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-python.mdx index 34eb3e4d9b..689d9d45c0 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-hierarchical-data-python.mdx @@ -8,9 +8,9 @@ import CodeBlock from '@theme/CodeBlock'; * Use the `Recurse` method to traverse the layers of a hierarchical document and index its fields. * In this Page: - * [Hierarchical data](../../indexes/indexing-hierarchical-data.mdx#hierarchical-data) - * [Index hierarchical data](../../indexes/indexing-hierarchical-data.mdx#index-hierarchical-data) - * [Query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) + * [Hierarchical data](#hierarchical-data) + * [Index hierarchical data](#index-hierarchical-data) + * [Query the index](#query-the-index) ## Hierarchical data @@ -89,7 +89,7 @@ For example, the following document, `BlogPosts/1-A`, represents a blog post by To index the elements of a hierarchical structure like the one above, use RavenDB's `Recurse` method. The sample index below shows how to use `Recurse` to traverse the comments in the post thread and index them by their authors. -We can then [query the index](../../indexes/indexing-hierarchical-data.mdx#query-the-index) for all blog posts that contain comments by specific authors. +We can then [query the index](#query-the-index) for all blog posts that contain comments by specific authors. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-csharp.mdx index 4d78c1f828..a63f170e74 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-csharp.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-java.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-java.mdx index 3c7b5249bc..802ac05b8b 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-java.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-nodejs.mdx index d6a5965164..e4569f17b0 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-linq-extensions-nodejs.mdx @@ -5,11 +5,11 @@ import CodeBlock from '@theme/CodeBlock'; Various indexing LINQ extensions are available to enhance the usability and reduce the complexity of the indexing functions. The available extensions are: -- [Boost](../../indexes/indexing-linq-extensions.mdx#boost) -- [Reverse](../../indexes/indexing-linq-extensions.mdx#reverse) -- [IfEntityIs](../../indexes/indexing-linq-extensions.mdx#ifentityis) -- [WhereEntityIs](../../indexes/indexing-linq-extensions.mdx#whereentityis) -- [ParseInt, ParseLong, ParseDecimal, ParseDouble](../../indexes/indexing-linq-extensions.mdx#parsing-numbers) +- [Boost](#boost) +- [Reverse](#reverse) +- [IfEntityIs](#ifentityis) +- [WhereEntityIs](#whereentityis) +- [ParseInt, ParseLong, ParseDecimal, ParseDouble](#parsing-numbers) ## **Boost** diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-csharp.mdx index b63e7dbe06..873cb84a78 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-csharp.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-java.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-java.mdx index 946a3c9263..db8bc915db 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-java.mdx @@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) + * [Indexing metadata properties](#indexing-metadata-properties) ## Indexing metadata properties diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-nodejs.mdx index d72e4b75fd..cd760971e6 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-nodejs.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-php.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-php.mdx index ae14788be5..947ab3ac0b 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-php.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-python.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-python.mdx index d4bce9739d..31cd3e9b40 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-metadata-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-metadata-python.mdx @@ -18,8 +18,8 @@ import CodeBlock from '@theme/CodeBlock'; This allows you to query for documents based on values stored in the metadata. See the examples below. * In this article: - * [Indexing metadata properties](../../indexes/indexing-metadata.mdx#indexing-metadata-properties) - * [Metadata properties that can be indexed](../../indexes/indexing-metadata.mdx#metadata-properties-that-can-be-indexed) + * [Indexing metadata properties](#indexing-metadata-properties) + * [Metadata properties that can be indexed](#metadata-properties-that-can-be-indexed) ## Indexing metadata properties diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-csharp.mdx index 56437d0503..f97d6ca1c2 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-csharp.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -563,7 +563,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), then in this case, the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-nodejs.mdx index 10772d86bc..9f46265224 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-nodejs.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -383,7 +383,7 @@ where color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `totalResults` property (available when calling the query `statistics()` method) diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-php.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-php.mdx index 3f7c90b372..11c53af6bf 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-php.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -608,7 +608,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-python.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-python.mdx index 7fc420551c..d54540ea9f 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-nested-data-python.mdx @@ -11,20 +11,20 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Sample data](../../indexes/indexing-nested-data.mdx#sample-data) + * [Sample data](#sample-data) - * [Simple index - SINGLE index-entry per document](../../indexes/indexing-nested-data.mdx#simple-index---single-index-entry-per-document) - * [The index](../../indexes/indexing-nested-data.mdx#theIndex) - * [The index-entries](../../indexes/indexing-nested-data.mdx#theIndexEntries) - * [Querying the index](../../indexes/indexing-nested-data.mdx#queryingTheIndex) - * [When to use](../../indexes/indexing-nested-data.mdx#whenToUse) + * [Simple index - SINGLE index-entry per document](#simple-index---single-index-entry-per-document) + * [The index](#theIndex) + * [The index-entries](#theIndexEntries) + * [Querying the index](#queryingTheIndex) + * [When to use](#whenToUse) - * [Fanout index - MULTIPLE index-entries per document](../../indexes/indexing-nested-data.mdx#fanout-index---multiple-index-entries-per-document) - * [What is a fanout index](../../indexes/indexing-nested-data.mdx#whatIsFanoutIndex) - * [Fanout index - Map index example](../../indexes/indexing-nested-data.mdx#fanoutMapIndex) - * [Fanout index - Map-Reduce index example](../../indexes/indexing-nested-data.mdx#fanoutMapReduceIndex) - * [Performance hints](../../indexes/indexing-nested-data.mdx#performanceHints) - * [Paging](../../indexes/indexing-nested-data.mdx#paging) + * [Fanout index - MULTIPLE index-entries per document](#fanout-index---multiple-index-entries-per-document) + * [What is a fanout index](#whatIsFanoutIndex) + * [Fanout index - Map index example](#fanoutMapIndex) + * [Fanout index - Map-Reduce index example](#fanoutMapReduceIndex) + * [Performance hints](#performanceHints) + * [Paging](#paging) ## Sample data @@ -428,7 +428,7 @@ where Color == "black" * A fanout index has more index-entries than the number of documents in the collection indexed. Multiple index-entries "point" to the same document from which they originated, - as can be seen in the above [index-entries](../../indexes/indexing-nested-data.mdx#fanoutMapIndexIndexEntries) example. + as can be seen in the above [index-entries](#fanoutMapIndexIndexEntries) example. * When making a fanout index query that should return full documents (without projecting results), the `TotalResults` property (available via the `QueryStatistics` object) will contain diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-csharp.mdx index 0280110a61..faff7cb5fa 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-csharp.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-java.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-java.mdx index e54be18a3b..527426f2f0 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-java.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-nodejs.mdx index 753137ec91..e188d14d83 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-nodejs.mdx @@ -9,11 +9,11 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this page: - * [The challenge](../../indexes/indexing-polymorphic-data.mdx#the-challenge) - * [Possible solutions:](../../indexes/indexing-polymorphic-data.mdx#possible-solutions) - * [Multi-map index](../../indexes/indexing-polymorphic-data.mdx#multi-map-index) - * [Polymorphic index](../../indexes/indexing-polymorphic-data.mdx#polymorphic-index) - * [Customize collection](../../indexes/indexing-polymorphic-data.mdx#customize-collection) + * [The challenge](#the-challenge) + * [Possible solutions:](#possible-solutions) + * [Multi-map index](#multi-map-index) + * [Polymorphic index](#polymorphic-index) + * [Customize collection](#customize-collection) ## The challenge diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-php.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-php.mdx index e22dc153cc..cd0023b362 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-php.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-python.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-python.mdx index e0f1998866..4491fae79c 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-polymorphic-data-python.mdx @@ -9,9 +9,9 @@ import CodeBlock from '@theme/CodeBlock'; and do not consider the inheritance hierarchy. * In this Page: - * [Polymorphic Data](../../indexes/indexing-polymorphic-data.mdx#polymorphic-data) - * [Multi-Map Indexes](../../indexes/indexing-polymorphic-data.mdx#multi-map-indexes) - * [Other Options](../../indexes/indexing-polymorphic-data.mdx#other-options) + * [Polymorphic Data](#polymorphic-data) + * [Multi-Map Indexes](#multi-map-indexes) + * [Other Options](#other-options) ## Polymorphic Data diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-csharp.mdx index ab2058099f..023a878f57 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-csharp.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -269,7 +269,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -287,7 +287,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-nodejs.mdx index 052b1d118d..9175bf2fa2 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-nodejs.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) + * [What are related documents](#what-are-related-documents) - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -49,7 +49,7 @@ import CodeBlock from '@theme/CodeBlock'; * Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). **The index**: @@ -239,7 +239,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -258,7 +258,7 @@ where BookNames = "The Witcher" * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). **The index**: diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-php.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-php.mdx index 7394b7dac6..ebd813f063 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-php.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -316,7 +316,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -334,7 +334,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-python.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-python.mdx index 9bdfd27308..f55338cd99 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-related-documents-python.mdx @@ -16,18 +16,18 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are related documents](../../indexes/indexing-related-documents.mdx#what-are-related-documents) - - - * [Index related documents - With tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---with-tracking) - * [Example I - basic](../../indexes/indexing-related-documents.mdx#example-i---basic) - * [Example II - list](../../indexes/indexing-related-documents.mdx#example-ii---list) - * [Tracking implications](../../indexes/indexing-related-documents.mdx#tracking-implications) - * [Index related documents - No tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [Example III - no tracking](../../indexes/indexing-related-documents.mdx#index-related-documents---no-tracking) - * [No-tracking implications](../../indexes/indexing-related-documents.mdx#no-tracking-implications) - * [Document changes that cause re-indexing](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing) - * [LoadDocument Syntax](../../indexes/indexing-related-documents.mdx#loaddocument-syntax) + * [What are related documents](#what-are-related-documents) + + + * [Index related documents - With tracking](#index-related-documents---with-tracking) + * [Example I - basic](#example-i---basic) + * [Example II - list](#example-ii---list) + * [Tracking implications](#tracking-implications) + * [Index related documents - No tracking](#index-related-documents---no-tracking) + * [Example III - no tracking](#index-related-documents---no-tracking) + * [No-tracking implications](#no-tracking-implications) + * [Document changes that cause re-indexing](#document-changes-that-cause-re-indexing) + * [LoadDocument Syntax](#loaddocument-syntax) @@ -48,7 +48,7 @@ import CodeBlock from '@theme/CodeBlock'; * **What is tracked**: Both the documents from the **indexed collection** and the **indexed related documents** are tracked for changes. Re-indexing will be triggered per any change in either collection. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: Following the above `Product - Category` relationship from the Northwind sample database, @@ -224,7 +224,7 @@ where BookNames = "The Witcher" * **Re-indexing** will be triggered whenever any document in the collection that is referenced by `LoadDocument` is changed. Even when indexing just a single field from the related document, any change to any other field will cause re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * Frequent re-indexing will increase CPU usage and reduce performance, and index results may be stale for prolonged periods. @@ -242,7 +242,7 @@ where BookNames = "The Witcher" * **What is tracked**: * Only the documents from the **indexed collection** are tracked for changes and can trigger re-indexing. Any change done to any document in the **indexed related documents** will Not trigger re-indexing. - (See changes that cause re-indexing [here](../../indexes/indexing-related-documents.mdx#document-changes-that-cause-re-indexing)). + (See changes that cause re-indexing [here](#document-changes-that-cause-re-indexing)). * **The index**: diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-csharp.mdx index 3ad6863a19..7e022201d4 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -148,7 +148,7 @@ object CreateSpatialField(string shapeWkt); // Shape in WKT string form Use the `Spatial` method from `AbstractIndexCreationTask` to modify this setting. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-nodejs.mdx index acc0daf4a5..4fe664b269 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -141,7 +141,7 @@ createSpatialField(wkt); Use the `spatial` method to modify this setting. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-php.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-php.mdx index 04a653cd18..64b421636c 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -205,7 +205,7 @@ object CreateSpatialField(string shapeWkt); // Shape in WKT string form * **By default**, the `geohashPrefixTreeIndex` strategy is used with `geohashLevel` set to **9**. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-python.mdx b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-python.mdx index a0d9ff8898..f3e28750ce 100644 --- a/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_indexing-spatial-data-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; and a spatial query can then be executed over this index (see [query a spatial index](../../indexes/querying/spatial.mdx)). * In this page: - * [Create index with spatial field](../../indexes/indexing-spatial-data.mdx#create-index-with-spatial-field) - * [Customize coordinate system and strategy](../../indexes/indexing-spatial-data.mdx#customize-coordinate-system-and-strategy) - * [Spatial indexing strategies](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies) + * [Create index with spatial field](#create-index-with-spatial-field) + * [Customize coordinate system and strategy](#customize-coordinate-system-and-strategy) + * [Spatial indexing strategies](#spatial-indexing-strategies) ## Create index with spatial field @@ -134,7 +134,7 @@ class WktField(DynamicSpatialField): # Shape in WKT string format * **By default**, the `geohash_prefix_tree_index` strategy is used with `geohash_level` set to **9**. * The performance cost of spatial indexing is directly related to the tree level chosen. - Learn more about each strategy [below](../../indexes/indexing-spatial-data.mdx#spatial-indexing-strategies). + Learn more about each strategy [below](#spatial-indexing-strategies). * Note: Modifying the strategy after the index has been created & deployed will trigger the re-indexing. diff --git a/versioned_docs/version-7.1/indexes/content/_javascript-indexes-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_javascript-indexes-csharp.mdx index b276615b98..929d536785 100644 --- a/versioned_docs/version-7.1/indexes/content/_javascript-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_javascript-indexes-csharp.mdx @@ -11,13 +11,13 @@ import CodeBlock from '@theme/CodeBlock'; In addition, RavenDB provides a set of predefined JavaScript functions that can be used in JavaScript indexes and in other features such as subscriptions, ETL scripts, set-based patching, and more. See the full list in [Predefined JavaScript functions](../../server/kb/javascript-engine.mdx#predefined-javascript-functions). * In this article: - * [Creating and deploying a JavaScript index](../../indexes/javascript-indexes.mdx#creating-and-deploying-a-javascript-index) - * [Map index](../../indexes/javascript-indexes.mdx#map-index) - * [Map index - basic](../../indexes/javascript-indexes.mdx#example-i---map-index---basic) - * [Map index - with additional sources](../../indexes/javascript-indexes.mdx#example-ii---map-index---with-additional-sources) - * [Map index - with inline string compilation](../../indexes/javascript-indexes.mdx#example-iii---map-index---with-inline-string-compilation) - * [Multi-Map index](../../indexes/javascript-indexes.mdx#multi-map-index) - * [Map-Reduce index](../../indexes/javascript-indexes.mdx#map-reduce-index) + * [Creating and deploying a JavaScript index](#creating-and-deploying-a-javascript-index) + * [Map index](#map-index) + * [Map index - basic](#example-i---map-index---basic) + * [Map index - with additional sources](#example-ii---map-index---with-additional-sources) + * [Map index - with inline string compilation](#example-iii---map-index---with-inline-string-compilation) + * [Multi-Map index](#multi-map-index) + * [Map-Reduce index](#map-reduce-index) @@ -70,7 +70,7 @@ public class Documents_ByName_JS : AbstractJavaScriptIndexCreationTask ## Map index * A map index contains a single `map` function. - To define an index that uses multiple map functions, see the section on [Multi-Map indexes](../../indexes/javascript-indexes.mdx#multi-map-index) below. + To define an index that uses multiple map functions, see the section on [Multi-Map indexes](#multi-map-index) below. * The `map` function is written as a string and specifies what content from the documents will be indexed. diff --git a/versioned_docs/version-7.1/indexes/content/_map-indexes-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_map-indexes-csharp.mdx index 9b07334518..cbbd6aee6e 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-indexes-csharp.mdx @@ -12,12 +12,12 @@ import CodeBlock from '@theme/CodeBlock'; JavaScript indexes); they can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-7.1/indexes/content/_map-indexes-java.mdx b/versioned_docs/version-7.1/indexes/content/_map-indexes-java.mdx index 49f70a23b2..3c38d3df98 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-indexes-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-indexes-java.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; JavaScript indexes); they can be considered the **core** of indexes. * In this page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Indexing nested data](#indexing-nested-data) diff --git a/versioned_docs/version-7.1/indexes/content/_map-indexes-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_map-indexes-nodejs.mdx index 56817bb2f8..816fc04135 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-indexes-nodejs.mdx @@ -11,11 +11,11 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions are **LINQ-based functions**; they can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-7.1/indexes/content/_map-indexes-php.mdx b/versioned_docs/version-7.1/indexes/content/_map-indexes-php.mdx index ddd3230e85..d064b7ce55 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-indexes-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-indexes-php.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-7.1/indexes/content/_map-indexes-python.mdx b/versioned_docs/version-7.1/indexes/content/_map-indexes-python.mdx index 2879121ecb..0253061ba4 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-indexes-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-indexes-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; * The mapping functions can be considered the **core** of indexes. * In This Page: - * [Indexing single fields](../../indexes/map-indexes.mdx#indexing-single-fields) - * [Combining multiple fields](../../indexes/map-indexes.mdx#combining-multiple-fields) - * [Indexing partial field data](../../indexes/map-indexes.mdx#indexing-partial-field-data) - * [Filtering data within fields](../../indexes/map-indexes.mdx#filtering-data-within-fields) - * [Indexing nested data](../../indexes/map-indexes.mdx#indexing-nested-data) - * [Indexing Missing Fields](../../indexes/map-indexes.mdx#indexing-missing-fields) + * [Indexing single fields](#indexing-single-fields) + * [Combining multiple fields](#combining-multiple-fields) + * [Indexing partial field data](#indexing-partial-field-data) + * [Filtering data within fields](#filtering-data-within-fields) + * [Indexing nested data](#indexing-nested-data) + * [Indexing Missing Fields](#indexing-missing-fields) diff --git a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-csharp.mdx index 39d782797b..7ac6e2db7b 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-csharp.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -515,7 +515,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -527,7 +527,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -547,7 +547,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -803,7 +803,7 @@ public class OutputReduceToCollectionReference #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-java.mdx b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-java.mdx index 1338f6b9cf..684670df54 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-java.mdx @@ -23,9 +23,9 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Important Comments](../../indexes/map-reduce-indexes.mdx#important-comments) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Important Comments](#important-comments) @@ -396,7 +396,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -408,7 +408,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -428,7 +428,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -578,7 +578,7 @@ May 6th 1998. ## Important Comments ## Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. ## Recursive indexing loop diff --git a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-nodejs.mdx index 1a9f9832cf..4ba013bf8c 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-nodejs.mdx @@ -23,9 +23,9 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Important Comments](../../indexes/map-reduce-indexes.mdx#important-comments) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Important Comments](#important-comments) @@ -227,7 +227,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -317,7 +317,7 @@ const patternForOutputReduceToCollectionReferences = indexDefinition.patternForO ## Important Comments ## Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. ## Recursive indexing loop diff --git a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-php.mdx b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-php.mdx index 9bad365dde..cf50c110ad 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-php.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -700,7 +700,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in the [example](../../indexes/map-reduce-indexes.mdx#example) below may generate +The index in the [example](#example) below may generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -720,7 +720,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in this [example](../../indexes/map-reduce-indexes.mdx#example) has this pattern for +The index in this [example](#example) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -928,7 +928,7 @@ May 6th 1998. #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-python.mdx b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-python.mdx index 5da418f54e..17648710bb 100644 --- a/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_map-reduce-indexes-python.mdx @@ -23,10 +23,10 @@ import CodeBlock from '@theme/CodeBlock'; and then runs the Reduce function to get a final aggregation result per field value. * In this page: - * [Creating Map Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-map-reduce-indexes) - * [Creating Multi-Map-Reduce Indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) - * [Reduce Results as Artificial Documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) - * [Remarks](../../indexes/map-reduce-indexes.mdx#remarks) + * [Creating Map Reduce Indexes](#creating-map-reduce-indexes) + * [Creating Multi-Map-Reduce Indexes](#creating-multi-map-reduce-indexes) + * [Reduce Results as Artificial Documents](#reduce-results-as-artificial-documents) + * [Remarks](#remarks) @@ -454,7 +454,7 @@ give to their document ID also determines how the output documents are grouped. Because reference documents have well known, predictable IDs, they are easier to plug into indexes and other operations, and can serve as an intermediary for the output documents whose IDs are less predictable. This allows you to chain map-reduce indexes in a recursive fashion, -see [Example II](../../indexes/map-reduce-indexes.mdx#example-ii). +see [Example II](#example-ii). Learn more about how to configure output and reference documents in the [Studio: Create Map-Reduce Index](../../studio/database/indexes/create-map-reduce-index.mdx). @@ -466,7 +466,7 @@ The identifiers of **map reduce output documents** have three components in this `//` -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) might generate an output document +The index in [Example I](#example-i) might generate an output document ID like this: `DailyProductSales/35/14369232530304891504` @@ -486,7 +486,7 @@ case: `hash(Product, Month)`. The identifiers of **reference documents** follow some pattern you choose, and this pattern determines which output documents are held by a given reference document. -The index in [Example I](../../indexes/map-reduce-indexes.mdx#example-i) has this pattern for reference documents: +The index in [Example I](#example-i) has this pattern for reference documents: `sales/daily/{Date:yyyy-MM-dd}` @@ -644,7 +644,7 @@ May 6th 1998. #### Saving documents -[Artificial documents](../../indexes/map-reduce-indexes.mdx#reduce-results-as-artificial-documents) +[Artificial documents](#reduce-results-as-artificial-documents) are stored immediately after the indexing transaction completes. #### Recursive indexing loop diff --git a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-csharp.mdx index fe7f2e02ba..0e3dcbae4a 100644 --- a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-csharp.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [AddMap & AddMapForAll](../../indexes/multi-map-indexes.mdx#addmap--addmapforall) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [AddMap & AddMapForAll](#addmap--addmapforall) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-java.mdx b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-java.mdx index e9a0b53af3..68bccd953a 100644 --- a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-java.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [AddMap](../../indexes/multi-map-indexes.mdx#addmap) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [AddMap](#addmap) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-nodejs.mdx index cb74caae01..af01a97b2a 100644 --- a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-nodejs.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [Indexing multiple collections](../../indexes/multi-map-indexes.mdx#indexing-multiple-collections) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [Indexing multiple collections](#indexing-multiple-collections) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-php.mdx b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-php.mdx index 943a2e8d7b..75ce89be26 100644 --- a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-php.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [`addMap`](../../indexes/multi-map-indexes.mdx#addmap) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [`addMap`](#addmap) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-python.mdx b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-python.mdx index c00cb5324f..605f74fc21 100644 --- a/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_multi-map-indexes-python.mdx @@ -12,9 +12,9 @@ import CodeBlock from '@theme/CodeBlock'; Learn how to [create Multi-Map-Reduce indexes](../../indexes/map-reduce-indexes.mdx#creating-multi-map-reduce-indexes) * In this page: - * [`_add_map`](../../indexes/multi-map-indexes.mdx#_add_map) - * [Searching across multiple collections](../../indexes/multi-map-indexes.mdx#searching-across-multiple-collections) - * [Remarks](../../indexes/multi-map-indexes.mdx#remarks) + * [`_add_map`](#_add_map) + * [Searching across multiple collections](#searching-across-multiple-collections) + * [Remarks](#remarks) diff --git a/versioned_docs/version-7.1/indexes/content/_number-type-conversion-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_number-type-conversion-csharp.mdx index 9b20c88b9a..e9a5ae4383 100644 --- a/versioned_docs/version-7.1/indexes/content/_number-type-conversion-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_number-type-conversion-csharp.mdx @@ -10,8 +10,8 @@ import CodeBlock from '@theme/CodeBlock'; * Learn more about how numbers are stored in RavenDB [here](../../server/kb/numbers-in-ravendb.mdx). * In this page: - * [Syntax](../number-type-conversion.mdx#syntax) - * [Examples](../number-type-conversion.mdx#examples) + * [Syntax](#syntax) + * [Examples](#examples) ## Syntax diff --git a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-csharp.mdx index 22f78f07ae..cb4bf076c2 100644 --- a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-csharp.mdx @@ -12,10 +12,10 @@ import CodeBlock from '@theme/CodeBlock'; This behavior can be configured at the query level. See [Projection behavior with a static-index](../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) for details. * In this article: - * [What content is stored in the index](../../indexes/storing-data-in-index.mdx#what-content-is-stored-in-the-index) - * [When and why to store data in an index](../../indexes/storing-data-in-index.mdx#when-and-why-to-store-data-in-an-index) - * [Storing data in index - from the Client API](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-client-api) - * [Storing data in index - from the Studio](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-studio) + * [What content is stored in the index](#what-content-is-stored-in-the-index) + * [When and why to store data in an index](#when-and-why-to-store-data-in-an-index) + * [Storing data in index - from the Client API](#storing-data-in-index---from-the-client-api) + * [Storing data in index - from the Studio](#storing-data-in-index---from-the-studio) ## What content is stored in the index @@ -382,7 +382,7 @@ To configure index-fields from the Studio, open the _Edit Index_ view: ![The index](../assets/store-field-in-index-1.png) -1. This is the index from the [example above](../../indexes/storing-data-in-index.mdx#storing-data-in-index---from-the-client-api). +1. This is the index from the [example above](#storing-data-in-index---from-the-client-api). 2. These are the index-fields defined in the index map function. Scroll down to configure each index-field: @@ -398,7 +398,7 @@ you can choose to display the stored index fields in the Results view: ![Display the stored fields](../assets/store-field-in-index-3.png) -1. This is the query from the [example above](../../indexes/storing-data-in-index.mdx#query-the-index). +1. This is the query from the [example above](#query-the-index). 2. Open the _Settings_ options. 3. Toggle ON _Show stored index fields only_. 4. When executing the query, diff --git a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-java.mdx b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-java.mdx index 004928e64b..a3690ad3dc 100644 --- a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-java.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-nodejs.mdx index 54bc8c893c..d763b44a2c 100644 --- a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-nodejs.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-php.mdx b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-php.mdx index ba55ebff8b..243e64603a 100644 --- a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-php.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-python.mdx b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-python.mdx index 08c35b8d49..7a92cab527 100644 --- a/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_storing-data-in-index-python.mdx @@ -13,7 +13,7 @@ field values are not stored. Lucene allows you to store the original field text (before it is analyzed) as well. * In this page: - * [Storing Data in Index](../../indexes/storing-data-in-index.mdx#storing-data-in-index) + * [Storing Data in Index](#storing-data-in-index) diff --git a/versioned_docs/version-7.1/indexes/content/_using-analyzers-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_using-analyzers-csharp.mdx index be8e7bd1f7..93fd91f43b 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-analyzers-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-analyzers-csharp.mdx @@ -23,26 +23,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; giving you full flexibility in configuring your indexes. * In this article: - * [Understanding the role of analyzers](../../indexes/using-analyzers.mdx#understanding-the-role-of-analyzers) - * [Analyzers in the index definition](../../indexes/using-analyzers.mdx#analyzers-in-the-index-definition) - * [Analyzers at indexing time](../../indexes/using-analyzers.mdx#analyzers-at-indexing-time) - * [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) - * [Full-text search](../../indexes/using-analyzers.mdx#full-text-search) - * [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb) - * [Analyzers that remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) - * [Analyzers that do not remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words) - * [Analyzers that tokenize according to the defined number of characters](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) - * [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field) - * [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendbs-default-analyzers) - * [Using the Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) - * [Using the Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer) - * [Using the Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) - * [Disabling indexing for index-field](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field) - * [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers) - * [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - * [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - * [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) - * [Viewing the indexed terms](../../indexes/using-analyzers.mdx#viewing-the-indexed-terms) + * [Understanding the role of analyzers](#understanding-the-role-of-analyzers) + * [Analyzers in the index definition](#analyzers-in-the-index-definition) + * [Analyzers at indexing time](#analyzers-at-indexing-time) + * [Analyzers at query time](#analyzers-at-query-time) + * [Full-text search](#full-text-search) + * [Analyzers available in RavenDB](#analyzers-available-in-ravendb) + * [Analyzers that remove common stop words](#analyzers-that-remove-common-stop-words) + * [Analyzers that do not remove common stop words](#analyzers-that-do-not-remove-common-stop-words) + * [Analyzers that tokenize according to the defined number of characters](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) + * [Setting analyzer for index-field](#setting-analyzer-for-index-field) + * [RavenDB's default analyzers](#ravendbs-default-analyzers) + * [Using the Default Search Analyzer](#using-the-default-search-analyzer) + * [Using the Default Exact Analyzer](#using-the-default-exact-analyzer) + * [Using the Default Analyzer](#using-the-default-analyzer) + * [Disabling indexing for index-field](#disabling-indexing-for-index-field) + * [Creating custom analyzers](#creating-custom-analyzers) + * [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + * [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + * [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) + * [Viewing the indexed terms](#viewing-the-indexed-terms) @@ -77,7 +77,7 @@ enabling [Full-text search](../../indexes/querying/searching.mdx). ### Analyzers at query time When running a [Full-text search with a dynamic query](../../client-api/session/querying/text-search/full-text-search.mdx), -the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). +the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](#using-the-default-search-analyzer). When running a [Full-text search on a static-index](../../indexes/querying/query-index.mdx), the **same analyzer** used to tokenize field content at indexing time is typically applied @@ -85,10 +85,10 @@ to process the terms provided in the full-text search query before they are sent There are two exceptions to this rule: - 1. When setting the [NGramAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, + 1. When setting the [NGramAnalyzer](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, it tokenizes the index field at indexing time. However, at query time, when performing a full-text search on that field, - the default [RavenStandardAnalyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. + the default [RavenStandardAnalyzer](#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. Currently, for query time, you cannot specify a different analyzer than the one defined in the index definition, so to address this issue, you have two options: @@ -103,8 +103,8 @@ There are two exceptions to this rule: ### Full-text search -In most cases, Lucene's [StandardAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. -For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +In most cases, Lucene's [StandardAnalyzer](#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. +For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](#creating-custom-analyzers). It is straightforward and may already be available as a contrib package for Lucene. You can also configure a specific collation for an index field to sort based on culture specific rules. @@ -126,13 +126,13 @@ Learn more in [Sorting and Collation](../../indexes/sorting-and-collation.mdx#co * **KeywordAnalyzer** * **NGramAnalyzer** -* If needed, you can create your own [Customized Analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +* If needed, you can create your own [Customized Analyzers](#creating-custom-analyzers). * To assign the analyzer of your choice to a specific index-field, - see: [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). + see: [Setting analyzer for index-field](#setting-analyzer-for-index-field). * When no analyzer is explicitly assigned to an index-field in the index definition, - RavenDB will use its [Default Analyzers](../../indexes/using-analyzers.mdx#ravendb) to process and tokenize the content of a field. + RavenDB will use its [Default Analyzers](#ravendb) to process and tokenize the content of a field. All examples below use the following text: @@ -177,7 +177,7 @@ All examples below use the following text: be aware that analyzers removing common stop words may treat IT as a stop word and exclude it from the resulting terms. This can also affect acronyms such as WHO (World Health Organization) or names such as "The Who" or "The IT Crowd". * To avoid excluding acronyms, you can either spell out the full title instead of abbreviating it - or use an [Analyzer that doesn't remove stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words). + or use an [Analyzer that doesn't remove stop words](#analyzers-that-do-not-remove-common-stop-words). @@ -272,7 +272,7 @@ All examples below use the following text: In RavenDB, the analyzer configured in the index definition is typically used both at indexing time and query time (the same analyzer). However, the `NGramAnalyzer` is an exception to this rule. - Refer to section [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) to learn about the different behaviors. + Refer to section [Analyzers at query time](#analyzers-at-query-time) to learn about the different behaviors. @@ -284,10 +284,10 @@ All examples below use the following text: use the `Analyzers.Add()` method within the index definition for that field. * Either: - * Specify an analyzer from the [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb), - * Or specify your own custom analyzer (see [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers)). + * Specify an analyzer from the [Analyzers available in RavenDB](#analyzers-available-in-ravendb), + * Or specify your own custom analyzer (see [Creating custom analyzers](#creating-custom-analyzers)). -* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendb). +* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](#ravendb). * An analyzer may also be set from the Edit Index view in the Studio, see [Index field options](../../studio/database/indexes/create-map-index.mdx#index-field-options). @@ -356,14 +356,14 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); depending on the specified Indexing Behavior. * The **Default Analyzers** are: - * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). - * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer). - * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer). + * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](#using-the-default-search-analyzer). + * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](#using-the-default-exact-analyzer). + * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](#using-the-default-analyzer). * The available **Indexing Behavior** values are: * `FieldIndexing.Exact` * `FieldIndexing.Search` - * `FieldIndexing.No` - This behavior [disables field indexing](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field). + * `FieldIndexing.No` - This behavior [disables field indexing](#disabling-indexing-for-index-field). * See the detailed explanation for each scenario below: @@ -548,9 +548,9 @@ public class BlogPosts_ByTitle : AbstractIndexCreationTask * **Ways to create**: There are three ways to create a custom analyzer and add it to your server: - 1. [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - 2. [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - 3. [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) + 1. [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + 2. [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + 3. [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) diff --git a/versioned_docs/version-7.1/indexes/content/_using-analyzers-java.mdx b/versioned_docs/version-7.1/indexes/content/_using-analyzers-java.mdx index 3ca36275b8..5efc4be21e 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-analyzers-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-analyzers-java.mdx @@ -16,13 +16,13 @@ The **Tokenization** process uses an object called an Analyzer underneath. The indexing process and its results can be controlled by various field options and Analyzers. * In this article: - * [Understanding Analyzers](../../indexes/using-analyzers.mdx#understanding-analyzers) - * [RavenDB Default Analyzer](../../indexes/using-analyzers.mdx#ravendb-default-analyzer) - * [Full-Text Search](../../indexes/using-analyzers.mdx#full-text-search) - * [Using Non-Default Analyzer](../../indexes/using-analyzers.mdx#using-non-default-analyzer) - * [Creating Own Analyzer](../../indexes/using-analyzers.mdx#creating-own-analyzer) - * [Manipulating Field Indexing Behavior](../../indexes/using-analyzers.mdx#manipulating-field-indexing-behavior) - * [Ordering When Field is Searchable](../../indexes/using-analyzers.mdx#ordering-when-field-is-searchable) + * [Understanding Analyzers](#understanding-analyzers) + * [RavenDB Default Analyzer](#ravendb-default-analyzer) + * [Full-Text Search](#full-text-search) + * [Using Non-Default Analyzer](#using-non-default-analyzer) + * [Creating Own Analyzer](#creating-own-analyzer) + * [Manipulating Field Indexing Behavior](#manipulating-field-indexing-behavior) + * [Ordering When Field is Searchable](#ordering-when-field-is-searchable) diff --git a/versioned_docs/version-7.1/indexes/content/_using-analyzers-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_using-analyzers-nodejs.mdx index d07293d2c1..053c2c8ea0 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-analyzers-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-analyzers-nodejs.mdx @@ -23,26 +23,26 @@ import ContentFrame from "@site/src/components/ContentFrame"; giving you full flexibility in configuring your indexes. * In this article: - * [Understanding the role of analyzers](../../indexes/using-analyzers.mdx#understanding-the-role-of-analyzers) - * [Analyzers in the index definition](../../indexes/using-analyzers.mdx#analyzers-in-the-index-definition) - * [Analyzers at indexing time](../../indexes/using-analyzers.mdx#analyzers-at-indexing-time) - * [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) - * [Full-text search](../../indexes/using-analyzers.mdx#full-text-search) - * [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb) - * [Analyzers that remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) - * [Analyzers that do not remove common stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words) - * [Analyzers that tokenize according to the defined number of characters](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) - * [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field) - * [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendbs-default-analyzers) - * [Using the Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) - * [Using the Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer) - * [Using the Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) - * [Disabling indexing for index-field](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field) - * [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers) - * [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - * [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - * [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) - * [Viewing the indexed terms](../../indexes/using-analyzers.mdx#viewing-the-indexed-terms) + * [Understanding the role of analyzers](#understanding-the-role-of-analyzers) + * [Analyzers in the index definition](#analyzers-in-the-index-definition) + * [Analyzers at indexing time](#analyzers-at-indexing-time) + * [Analyzers at query time](#analyzers-at-query-time) + * [Full-text search](#full-text-search) + * [Analyzers available in RavenDB](#analyzers-available-in-ravendb) + * [Analyzers that remove common stop words](#analyzers-that-remove-common-stop-words) + * [Analyzers that do not remove common stop words](#analyzers-that-do-not-remove-common-stop-words) + * [Analyzers that tokenize according to the defined number of characters](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) + * [Setting analyzer for index-field](#setting-analyzer-for-index-field) + * [RavenDB's default analyzers](#ravendbs-default-analyzers) + * [Using the Default Search Analyzer](#using-the-default-search-analyzer) + * [Using the Default Exact Analyzer](#using-the-default-exact-analyzer) + * [Using the Default Analyzer](#using-the-default-analyzer) + * [Disabling indexing for index-field](#disabling-indexing-for-index-field) + * [Creating custom analyzers](#creating-custom-analyzers) + * [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + * [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + * [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) + * [Viewing the indexed terms](#viewing-the-indexed-terms) @@ -77,7 +77,7 @@ enabling [Full-text search](../../indexes/querying/searching.mdx). ### Analyzers at query time When running a [Full-text search with a dynamic query](../../client-api/session/querying/text-search/full-text-search.mdx), -the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). +the auto-index created by the server breaks down the text of the searched document field using the [default search analyzer](#using-the-default-search-analyzer). When running a [Full-text search on a static-index](../../indexes/querying/query-index.mdx), the **same analyzer** used to tokenize field content at indexing time is typically applied @@ -85,10 +85,10 @@ to process the terms provided in the full-text search query before they are sent There are two exceptions to this rule: -1. When setting the [NGramAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, +1. When setting the [NGramAnalyzer](#analyzers-that-tokenize-according-to-the-defined-number-of-characters) in the index definition, it tokenizes the index field at indexing time. However, at query time, when performing a full-text search on that field, - the default [RavenStandardAnalyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. + the default [RavenStandardAnalyzer](#using-the-default-search-analyzer) is used to tokenize the search term from the query predicate. Currently, for query time, you cannot specify a different analyzer than the one defined in the index definition, so to address this issue, you have two options: @@ -103,8 +103,8 @@ There are two exceptions to this rule: ### Full-text search -In most cases, Lucene's [StandardAnalyzer](../../indexes/using-analyzers.mdx#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. -For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +In most cases, Lucene's [StandardAnalyzer](#analyzers-that-remove-common-stop-words) is sufficient for full-text searches. +For languages other than English, or when a custom analysis process is needed, you can provide your own [Custom analyzer](#creating-custom-analyzers). It is straightforward and may already be available as a contrib package for Lucene. You can also configure a specific collation for an index field to sort based on culture specific rules. @@ -126,13 +126,13 @@ Learn more in [Sorting and Collation](../../indexes/sorting-and-collation.mdx#co * **KeywordAnalyzer** * **NGramAnalyzer** -* If needed, you can create your own [Customized Analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers). +* If needed, you can create your own [Customized Analyzers](#creating-custom-analyzers). * To assign the analyzer of your choice to a specific index-field, - see: [Setting analyzer for index-field](../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). + see: [Setting analyzer for index-field](#setting-analyzer-for-index-field). * When no analyzer is explicitly assigned to an index-field in the index definition, - RavenDB will use its [Default Analyzers](../../indexes/using-analyzers.mdx#ravendb) to process and tokenize the content of a field. + RavenDB will use its [Default Analyzers](#ravendb) to process and tokenize the content of a field. All examples below use the following text: @@ -177,7 +177,7 @@ All examples below use the following text: be aware that analyzers removing common stop words may treat IT as a stop word and exclude it from the resulting terms. This can also affect acronyms such as WHO (World Health Organization) or names such as "The Who" or "The IT Crowd". * To avoid excluding acronyms, you can either spell out the full title instead of abbreviating it - or use an [Analyzer that doesn't remove stop words](../../indexes/using-analyzers.mdx#analyzers-that-do-not-remove-common-stop-words). + or use an [Analyzer that doesn't remove stop words](#analyzers-that-do-not-remove-common-stop-words). @@ -272,7 +272,7 @@ All examples below use the following text: In RavenDB, the analyzer configured in the index definition is typically used both at indexing time and query time (the same analyzer). However, the `NGramAnalyzer` is an exception to this rule. - Refer to section [Analyzers at query time](../../indexes/using-analyzers.mdx#analyzers-at-query-time) to learn about the different behaviors. + Refer to section [Analyzers at query time](#analyzers-at-query-time) to learn about the different behaviors. @@ -284,10 +284,10 @@ All examples below use the following text: set the `analyze()` method within the index definition for that field. * Either: - * Specify an analyzer from the [Analyzers available in RavenDB](../../indexes/using-analyzers.mdx#analyzers-available-in-ravendb), - * Or specify your own custom analyzer (see [Creating custom analyzers](../../indexes/using-analyzers.mdx#creating-custom-analyzers)). + * Specify an analyzer from the [Analyzers available in RavenDB](#analyzers-available-in-ravendb), + * Or specify your own custom analyzer (see [Creating custom analyzers](#creating-custom-analyzers)). -* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](../../indexes/using-analyzers.mdx#ravendb). +* If you want RavenDB to use the default analyzers, see [RavenDB's default analyzers](#ravendb). * An analyzer may also be set from the Edit Index view in the Studio, see [Index field options](../../studio/database/indexes/create-map-index.mdx#index-field-options). @@ -340,14 +340,14 @@ await store.maintenance depending on the specified Indexing Behavior. * The **Default Analyzers** are: - * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer). - * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](../../indexes/using-analyzers.mdx#using-the-default-exact-analyzer). - * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer). + * `RavenStandardAnalyzer` - Serves as the [Default Search Analyzer](#using-the-default-search-analyzer). + * `KeywordAnalyzer` - Servers as the [Default Exact Analyzer](#using-the-default-exact-analyzer). + * `LowerCaseKeywordAnalyzer`- Serves as the [Default Analyzer](#using-the-default-analyzer). * The available **Indexing Behavior** values are: * `Exact` * `Search` - * `No` - This behavior [disables field indexing](../../indexes/using-analyzers.mdx#disabling-indexing-for-index-field). + * `No` - This behavior [disables field indexing](#disabling-indexing-for-index-field). * See the detailed explanation for each scenario below: @@ -522,9 +522,9 @@ class BlogPosts_ByTitle extends AbstractIndexCreationTask { * **Ways to create**: There are three ways to create a custom analyzer and add it to your server: - 1. [Add custom analyzer via Studio](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-studio) - 2. [Add custom analyzer via Client API](../../indexes/using-analyzers.mdx#add-custom-analyzer-via-client-api) - 3. [Add custom analyzer directly to RavenDB's binaries](../../indexes/using-analyzers.mdx#add-custom-analyzer-directly-to-ravendbs-binaries) + 1. [Add custom analyzer via Studio](#add-custom-analyzer-via-studio) + 2. [Add custom analyzer via Client API](#add-custom-analyzer-via-client-api) + 3. [Add custom analyzer directly to RavenDB's binaries](#add-custom-analyzer-directly-to-ravendbs-binaries) diff --git a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-csharp.mdx index 5bf052d482..228f125616 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-csharp.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -282,7 +282,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -539,7 +539,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `AllFields` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `AllFields` has an analyzer configuration, RavenDB uses it as a fallback. @@ -558,7 +558,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -935,7 +935,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-java.mdx b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-java.mdx index d54ef6bea8..56e198d91a 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-java.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -276,7 +276,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -523,7 +523,7 @@ or `FieldIndexing.Search` in the `CreateFieldOptions` (`AbstractIndexCreationTas At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -542,7 +542,7 @@ or `FieldIndexing.Search` in the `CreateFieldOptions` (`AbstractIndexCreationTas The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -910,7 +910,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-nodejs.mdx index c14184c2b5..3e315a05a8 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-nodejs.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`createField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`createField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -247,7 +247,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -459,7 +459,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -478,7 +478,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -722,7 +722,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-php.mdx b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-php.mdx index 6992310715..4853440cda 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-php.mdx @@ -20,17 +20,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -293,7 +293,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -569,7 +569,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -588,7 +588,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -981,7 +981,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-python.mdx b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-python.mdx index 6862d18067..4b11f90065 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-dynamic-fields-python.mdx @@ -19,17 +19,17 @@ import Panel from '@site/src/components/Panel'; An index definition can contain both dynamic-index-fields and regular-index-fields. * In this article: - * [Indexing field KEYS](../../indexes/using-dynamic-fields.mdx#indexing-field-keys) - * [Example - index every field under an object](../../indexes/using-dynamic-fields.mdx#example---index-every-field-under-an-object) - * [Example - index every field](../../indexes/using-dynamic-fields.mdx#example---index-every-field) - * [Indexing field VALUES](../../indexes/using-dynamic-fields.mdx#indexing-field-values) - * [Example - basic](../../indexes/using-dynamic-fields.mdx#example---basic) - * [Example - list](../../indexes/using-dynamic-fields.mdx#example---list) - * [Indexing dynamic fields for full-text search](../../indexes/using-dynamic-fields.mdx#indexing-dynamic-fields-for-full-text-search) - * [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) - * [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) - * [`CreateField` syntax](../../indexes/using-dynamic-fields.mdx#createfield-syntax) - * [Indexed fields & terms view](../../indexes/using-dynamic-fields.mdx#indexed-fields-terms-view) + * [Indexing field KEYS](#indexing-field-keys) + * [Example - index every field under an object](#example---index-every-field-under-an-object) + * [Example - index every field](#example---index-every-field) + * [Indexing field VALUES](#indexing-field-values) + * [Example - basic](#example---basic) + * [Example - list](#example---list) + * [Indexing dynamic fields for full-text search](#indexing-dynamic-fields-for-full-text-search) + * [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) + * [Which analyzer is used for the query term?](#which-analyzer-is-used-for-the-query-term) + * [`CreateField` syntax](#createfield-syntax) + * [Indexed fields & terms view](#indexed-fields-terms-view) @@ -277,7 +277,7 @@ The following example allows you to: The following example shows: * Only the **basic concept** of creating a dynamic-index-field from the **value** of a document field. * Documents can then be queried based on those indexed values. - * For a more practical usage see the [Example](../../indexes/using-dynamic-fields.mdx#example---list) below. + * For a more practical usage see the [Example](#example---list) below. * **The document**: @@ -520,7 +520,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear At indexing time, RavenDB analyzes the dynamic field value and creates the indexed terms. The analyzer used at indexing time is resolved from the index definition. You can configure an analyzer for a specific generated field name, or configure `ALL_FIELDS` as a fallback. - See [Configuring analyzers for dynamic fields](../../indexes/using-dynamic-fields.mdx#configuring-analyzers-for-dynamic-fields) below. + See [Configuring analyzers for dynamic fields](#configuring-analyzers-for-dynamic-fields) below. * If the generated dynamic field name has an explicit analyzer configuration, that analyzer is used. * Otherwise, if `ALL_FIELDS` has an analyzer configuration, RavenDB uses it as a fallback. @@ -539,7 +539,7 @@ Dynamic fields can be indexed for [Full-text search](../../indexes/querying/sear The example below sets it at the index scope, in the index definition. For a summary of how RavenDB resolves the analyzer used for the query term, - see [Which analyzer is used for the query term](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) below. + see [Which analyzer is used for the query term](#which-analyzer-is-used-for-the-query-term) below. @@ -897,7 +897,7 @@ createField(fieldName, fieldValue, options); // returns object The generated dynamic index fields and their indexed terms can be viewed in the **Terms View** in Studio. -Below are sample index fields & their terms generated from [this example](../../indexes/using-dynamic-fields.mdx#example---list). +Below are sample index fields & their terms generated from [this example](#example---list). ![Figure 1. Go to terms view](../assets/dynamic-index-fields-1.png) diff --git a/versioned_docs/version-7.1/indexes/content/_using-term-vectors-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_using-term-vectors-csharp.mdx index bd120be8c4..4774ed598c 100644 --- a/versioned_docs/version-7.1/indexes/content/_using-term-vectors-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_using-term-vectors-csharp.mdx @@ -16,9 +16,9 @@ import CodeBlock from '@theme/CodeBlock'; stored term vectors to accomplish their goals. * In this page: - * [Creating an index and enabling Term Vectors on a field](../../indexes/using-term-vectors.mdx#creating-an-index-and-enabling-term-vectors-on-a-field) - * [Using the API](../../indexes/using-term-vectors.mdx#using-the-api) - * [Using Studio](../../indexes/using-term-vectors.mdx#using-studio) + * [Creating an index and enabling Term Vectors on a field](#creating-an-index-and-enabling-term-vectors-on-a-field) + * [Using the API](#using-the-api) + * [Using Studio](#using-studio) ## Creating an index and enabling Term Vectors on a field diff --git a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-csharp.mdx b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-csharp.mdx index 4302871174..6155f8b424 100644 --- a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-csharp.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-java.mdx b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-java.mdx index f75c4d64c9..f2b0722750 100644 --- a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-java.mdx +++ b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-java.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-nodejs.mdx b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-nodejs.mdx index b5fb8e4674..3f60575411 100644 --- a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-nodejs.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-php.mdx b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-php.mdx index 281f5f750f..389bc83730 100644 --- a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-php.mdx +++ b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-php.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-python.mdx b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-python.mdx index 139570d9d3..2a81ed73aa 100644 --- a/versioned_docs/version-7.1/indexes/content/_what-are-indexes-python.mdx +++ b/versioned_docs/version-7.1/indexes/content/_what-are-indexes-python.mdx @@ -6,18 +6,18 @@ import CodeBlock from '@theme/CodeBlock'; * Indexes in RavenDB enable efficient querying by processing raw data and providing fast query results without scanning the entire dataset each and every time. - Learn more in the [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) below. + Learn more in the [Indexes overview](#indexes-overview) below. -* This page provides a [Basic example](../../indexes/what-are-indexes.mdx#basic-example) of creating, deploying, and querying an index. +* This page provides a [Basic example](#basic-example) of creating, deploying, and querying an index. Additional examples can be found in [Creating and deploying indexes](../../indexes/creating-and-deploying.mdx), [Map Indexes](../../indexes/map-indexes.mdx), and many other articles under the "Indexes" menu. * In this page: - * [Indexes overview](../../indexes/what-are-indexes.mdx#indexes-overview) - * [Types of indexes](../../indexes/what-are-indexes.mdx#types-of-indexes) - * [Basic example](../../indexes/what-are-indexes.mdx#basic-example) - * [Understanding index query results](../../indexes/what-are-indexes.mdx#understanding-index-query-results) - * [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources) + * [Indexes overview](#indexes-overview) + * [Types of indexes](#types-of-indexes) + * [Basic example](#basic-example) + * [Understanding index query results](#understanding-index-query-results) + * [If indexes exhaust system resources](#if-indexes-exhaust-system-resources) @@ -64,7 +64,7 @@ import CodeBlock from '@theme/CodeBlock'; This separation helps maintain the integrity of the raw data while allowing the index to optimize query performance. * If system resources become strained due to indexing, it may require adjustments to the index design, hardware, or other factors. - Learn more in [If indexes exhaust system resources](../../indexes/what-are-indexes.mdx#if-indexes-exhaust-system-resources). + Learn more in [If indexes exhaust system resources](#if-indexes-exhaust-system-resources). diff --git a/versioned_docs/version-7.1/indexes/index-administration.mdx b/versioned_docs/version-7.1/indexes/index-administration.mdx index 14d18bebd4..4e07cd421b 100644 --- a/versioned_docs/version-7.1/indexes/index-administration.mdx +++ b/versioned_docs/version-7.1/indexes/index-administration.mdx @@ -18,17 +18,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; or via [Maintenance operations](../client-api/operations/what-are-operations.mdx#maintenance-operations) in the Client API. * In this article: - * [Index management operations](../indexes/index-administration.mdx#index-management-operations) - * [Pause & resume index](../indexes/index-administration.mdx#pause--resume-index) - * [Pause & resume indexing](../indexes/index-administration.mdx#pause--resume-indexing) - * [Disable & enable index](../indexes/index-administration.mdx#disable--enable-index) - * [Disable & enable indexing](../indexes/index-administration.mdx#disable--enable-indexing) - * [Reset index](../indexes/index-administration.mdx#reset-index) - * [Delete index](../indexes/index-administration.mdx#delete-index) - * [Set index lock mode](../indexes/index-administration.mdx#set-index-lock-mode) - * [Set index priority](../indexes/index-administration.mdx#set-index-priority) - * [Index states](../indexes/index-administration.mdx#index-states) - * [Customize indexing configuration](../indexes/index-administration.mdx#customize-indexing-configuration) + * [Index management operations](#index-management-operations) + * [Pause & resume index](#pause--resume-index) + * [Pause & resume indexing](#pause--resume-indexing) + * [Disable & enable index](#disable--enable-index) + * [Disable & enable indexing](#disable--enable-indexing) + * [Reset index](#reset-index) + * [Delete index](#delete-index) + * [Set index lock mode](#set-index-lock-mode) + * [Set index priority](#set-index-priority) + * [Index states](#index-states) + * [Customize indexing configuration](#customize-indexing-configuration) ## Index management operations diff --git a/versioned_docs/version-7.1/indexes/index-throttling.mdx b/versioned_docs/version-7.1/indexes/index-throttling.mdx index f83a62164d..c3f35bfedd 100644 --- a/versioned_docs/version-7.1/indexes/index-throttling.mdx +++ b/versioned_docs/version-7.1/indexes/index-throttling.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Indexing is triggered normally when items are added or modified, but RavenDB suspends index procession by the set interval. * The gaps in indexing activity and the procession of - [larger batches](../indexes/index-throttling.mdx#throttling-and-batches) + [larger batches](#throttling-and-batches) can reduce overall indexing CPU utilization. * Indexing can be throttled server-wide, per-database, and per-index. * Index throttling applies to the procession of **existing** indexes. @@ -26,11 +26,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * [Why Use Index Throttling?](../indexes/index-throttling.mdx#why-use-index-throttling?) - * [Index Throttling and Batches](../indexes/index-throttling.mdx#throttling-and-batches) - * [Setting Index Throttling](../indexes/index-throttling.mdx#setting-index-throttling) - * [Server-Wide](../indexes/index-throttling.mdx#server-wide-index-throttling) - * [Per-Database](../indexes/index-throttling.mdx#index-throttling-per-database) - * [Per-Index](../indexes/index-throttling.mdx#index-throttling-in-an-index-definition) + * [Index Throttling and Batches](#throttling-and-batches) + * [Setting Index Throttling](#setting-index-throttling) + * [Server-Wide](#server-wide-index-throttling) + * [Per-Database](#index-throttling-per-database) + * [Per-Index](#index-throttling-in-an-index-definition) ## Why Use Index Throttling? @@ -80,7 +80,7 @@ In special cases, throttled indexes' batches are processed without delay. Enable or disable index throttling for a specific database using the designated database configuration key. Setting this property overrides the -[Server-Wide](../indexes/index-throttling.mdx#server-wide-index-throttling) default. +[Server-Wide](#server-wide-index-throttling) default. * **From Studio**: @@ -106,8 +106,8 @@ Setting this property overrides the ### Index Throttling in an Index Definition -Setting throttling in an index definition overrides [server-wide](../indexes/index-throttling.mdx#server-wide-index-throttling) -and [database](../indexes/index-throttling.mdx#index-throttling-per-database) settings configuration. +Setting throttling in an index definition overrides [server-wide](#server-wide-index-throttling) +and [database](#index-throttling-per-database) settings configuration. * **From Code**: diff --git a/versioned_docs/version-7.1/indexes/querying/content/_distinct-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_distinct-csharp.mdx index 0836aaa25c..675c8af830 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_distinct-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_distinct-csharp.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with Distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with Distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with Distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and alternative approaches](../../../indexes/querying/distinct.mdx#performance-cost-and-alternative-approaches) + * [Sample query with Distinct](#sample-query-with-distinct) + * [Paging with Distinct](#paging-with-distinct) + * [Count with Distinct](#count-with-distinct) + * [Performance cost and alternative approaches](#performance-cost-and-alternative-approaches) ## Sample query with Distinct diff --git a/versioned_docs/version-7.1/indexes/querying/content/_distinct-java.mdx b/versioned_docs/version-7.1/indexes/querying/content/_distinct-java.mdx index e94fc97813..ee344b2092 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_distinct-java.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_distinct-java.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and an alternative approach](../../../indexes/querying/distinct.mdx#performance-cost-and-an-alternative-approach) + * [Sample query with distinct](#sample-query-with-distinct) + * [Paging with distinct](#paging-with-distinct) + * [Count with distinct](#count-with-distinct) + * [Performance cost and an alternative approach](#performance-cost-and-an-alternative-approach) ## Sample query with Distinct diff --git a/versioned_docs/version-7.1/indexes/querying/content/_distinct-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_distinct-nodejs.mdx index 90dcd69923..edd0e1f1b0 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_distinct-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_distinct-nodejs.mdx @@ -9,10 +9,10 @@ import CodeBlock from '@theme/CodeBlock'; Items are compared based on the fields listed in the `select` section of the query. * In this page: - * [Sample query with distinct](../../../indexes/querying/distinct.mdx#sample-query-with-distinct) - * [Paging with distinct](../../../indexes/querying/distinct.mdx#paging-with-distinct) - * [Count with distinct](../../../indexes/querying/distinct.mdx#count-with-distinct) - * [Performance cost and an alternative approach](../../../indexes/querying/distinct.mdx#performance-cost-and-an-alternative-approach) + * [Sample query with distinct](#sample-query-with-distinct) + * [Paging with distinct](#paging-with-distinct) + * [Count with distinct](#count-with-distinct) + * [Performance cost and an alternative approach](#performance-cost-and-an-alternative-approach) ## Sample query with distinct diff --git a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-csharp.mdx index 5e09714294..1ab85db08a 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-csharp.mdx @@ -18,9 +18,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. @@ -28,19 +28,19 @@ import CodeBlock from '@theme/CodeBlock'; * **Limit** the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) diff --git a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-nodejs.mdx index db3b505a8c..19e7c70fd5 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-nodejs.mdx @@ -24,20 +24,20 @@ import CodeBlock from '@theme/CodeBlock'; * **Limit** the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) + * [Syntax](#syntax) ## `filter` @@ -51,7 +51,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../indexes/querying/filtering.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-php.mdx index f8cfc52c42..c323d77ca9 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-php.mdx @@ -16,30 +16,30 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. We recommend that you - - * [Limit](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + * [Limit](#limit-the-query-and-prefer--for-recurring-queries) the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) @@ -52,7 +52,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../indexes/querying/filtering.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-python.mdx index 087a905981..3e6a08f3b6 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_exploration-queries-python.mdx @@ -16,30 +16,30 @@ import CodeBlock from '@theme/CodeBlock'; * You can filter the datasets retrieved by both **Index queries** and **Collection queries**. * Exploration queries need to be used - [with caution](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) + [with caution](#when-should-exploration-queries-be-used) since scanning and filtering all the data retrieved by a query cost substantial - [server resources and user waiting time](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + [server resources and user waiting time](#limit-the-query-and-prefer--for-recurring-queries) when large datasets are handled. We recommend that you - - * [Limit](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries) + * [Limit](#limit-the-query-and-prefer--for-recurring-queries) the number of records that an exploration query filters. * Use [where](../../../indexes/querying/filtering.mdx) in recurring queries, - so the query would [use an index](../../../indexes/querying/exploration-queries.mdx#limit-the-query-and-prefer--for-recurring-queries). + so the query would [use an index](#limit-the-query-and-prefer--for-recurring-queries). * In this page: - * [`filter`](../../../indexes/querying/exploration-queries.mdx#filter) - * [When should exploration queries be used](../../../indexes/querying/exploration-queries.mdx#when-should-exploration-queries-be-used) - * [Syntax](../../../indexes/querying/exploration-queries.mdx#syntax) - * [Usage examples](../../../indexes/querying/exploration-queries.mdx#usage-examples) - * [With collection queries](../../../indexes/querying/exploration-queries.mdx#with-collection-queries) - * [With queries that use an index](../../../indexes/querying/exploration-queries.mdx#with-queries-that-use-an-index) - * [With projections](../../../indexes/querying/exploration-queries.mdx#with-projections) - * [With user-defined JavaScript functions (`declare`)](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) + * [`filter`](#filter) + * [When should exploration queries be used](#when-should-exploration-queries-be-used) + * [Syntax](#syntax) + * [Usage examples](#usage-examples) + * [With collection queries](#with-collection-queries) + * [With queries that use an index](#with-queries-that-use-an-index) + * [With projections](#with-projections) + * [With user-defined JavaScript functions (`declare`)](#with-user-defined-javascript-functions-) @@ -52,7 +52,7 @@ The added filtering is parsed and executed by RavenDB's Javascript engine. The provided filtering operations resemble those implemented by [where](../../../indexes/querying/filtering.mdx) and can be further enhanced by Javascript functions of your own. -Read [here](../../../indexes/querying/exploration-queries.mdx#with-user-defined-javascript-functions-) +Read [here](#with-user-defined-javascript-functions-) about creating and using your own Javascript function in your filters. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-csharp.mdx index 89fe73faae..25f47739eb 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-nodejs.mdx index ece8bbc9d4..c5b4e2de9d 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-nodejs.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-php.mdx index 2e7f0723b8..780a25b773 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-php.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-python.mdx index dd57baf923..fe86eb7505 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_faceted-search-python.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; ![Facets](../assets/CNET_faceted_search.jpg) * In this page - * [Define an index](../../../indexes/querying/faceted-search.mdx#define-an-index) - * [Facets - Basics](../../../indexes/querying/faceted-search.mdx#facets---basics) - * [Facets - Options](../../../indexes/querying/faceted-search.mdx#facets---options) - * [Facets - Aggregations](../../../indexes/querying/faceted-search.mdx#facets---aggregations) - * [Storing facets definition in a document](../../../indexes/querying/faceted-search.mdx#storing-facets-definition-in-a-document) - * [Syntax](../../../indexes/querying/faceted-search.mdx#syntax) + * [Define an index](#define-an-index) + * [Facets - Basics](#facets---basics) + * [Facets - Options](#facets---options) + * [Facets - Aggregations](#facets---aggregations) + * [Storing facets definition in a document](#storing-facets-definition-in-a-document) + * [Syntax](#syntax) ## Define an index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_filtering-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_filtering-csharp.mdx index e260dae955..7695ba8b91 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_filtering-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_filtering-csharp.mdx @@ -15,18 +15,18 @@ import CodeBlock from '@theme/CodeBlock'; * The examples in this page demonstrate how filtering is applied by each of the above querying methods. * In this page: - * [Where](../../../indexes/querying/filtering.mdx#where) - * [Where - Numeric Property](../../../indexes/querying/filtering.mdx#where---numeric-property) - * [Where - Nested Property](../../../indexes/querying/filtering.mdx#where---nested-property) + * [Where](#where) + * [Where - Numeric Property](#where---numeric-property) + * [Where - Nested Property](#where---nested-property) * [Where + Any](../../../indexes/querying/filtering.mdx#where-+-any) * [Where + In](../../../indexes/querying/filtering.mdx#where-+-in) * [Where + ContainsAny](../../../indexes/querying/filtering.mdx#where-+-containsany) * [Where + ContainsAll](../../../indexes/querying/filtering.mdx#where-+-containsall) - * [Where - StartsWith](../../../indexes/querying/filtering.mdx#where---startswith) - * [Where - EndsWith](../../../indexes/querying/filtering.mdx#where---endswith) - * [Where - Identifier Property](../../../indexes/querying/filtering.mdx#where---identifier-property) - * [Where - Exists](../../../indexes/querying/filtering.mdx#where---exists) - * [Remarks](../../../indexes/querying/filtering.mdx#remarks) + * [Where - StartsWith](#where---startswith) + * [Where - EndsWith](#where---endswith) + * [Where - Identifier Property](#where---identifier-property) + * [Where - Exists](#where---exists) + * [Remarks](#remarks) diff --git a/versioned_docs/version-7.1/indexes/querying/content/_filtering-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_filtering-nodejs.mdx index 100569c868..dc6fc29cb1 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_filtering-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_filtering-nodejs.mdx @@ -8,17 +8,17 @@ import CodeBlock from '@theme/CodeBlock'; * One of the most basic functionalities of querying is the ability to filter out data and return records that match a given condition. * The following examples demonstrate how to add simple conditions to a query: - * [Where - equals](../../../indexes/querying/filtering.mdx#where---equals) - * [Where - numeric property](../../../indexes/querying/filtering.mdx#where---numeric-property) - * [Where - nested property](../../../indexes/querying/filtering.mdx#where---nested-property) - * [Where - multiple values](../../../indexes/querying/filtering.mdx#where---multiple-values) - * [Where - in](../../../indexes/querying/filtering.mdx#where---in) - * [Where - containsAny](../../../indexes/querying/filtering.mdx#where---containsany) - * [Where - containsAll](../../../indexes/querying/filtering.mdx#where---containsall) - * [Where - startsWith](../../../indexes/querying/filtering.mdx#where---startswith) - * [Where - endsWith](../../../indexes/querying/filtering.mdx#where---endswith) - * [Where - exists](../../../indexes/querying/filtering.mdx#where---exists) - * [Where - filter by ID](../../../indexes/querying/filtering.mdx#where---filter-by-id) + * [Where - equals](#where---equals) + * [Where - numeric property](#where---numeric-property) + * [Where - nested property](#where---nested-property) + * [Where - multiple values](#where---multiple-values) + * [Where - in](#where---in) + * [Where - containsAny](#where---containsany) + * [Where - containsAll](#where---containsall) + * [Where - startsWith](#where---startswith) + * [Where - endsWith](#where---endswith) + * [Where - exists](#where---exists) + * [Where - filter by ID](#where---filter-by-id) ## Where - equals diff --git a/versioned_docs/version-7.1/indexes/querying/content/_filtering-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_filtering-php.mdx index aca55008c6..3a4a2106f2 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_filtering-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_filtering-php.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * The examples in this page demonstrate how filtering is applied by each of these methods. * In this page: - * [`whereEquals` - Where equals](../../../indexes/querying/filtering.mdx#whereequals---where-equals) - * [`whereGreaterThan` - Numeric property](../../../indexes/querying/filtering.mdx#wheregreaterthan---numeric-property) - * [`whereGreaterThan` - Nested property](../../../indexes/querying/filtering.mdx#wheregreaterthan---nested-property) - * [`whereIn` - Single -vs- Multiple values](../../../indexes/querying/filtering.mdx#wherein---single--vs--multiple-values) - * [`containsAny` - Any value from specified collection](../../../indexes/querying/filtering.mdx#containsany---any-value-from-specified-collection) - * [`containsAll` - All values from specified collection](../../../indexes/querying/filtering.mdx#containsall---all-values-from-specified-collection) - * [`whereStartsWith` - All records with given prefix](../../../indexes/querying/filtering.mdx#wherestartswith---all-records-with-given-prefix) - * [`whereEndsWith` - All records with given suffix](../../../indexes/querying/filtering.mdx#whereendswith---all-records-with-given-suffix) - * [Where - Identifier Property](../../../indexes/querying/filtering.mdx#where---identifier-property) - * [`whereExists` - Where exists or doesn't exist](../../../indexes/querying/filtering.mdx#whereexists---where-exists-or-doesn) + * [`whereEquals` - Where equals](#whereequals---where-equals) + * [`whereGreaterThan` - Numeric property](#wheregreaterthan---numeric-property) + * [`whereGreaterThan` - Nested property](#wheregreaterthan---nested-property) + * [`whereIn` - Single -vs- Multiple values](#wherein---single--vs--multiple-values) + * [`containsAny` - Any value from specified collection](#containsany---any-value-from-specified-collection) + * [`containsAll` - All values from specified collection](#containsall---all-values-from-specified-collection) + * [`whereStartsWith` - All records with given prefix](#wherestartswith---all-records-with-given-prefix) + * [`whereEndsWith` - All records with given suffix](#whereendswith---all-records-with-given-suffix) + * [Where - Identifier Property](#where---identifier-property) + * [`whereExists` - Where exists or doesn't exist](#whereexists---where-exists-or-doesn) diff --git a/versioned_docs/version-7.1/indexes/querying/content/_filtering-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_filtering-python.mdx index 365bc24ddc..531e18a38a 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_filtering-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_filtering-python.mdx @@ -14,16 +14,16 @@ import CodeBlock from '@theme/CodeBlock'; * The examples in this page demonstrate how filtering is applied by each of these methods. * In this page: - * [`where_equals` - Where equals](../../../indexes/querying/filtering.mdx#where_equals---where-equals) - * [`where_greater_than` - Numeric property](../../../indexes/querying/filtering.mdx#where_greater_than---numeric-property) - * [`where_greater_than` - Nested property](../../../indexes/querying/filtering.mdx#where_greater_than---nested-property) - * [`where_in` - Single -vs- Multiple values](../../../indexes/querying/filtering.mdx#where_in---single--vs--multiple-values) - * [`contains_any` - Any value from specified collection](../../../indexes/querying/filtering.mdx#contains_any---any-value-from-specified-collection) - * [`contains_all` - All values from specified collection](../../../indexes/querying/filtering.mdx#contains_all---all-values-from-specified-collection) - * [`where_starts_with` - All records with given prefix](../../../indexes/querying/filtering.mdx#where_starts_with---all-records-with-given-prefix) - * [`where_ends_with` - All records with given suffix](../../../indexes/querying/filtering.mdx#where_ends_with---all-records-with-given-suffix) - * [Where - Identifier Property](../../../indexes/querying/filtering.mdx#where---identifier-property) - * [`where_exists` - Where exists or doesn't exist](../../../indexes/querying/filtering.mdx#where_exists---where-exists-or-doesn) + * [`where_equals` - Where equals](#where_equals---where-equals) + * [`where_greater_than` - Numeric property](#where_greater_than---numeric-property) + * [`where_greater_than` - Nested property](#where_greater_than---nested-property) + * [`where_in` - Single -vs- Multiple values](#where_in---single--vs--multiple-values) + * [`contains_any` - Any value from specified collection](#contains_any---any-value-from-specified-collection) + * [`contains_all` - All values from specified collection](#contains_all---all-values-from-specified-collection) + * [`where_starts_with` - All records with given prefix](#where_starts_with---all-records-with-given-prefix) + * [`where_ends_with` - All records with given suffix](#where_ends_with---all-records-with-given-suffix) + * [Where - Identifier Property](#where---identifier-property) + * [`where_exists` - Where exists or doesn't exist](#where_exists---where-exists-or-doesn) diff --git a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-csharp.mdx index 15085cc628..27f4f5c2a5 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-csharp.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-nodejs.mdx index 6d8abe3ba6..3157af960e 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-nodejs.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-php.mdx index 2fe7124c18..d86dbd47bd 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-php.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-python.mdx index 543a4c0b07..134d5578cd 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_highlighting-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_highlighting-python.mdx @@ -17,9 +17,9 @@ import CodeBlock from '@theme/CodeBlock'; the index field on which you search must be configured for highlighting. See examples below. * In this page: - * [Highlight results - Map index](../../../indexes/querying/highlighting.mdx#highlight-results---map-index) - * [Highlight results - Map-Reduce index](../../../indexes/querying/highlighting.mdx#highlight-results---map-reduce-index) - * [Customize highlight tags](../../../indexes/querying/highlighting.mdx#customize-highlight-tags) + * [Highlight results - Map index](#highlight-results---map-index) + * [Highlight results - Map-Reduce index](#highlight-results---map-reduce-index) + * [Customize highlight tags](#customize-highlight-tags) ## Highlight results - Map index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-csharp.mdx index d8d84b9af2..dd06e172b1 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-csharp.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations when querying Map index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-index) - * [Include explanations when querying Map-Reduce index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-reduce-index) - * [Syntax](../../../indexes/querying/include-explanations.mdx#syntax) + * [Include explanations when querying Map index](#include-explanations-when-querying-map-index) + * [Include explanations when querying Map-Reduce index](#include-explanations-when-querying-map-reduce-index) + * [Syntax](#syntax) ## Include explanations when querying Map index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-nodejs.mdx index b843b7cc79..df30ef33c8 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_include-explanations-nodejs.mdx @@ -15,9 +15,9 @@ import CodeBlock from '@theme/CodeBlock'; * You can configure which search engine will be used. Learn how in [Selecting the search engine](../../../indexes/search-engine/corax.mdx#selecting-the-search-engine). * In this page: - * [Include explanations when querying Map index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-index) - * [Include explanations when querying Map-Reduce index](../../../indexes/querying/include-explanations.mdx#include-explanations-when-querying-map-reduce-index) - * [Syntax](../../../indexes/querying/include-explanations.mdx#syntax) + * [Include explanations when querying Map index](#include-explanations-when-querying-map-index) + * [Include explanations when querying Map-Reduce index](#include-explanations-when-querying-map-reduce-index) + * [Syntax](#syntax) ## Include explanations when querying Map index diff --git a/versioned_docs/version-7.1/indexes/querying/content/_intersection-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_intersection-csharp.mdx index 0651af1f31..a0a51e7673 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_intersection-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_intersection-csharp.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-7.1/indexes/querying/content/_intersection-java.mdx b/versioned_docs/version-7.1/indexes/querying/content/_intersection-java.mdx index 199fb9551a..f2bfb578c3 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_intersection-java.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_intersection-java.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-7.1/indexes/querying/content/_intersection-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_intersection-nodejs.mdx index 78a9d6f52e..4884310716 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_intersection-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_intersection-nodejs.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-7.1/indexes/querying/content/_intersection-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_intersection-php.mdx index 60746172df..2e01c264f2 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_intersection-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_intersection-php.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-7.1/indexes/querying/content/_intersection-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_intersection-python.mdx index 331c25bb18..8911d37bfa 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_intersection-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_intersection-python.mdx @@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock'; that match **all** the provided sub-queries, we introduced the query intersection feature. * In this page: - * [Intersection](../../../indexes/querying/intersection.mdx#intersection) + * [Intersection](#intersection) ## Intersection diff --git a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-csharp.mdx index a92a5c5880..022c7c44a7 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-csharp.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-java.mdx b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-java.mdx index 6470ebb953..ece0a855c1 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-java.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-nodejs.mdx index dea48c1f54..7dc0a3767e 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-nodejs.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-php.mdx index 7007d3db07..b33c51237a 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-php.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-python.mdx index 88b86d0cba..73889e607f 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_morelikethis-python.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Setup](../../../indexes/querying/morelikethis.mdx#setup) - * [Basic Usage](../../../indexes/querying/morelikethis.mdx#basic-usage) - * [Options](../../../indexes/querying/morelikethis.mdx#options) - * [Stop Words](../../../indexes/querying/morelikethis.mdx#stop-words) - * [Remarks](../../../indexes/querying/morelikethis.mdx#remarks) + * [Setup](#setup) + * [Basic Usage](#basic-usage) + * [Options](#options) + * [Stop Words](#stop-words) + * [Remarks](#remarks) ## Setup diff --git a/versioned_docs/version-7.1/indexes/querying/content/_paging-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_paging-csharp.mdx index ab3f9cd8cc..22a19fb41f 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_paging-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_paging-csharp.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-7.1/indexes/querying/content/_paging-java.mdx b/versioned_docs/version-7.1/indexes/querying/content/_paging-java.mdx index 2bf012245d..f8e9850253 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_paging-java.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_paging-java.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-7.1/indexes/querying/content/_paging-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_paging-nodejs.mdx index 5e44b5c140..5eb1b316ae 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_paging-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_paging-nodejs.mdx @@ -22,14 +22,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-7.1/indexes/querying/content/_paging-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_paging-php.mdx index ad5542405a..a6c5d97e3d 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_paging-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_paging-php.mdx @@ -24,14 +24,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no-paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no-paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-7.1/indexes/querying/content/_paging-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_paging-python.mdx index 0603b5f4ea..1347bf7760 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_paging-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_paging-python.mdx @@ -24,14 +24,14 @@ import CodeBlock from '@theme/CodeBlock'; * **Performance**: Using paging is beneficial when handling large result datasets, contributing to improved performance. - See [paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) here below. + See [paging and performance](#paging-and-performance) here below. * In this page: - * [No-paging example](../../../indexes/querying/paging.mdx#no---paging-example) - * [Paging examples](../../../indexes/querying/paging.mdx#paging-examples) - * [Paging and performance](../../../indexes/querying/paging.mdx#paging-and-performance) - * [Paging through tampered results](../../../indexes/querying/paging.mdx#paging-through-tampered-results) + * [No-paging example](#no---paging-example) + * [Paging examples](#paging-examples) + * [Paging and performance](#paging-and-performance) + * [Paging through tampered results](#paging-through-tampered-results) ## No-paging example diff --git a/versioned_docs/version-7.1/indexes/querying/content/_projections-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_projections-csharp.mdx index fe7109c1a6..2339da2862 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_projections-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_projections-csharp.mdx @@ -11,12 +11,12 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about Projections and for dynamic-queries examples. * In this page: - * [Projection Methods](../../../indexes/querying/projections.mdx#select): - * [Select](../../../indexes/querying/projections.mdx#select) - * [ProjectInto](../../../indexes/querying/projections.mdx#projectinto) - * [SelectFields](../../../indexes/querying/projections.mdx#selectfields) - * [Projection behavior with a static-index](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) - * [OfType](../../../indexes/querying/projections.mdx#oftype) + * [Projection Methods](#select): + * [Select](#select) + * [ProjectInto](#projectinto) + * [SelectFields](#selectfields) + * [Projection behavior with a static-index](#projection-behavior-with-a-static-index) + * [OfType](#oftype) ## Select @@ -109,14 +109,14 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * In the above example, the fields to return by the projection that are specified in the `Select` method (`x.FirstName` & `x.LastName`) are recognized by the compiler as fields of the `IndexEntry` class. - * If you wish to specify fields from the original 'Employee' class type then follow [this example](../../../indexes/querying/projections.mdx#oftype) that uses `OfType`. + * If you wish to specify fields from the original 'Employee' class type then follow [this example](#oftype) that uses `OfType`. * **Source of projection fields**: * Since the index-fields in this example are not [Stored in the index](../../../indexes/storing-data-in-index.mdx), and no projection behavior was defined, resulting values for `FirstName` & `LastName` will be retrieved from the matching Employee document in the storage. - * This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. + * This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. @@ -196,7 +196,7 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * In this example, the projected fields (`FirstName` and `LastName`) are stored in the index, so by default, the resulting values will come directly from the index and Not from the Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_projections-java.mdx b/versioned_docs/version-7.1/indexes/querying/content/_projections-java.mdx index 4642c7bbb6..f9f6420f82 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_projections-java.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_projections-java.mdx @@ -5,8 +5,8 @@ import CodeBlock from '@theme/CodeBlock'; There are couple of ways to perform projections in RavenDB: -- projections using [SelectFields](../../../indexes/querying/projections.mdx#selectfields) -- using [OfType](../../../indexes/querying/projections.mdx#oftype) +- projections using [SelectFields](#selectfields) +- using [OfType](#oftype) ## What are Projections and When to Use Them diff --git a/versioned_docs/version-7.1/indexes/querying/content/_projections-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_projections-nodejs.mdx index 23eebdd1ee..7335bf9b8b 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_projections-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_projections-nodejs.mdx @@ -11,9 +11,9 @@ import CodeBlock from '@theme/CodeBlock'; for general knowledge about Projections and for dynamic-queries examples. * In this page: - * [SelectFields](../../../indexes/querying/projections.mdx#selectfields) - * [Projection behavior with a static-index](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) - * [ofType](../../../indexes/querying/projections.mdx#oftype) + * [SelectFields](#selectfields) + * [Projection behavior with a static-index](#projection-behavior-with-a-static-index) + * [ofType](#oftype) ## SelectFields @@ -77,7 +77,7 @@ select FirstName as EmployeeFirstName, LastName as EmployeeLastName * Since the index-fields in this example are not [Stored in the index](../../../indexes/storing-data-in-index.mdx), and no projection behavior was defined, resulting values for `FirstName` & `LastName` will be retrieved from the matching Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. @@ -131,7 +131,7 @@ select FirstName, LastName * In this example, the projected fields (`FirstName` and `LastName`) are stored in the index, so by default, the resulting values will come directly from the index and not from the Employee document in the storage. -* This behavior can be modified by setting the [projection behavior](../../../indexes/querying/projections.mdx#projection-behavior-with-a-static-index) used when querying a static-index. +* This behavior can be modified by setting the [projection behavior](#projection-behavior-with-a-static-index) used when querying a static-index. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_projections-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_projections-php.mdx index 21ed25851e..5797fc2db8 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_projections-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_projections-php.mdx @@ -14,11 +14,11 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are Projections and When to Use Them](../../../indexes/querying/projections.mdx#what-are-projections-and-when-to-use-them) - * [`selectFields`](../../../indexes/querying/projections.mdx#selectfields) - * [Examples](../../../indexes/querying/projections.mdx#examples) - * [Projection Behavior](../../../indexes/querying/projections.mdx#projection-behavior) - * [Projections and the Session](../../../indexes/querying/projections.mdx#projections-and-the-session) + * [What are Projections and When to Use Them](#what-are-projections-and-when-to-use-them) + * [`selectFields`](#selectfields) + * [Examples](#examples) + * [Projection Behavior](#projection-behavior) + * [Projections and the Session](#projections-and-the-session) ## What are Projections and When to Use Them diff --git a/versioned_docs/version-7.1/indexes/querying/content/_projections-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_projections-python.mdx index a72ff66f70..7ecba701fd 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_projections-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_projections-python.mdx @@ -14,12 +14,12 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [What are Projections and When to Use Them](../../../indexes/querying/projections.mdx#what-are-projections-and-when-to-use-them) - * [`select_fields`](../../../indexes/querying/projections.mdx#select_fields) - * [Examples](../../../indexes/querying/projections.mdx#examples) - * [Projection Behavior](../../../indexes/querying/projections.mdx#projection-behavior) - * [Projections and the Session](../../../indexes/querying/projections.mdx#projections-and-the-session) - * [Syntax](../../../indexes/querying/projections.mdx#syntax) + * [What are Projections and When to Use Them](#what-are-projections-and-when-to-use-them) + * [`select_fields`](#select_fields) + * [Examples](#examples) + * [Projection Behavior](#projection-behavior) + * [Projections and the Session](#projections-and-the-session) + * [Syntax](#syntax) ## What are Projections and When to Use Them diff --git a/versioned_docs/version-7.1/indexes/querying/content/_query-index-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_query-index-csharp.mdx index 61e977019e..2b9ee04d52 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_query-index-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_query-index-csharp.mdx @@ -16,9 +16,9 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../client-api/session/querying/what-is-rql.mdx). * In this page: - * [Query an index by `Query`](../../../indexes/querying/query-index.mdx#query-an-index-by-query) (using LINQ) - * [Query an index by `DocumentQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-documentquery) (low-level API) - * [Query an index by `RawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) (using RQL) + * [Query an index by `Query`](#query-an-index-by-query) (using LINQ) + * [Query an index by `DocumentQuery`](#query-an-index-by-documentquery) (low-level API) + * [Query an index by `RawQuery`](#query-an-index-by-rawquery) (using RQL) ## Query an index by `Query` @@ -462,8 +462,8 @@ where LastName == "King" ## Query an index by `RawQuery` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_query-index-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_query-index-nodejs.mdx index 2002d35a08..5cd81e380e 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_query-index-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_query-index-nodejs.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../client-api/session/querying/what-is-rql.mdx). * In this page: - * [Query an index by `Query`](../../../indexes/querying/query-index.mdx#query-an-index-by-query) (using API) - * [Query an index by `RawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) (using RQL) + * [Query an index by `Query`](#query-an-index-by-query) (using API) + * [Query an index by `RawQuery`](#query-an-index-by-rawquery) (using RQL) ## Query an index by `Query` @@ -273,7 +273,7 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `RawQuery` -* Queries defined with [query](../../../indexes/querying/query-index.mdx#sessionquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. +* Queries defined with [query](#sessionquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_query-index-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_query-index-php.mdx index d95d801f2f..0b705f16ae 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_query-index-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_query-index-php.mdx @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock'; * Querying can be enhanced using these [extension methods](../../../client-api/session/querying/how-to-query.mdx#custom-methods). * In this page: - * [Query index - no filtering](../../../indexes/querying/query-index.mdx#query-index---no-filtering) - * [Query index - with filtering](../../../indexes/querying/query-index.mdx#query-index---with-filtering) - * [Query index - with paging](../../../indexes/querying/query-index.mdx#query-index---with-paging) - * [Query an index by `documentQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-documentquery) - * [Query an index by `rawQuery`](../../../indexes/querying/query-index.mdx#query-an-index-by-rawquery) + * [Query index - no filtering](#query-index---no-filtering) + * [Query index - with filtering](#query-index---with-filtering) + * [Query index - with paging](#query-index---with-paging) + * [Query an index by `documentQuery`](#query-an-index-by-documentquery) + * [Query an index by `rawQuery`](#query-an-index-by-rawquery) ## Query index - no filtering @@ -442,8 +442,8 @@ where LastName == "King" ## Query an index by `rawQuery` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_query-index-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_query-index-python.mdx index 5168699990..e242a13eff 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_query-index-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_query-index-python.mdx @@ -16,8 +16,8 @@ import CodeBlock from '@theme/CodeBlock'; using [RQL](../../../client-api/session/querying/what-is-rql.mdx). * In this page: - * [Query an index by `query_index_type` and `query_index`](../../../indexes/querying/query-index.mdx#query-an-index-by-query_index_type-and-query_index) - * [Query an index by `raw_query`](../../../indexes/querying/query-index.mdx#query-an-index-by-raw_query) (using RQL) + * [Query an index by `query_index_type` and `query_index`](#query-an-index-by-query_index_type-and-query_index) + * [Query an index by `raw_query`](#query-an-index-by-raw_query) (using RQL) ## Query an index by `query_index_type` and `query_index` @@ -247,8 +247,8 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `raw_query` -* Queries defined with [Query](../../../indexes/querying/query-index.mdx#sessionquery) - or [DocumentQuery](../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) +* Queries defined with [Query](#sessionquery) + or [DocumentQuery](#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) when sent to the server. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_searching-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_searching-csharp.mdx index f0be0e6ffd..f481fa95c4 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_searching-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_searching-csharp.mdx @@ -19,15 +19,15 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) - * [Searching with wildcards](../../../indexes/querying/searching.mdx#searching-with-wildcards) - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) + * [Searching with wildcards](#searching-with-wildcards) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) @@ -409,9 +409,9 @@ where search(AllValues, "tofu") [analyzer](../../../indexes/using-analyzers.mdx) used in the index. * Note the different behavior in the following cases, as described below: - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) * When using [Corax](../../../indexes/search-engine/corax.mdx) as the search engine, this behavior will only apply to indexes that are newly created or have been reset. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_searching-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_searching-nodejs.mdx index cb73bfd7c0..2f85678a0f 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_searching-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_searching-nodejs.mdx @@ -20,15 +20,15 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) - * [Searching with wildcards](../../../indexes/querying/searching.mdx#searching-with-wildcards) - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) + * [Searching with wildcards](#searching-with-wildcards) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) @@ -262,9 +262,9 @@ where search(AllValues, "tofu") [analyzer](../../../indexes/using-analyzers.mdx) used in the index. * Note the different behavior in the following cases, as described below: - * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](../../../indexes/querying/searching.mdx#when-usingoror) - * [When using a custom analyzer](../../../indexes/querying/searching.mdx#when-using-a-custom-analyzer) - * [When using the Exact analyzer](../../../indexes/querying/searching.mdx#when-using-the-exact-analyzer) + * [When using RavenStandardAnalyzer or StandardAnalyzer or NGramAnalyzer](#when-usingoror) + * [When using a custom analyzer](#when-using-a-custom-analyzer) + * [When using the Exact analyzer](#when-using-the-exact-analyzer) * When using [Corax](../../../indexes/search-engine/corax.mdx) as the search engine, this behavior will only apply to indexes that are newly created or have been reset. diff --git a/versioned_docs/version-7.1/indexes/querying/content/_searching-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_searching-php.mdx index 510a6f8752..3409ce29a8 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_searching-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_searching-php.mdx @@ -20,11 +20,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) diff --git a/versioned_docs/version-7.1/indexes/querying/content/_searching-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_searching-python.mdx index 88c6aa452f..77adcfe80e 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_searching-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_searching-python.mdx @@ -20,11 +20,11 @@ import CodeBlock from '@theme/CodeBlock'; Learn more in [Setting analyzer for index-field](../../../indexes/using-analyzers.mdx#setting-analyzer-for-index-field). * In this article: - * [Indexing single field for FTS](../../../indexes/querying/searching.mdx#indexing-single-field-for-fts) - * [Indexing multiple fields for FTS](../../../indexes/querying/searching.mdx#indexing-multiple-fields-for-fts) - * [Indexing all fields for FTS (using AsJson)](../../../indexes/querying/searching.mdx#indexing-all-fields-for-fts-using-asjson) - * [Indexing dynamic fields for FTS](../../../indexes/querying/searching.mdx#indexing-dynamic-fields-for-fts) - * [Boosting search results](../../../indexes/querying/searching.mdx#boosting-search-results) + * [Indexing single field for FTS](#indexing-single-field-for-fts) + * [Indexing multiple fields for FTS](#indexing-multiple-fields-for-fts) + * [Indexing all fields for FTS (using AsJson)](#indexing-all-fields-for-fts-using-asjson) + * [Indexing dynamic fields for FTS](#indexing-dynamic-fields-for-fts) + * [Boosting search results](#boosting-search-results) diff --git a/versioned_docs/version-7.1/indexes/querying/content/_sorting-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_sorting-csharp.mdx index f643a3eeae..d276994187 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_sorting-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_sorting-csharp.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-7.1/indexes/querying/content/_sorting-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_sorting-nodejs.mdx index f6b313e17d..6fd9f1fa23 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_sorting-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_sorting-nodejs.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-7.1/indexes/querying/content/_sorting-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_sorting-php.mdx index 189f8a52cd..bba203db6d 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_sorting-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_sorting-php.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-7.1/indexes/querying/content/_sorting-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_sorting-python.mdx index 4e2ad4dbd0..3fe92c388e 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_sorting-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_sorting-python.mdx @@ -13,9 +13,9 @@ import CodeBlock from '@theme/CodeBlock'; * All sorting capabilities provided for a dynamic query can also be used when querying a static-index. * In this page: - * [Order by index-field value](../../../indexes/querying/sorting.mdx#order-by-index-field-value) - * [Order results when index-field is searchable](../../../indexes/querying/sorting.mdx#order-results-when-index-field-is-searchable) - * [Additional Sorting Options](../../../indexes/querying/sorting.mdx#additional-sorting-options) + * [Order by index-field value](#order-by-index-field-value) + * [Order results when index-field is searchable](#order-results-when-index-field-is-searchable) + * [Additional Sorting Options](#additional-sorting-options) ## Order by index-field value diff --git a/versioned_docs/version-7.1/indexes/querying/content/_spatial-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_spatial-csharp.mdx index af1341ff81..9d948500cc 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_spatial-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_spatial-csharp.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-7.1/indexes/querying/content/_spatial-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_spatial-nodejs.mdx index 066a9fdc5e..cf4a055849 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_spatial-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_spatial-nodejs.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-7.1/indexes/querying/content/_spatial-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_spatial-php.mdx index 9a183fb5f4..f01f2bf755 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_spatial-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_spatial-php.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-7.1/indexes/querying/content/_spatial-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_spatial-python.mdx index 40b3108c0d..ec83d3c919 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_spatial-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_spatial-python.mdx @@ -21,9 +21,9 @@ import CodeBlock from '@theme/CodeBlock'; Find all spatial API methods listed [here](../../../client-api/session/querying/how-to-make-a-spatial-query.mdx#spatial-api). * Examples in this page: - * [Search by radius](../../../indexes/querying/spatial.mdx#search-by-radius) - * [Search by shape](../../../indexes/querying/spatial.mdx#search-by-shape) - * [Sort results](../../../indexes/querying/spatial.mdx#sort-results) + * [Search by radius](#search-by-radius) + * [Search by shape](#search-by-shape) + * [Sort results](#sort-results) ## Search by radius diff --git a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-csharp.mdx b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-csharp.mdx index 2b0a8bfa50..d482d02803 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-csharp.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-nodejs.mdx b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-nodejs.mdx index ac05e8c401..b0b1f7b335 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-nodejs.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-php.mdx b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-php.mdx index 96373c2477..067caf9f40 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-php.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-php.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-python.mdx b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-python.mdx index 3943dfab03..36d78c20a9 100644 --- a/versioned_docs/version-7.1/indexes/querying/content/_suggestions-python.mdx +++ b/versioned_docs/version-7.1/indexes/querying/content/_suggestions-python.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; Find the Suggestions API methods listed [here](../../../client-api/session/querying/how-to-work-with-suggestions.mdx#syntax). * In this page: - * [Configure the index for suggestions](../../../indexes/querying/suggestions.mdx#configure-the-index-for-suggestions) - * [The index terms](../../../indexes/querying/suggestions.mdx#the-index-terms) - * [Suggest terms - for a single term](../../../indexes/querying/suggestions.mdx#suggest-terms---for-a-single-term) - * [Suggest terms - for multiple terms](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-terms) - * [Suggest terms - for multiple fields](../../../indexes/querying/suggestions.mdx#suggest-terms---for-multiple-fields) - * [Suggest terms - customize options and display name](../../../indexes/querying/suggestions.mdx#suggest-terms---customize-options-and-display-name) + * [Configure the index for suggestions](#configure-the-index-for-suggestions) + * [The index terms](#the-index-terms) + * [Suggest terms - for a single term](#suggest-terms---for-a-single-term) + * [Suggest terms - for multiple terms](#suggest-terms---for-multiple-terms) + * [Suggest terms - for multiple fields](#suggest-terms---for-multiple-fields) + * [Suggest terms - customize options and display name](#suggest-terms---customize-options-and-display-name) ## Configure the index for suggestions diff --git a/versioned_docs/version-7.1/indexes/rolling-index-deployment.mdx b/versioned_docs/version-7.1/indexes/rolling-index-deployment.mdx index a2bb13ef5e..c83edaa1af 100644 --- a/versioned_docs/version-7.1/indexes/rolling-index-deployment.mdx +++ b/versioned_docs/version-7.1/indexes/rolling-index-deployment.mdx @@ -23,14 +23,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Why Rolling Index Deployment](../indexes/rolling-index-deployment.mdx#why-rolling-index-deployment) - * [How Does It Work](../indexes/rolling-index-deployment.mdx#how-does-it-work) - * [The Rolling Procedure](../indexes/rolling-index-deployment.mdx#the-rolling-procedure) - * [Deployment Concurrency and Order](../indexes/rolling-index-deployment.mdx#deployment-concurrency-and-order) - * [Setting Indexing Deployment Mode](../indexes/rolling-index-deployment.mdx#setting-indexing-deployment-mode) - * [Server-Wide Deployment Mode](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) - * [Database Deployment Mode](../indexes/rolling-index-deployment.mdx#database-deployment-mode) - * [Deployment Mode in an Index Definition](../indexes/rolling-index-deployment.mdx#deployment-mode-in-an-index-definition) + * [Why Rolling Index Deployment](#why-rolling-index-deployment) + * [How Does It Work](#how-does-it-work) + * [The Rolling Procedure](#the-rolling-procedure) + * [Deployment Concurrency and Order](#deployment-concurrency-and-order) + * [Setting Indexing Deployment Mode](#setting-indexing-deployment-mode) + * [Server-Wide Deployment Mode](#server-wide-deployment-mode) + * [Database Deployment Mode](#database-deployment-mode) + * [Deployment Mode in an Index Definition](#deployment-mode-in-an-index-definition) ## Why Rolling Index Deployment @@ -104,7 +104,7 @@ Nodes are assigned with the indexing of each database in a linear order, one nod Enable or disable rolling for a specific database using database configuration keys. Setting these properties overrides the -[Server-Wide](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) default. +[Server-Wide](#server-wide-deployment-mode) default. * From Studio: @@ -132,8 +132,8 @@ Setting these properties overrides the ### Deployment Mode in an Index Definition Enable or disable rolling for a specific index using the index-definition `DeploymentMode` property. -Setting this property overrides [server-wide](../indexes/rolling-index-deployment.mdx#server-wide-deployment-mode) -and [database](../indexes/rolling-index-deployment.mdx#database-deployment-mode) settings configuration. +Setting this property overrides [server-wide](#server-wide-deployment-mode) +and [database](#database-deployment-mode) settings configuration. * `DeploymentMode = IndexDeploymentMode.Rolling` * `DeploymentMode = IndexDeploymentMode.Parallel` diff --git a/versioned_docs/version-7.1/indexes/search-engine/corax.mdx b/versioned_docs/version-7.1/indexes/search-engine/corax.mdx index 2039626fc7..45a2ce220e 100644 --- a/versioned_docs/version-7.1/indexes/search-engine/corax.mdx +++ b/versioned_docs/version-7.1/indexes/search-engine/corax.mdx @@ -36,21 +36,21 @@ import Panel from '@site/src/components/Panel'; * _Community_, _Developer_, and servers without a license default to **Corax**. * All other license types, such as _Professional_ and _Enterprise_, default to **Lucene**. - Explicitly [selecting the search engine](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) overrides this license-based default. + Explicitly [selecting the search engine](#selecting-the-search-engine) overrides this license-based default. --- * In this article: - * [Selecting the search engine](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) - * [Server wide](../../indexes/search-engine/corax.mdx#select-search-engine-server-wide) - * [Per database](../../indexes/search-engine/corax.mdx#select-search-engine-per-database) - * [Per static index](../../indexes/search-engine/corax.mdx#select-search-engine-per-static-index) - * [Unsupported features](../../indexes/search-engine/corax.mdx#unsupported-features) - * [Handling complex JSON objects](../../indexes/search-engine/corax.mdx#handling-complex-json-objects) - * [Compound fields](../../indexes/search-engine/corax.mdx#compound-fields) - * [Limits](../../indexes/search-engine/corax.mdx#limits) - * [Index training: Compression dictionaries](../../indexes/search-engine/corax.mdx#index-training-compression-dictionaries) - * [Configuration options](../../indexes/search-engine/corax.mdx#configuration-options) + * [Selecting the search engine](#selecting-the-search-engine) + * [Server wide](#select-search-engine-server-wide) + * [Per database](#select-search-engine-per-database) + * [Per static index](#select-search-engine-per-static-index) + * [Unsupported features](#unsupported-features) + * [Handling complex JSON objects](#handling-complex-json-objects) + * [Compound fields](#compound-fields) + * [Limits](#limits) + * [Index training: Compression dictionaries](#index-training-compression-dictionaries) + * [Configuration options](#configuration-options) @@ -58,11 +58,11 @@ import Panel from '@site/src/components/Panel'; You can select the search engine at the following scopes: - * [Server-wide](../../indexes/search-engine/corax.mdx#select-search-engine-server-wide), + * [Server-wide](#select-search-engine-server-wide), for all databases hosted by the server. - * [Per database](../../indexes/search-engine/corax.mdx#select-search-engine-per-database), + * [Per database](#select-search-engine-per-database), overriding the server-wide setting for a specific database. - * [Per static index](../../indexes/search-engine/corax.mdx#select-search-engine-per-static-index), + * [Per static index](#select-search-engine-per-static-index), overriding the server-wide and database-level settings for a specific static index. Per-index search engine selection is available only for **static** indexes. @@ -74,7 +74,7 @@ Use these configuration options to select the search engine: * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) Selects either `Lucene` or `Corax` for **static indexes**. This option can be set **server-wide**, **per database**, or **per index**. - * For additional Corax configuration options, see [Configuration options](../../indexes/search-engine/corax.mdx#configuration-options). + * For additional Corax configuration options, see [Configuration options](#configuration-options). --- @@ -232,7 +232,7 @@ The following Corax limitations currently apply. #### Complex JSON properties: Complex JSON properties cannot currently be indexed and searched by Corax. -Read more about this in [Handling complex JSON objects](../../indexes/search-engine/corax.mdx#handling-complex-json-objects) below. +Read more about this in [Handling complex JSON objects](#handling-complex-json-objects) below. #### Unsupported `where` methods: @@ -297,14 +297,14 @@ but `Location` itself is not a simple searchable value. * **Corax** does not support indexing the whole complex JSON object as a single text value, because indexing an entire object as text is usually not useful for search. The exact behavior depends on whether the index is an auto-index or a static index; - see [How Corax handles complex fields while indexing](../../indexes/search-engine/corax.mdx#how-corax-handles-complex-fields-while-indexing) below. + see [How Corax handles complex fields while indexing](#how-corax-handles-complex-fields-while-indexing) below. To work with complex objects, use one of the following approaches: - 1. [Index simple properties from the object](../../indexes/search-engine/corax.mdx#1-index-simple-properties-from-the-object) - 2. [Store the complex field for projection only](../../indexes/search-engine/corax.mdx#2-store-the-complex-field-for-projection-only) - 3. [Serialize the complex object explicitly](../../indexes/search-engine/corax.mdx#3-serialize-the-complex-object-explicitly) - 4. [Use Lucene to index the whole object as JSON text](../../indexes/search-engine/corax.mdx#4-use-lucene-to-index-the-whole-object-as-json-text) + 1. [Index simple properties from the object](#1-index-simple-properties-from-the-object) + 2. [Store the complex field for projection only](#2-store-the-complex-field-for-projection-only) + 3. [Serialize the complex object explicitly](#3-serialize-the-complex-object-explicitly) + 4. [Use Lucene to index the whole object as JSON text](#4-use-lucene-to-index-the-whole-object-as-json-text) --- @@ -681,7 +681,7 @@ The index-fields and their terms are visible in the "Terms view": * Compound fields have additional constraints, including exactly **2 fields** per compound field and a **255-byte limit** per participating field value. - Learn more in [Compound fields: Constraints and value limits](../../indexes/search-engine/corax.mdx#constraints-and-value-limits). + Learn more in [Compound fields: Constraints and value limits](#constraints-and-value-limits). diff --git a/versioned_docs/version-7.1/integrations/akka.net-persistence/events-and-snapshots.mdx b/versioned_docs/version-7.1/integrations/akka.net-persistence/events-and-snapshots.mdx index cc515c33b1..2e6132a12e 100644 --- a/versioned_docs/version-7.1/integrations/akka.net-persistence/events-and-snapshots.mdx +++ b/versioned_docs/version-7.1/integrations/akka.net-persistence/events-and-snapshots.mdx @@ -29,11 +29,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; see [Integrating with Akka.NET persistence](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx). * In this page: - * [Storing events](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-events) - * [Storing snapshots](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-snapshots) - * [Storing guidelines](../../integrations/akka.net-persistence/events-and-snapshots.mdx#storing-guidelines) - * [Global consistency](../../integrations/akka.net-persistence/events-and-snapshots.mdx#global-consistency) - * [Sample application](../../integrations/akka.net-persistence/events-and-snapshots.mdx#sample-application) + * [Storing events](#storing-events) + * [Storing snapshots](#storing-snapshots) + * [Storing guidelines](#storing-guidelines) + * [Global consistency](#global-consistency) + * [Sample application](#sample-application) ## Storing events diff --git a/versioned_docs/version-7.1/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx b/versioned_docs/version-7.1/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx index d608302ebc..0afe429438 100644 --- a/versioned_docs/version-7.1/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx +++ b/versioned_docs/version-7.1/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This article provides guidance on integrating RavenDB with Akka.Persistence. * In this page: - * [Overview](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#overview) - * [Akka.Persistence.RavenDB](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#akkapersistenceravendb) - * [Installing the RavenDB persistence plugin](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#installing-the-ravendb-persistence-plugin) - * [Configuring the RavenDB persistence plugin with HOCON](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuring-the-ravendb-persistence-plugin-with-hocon) - * [Configuration keys](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuration-keys) - * [Configuring the RavenDB persistence plugin with Hosting](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuring-the-ravendb-persistence-plugin-with-hosting) - * [Syntax](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#syntax) + * [Overview](#overview) + * [Akka.Persistence.RavenDB](#akkapersistenceravendb) + * [Installing the RavenDB persistence plugin](#installing-the-ravendb-persistence-plugin) + * [Configuring the RavenDB persistence plugin with HOCON](#configuring-the-ravendb-persistence-plugin-with-hocon) + * [Configuration keys](#configuration-keys) + * [Configuring the RavenDB persistence plugin with Hosting](#configuring-the-ravendb-persistence-plugin-with-hosting) + * [Syntax](#syntax) ## Overview @@ -118,7 +118,7 @@ the configuration provided via Hosting takes precedence and will override the co Provide different values for each store as needed. * The following is a sample HOCON configuration under the `` section. - See the full description of each configuration key [below](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#configuration-keys). + See the full description of each configuration key [below](#configuration-keys). @@ -254,7 +254,7 @@ Default: `false` * Using Hosting, you can easily set up the RavenDB plugin during your application's startup. * Use method `WithRavenDbPersistence` to configure all relevant parameters. - See the available parameters and method overloads in the syntax section [below](../../integrations/akka.net-persistence/integrating-with-akka-persistence.mdx#syntax). + See the available parameters and method overloads in the syntax section [below](#syntax). * The following example shows a basic configuration using Hosting: diff --git a/versioned_docs/version-7.1/integrations/akka.net-persistence/queries.mdx b/versioned_docs/version-7.1/integrations/akka.net-persistence/queries.mdx index dc6826a5ae..3f67cf9af3 100644 --- a/versioned_docs/version-7.1/integrations/akka.net-persistence/queries.mdx +++ b/versioned_docs/version-7.1/integrations/akka.net-persistence/queries.mdx @@ -22,13 +22,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; Just include `Akka.Persistence.RavenDb.Query` in your application. * In this page: - * [Interface types](../../integrations/akka.net-persistence/queries.mdx#interface-types) - * [Supported interfaces](../../integrations/akka.net-persistence/queries.mdx#supported-interfaces) - * [IPersistenceIdsQuery & ICurrentPersistenceIdsQuery](../../integrations/akka.net-persistence/queries.mdx#ipersistenceidsquery--icurrentpersistenceidsquery) - * [IEventsByPersistenceIdQuery & ICurrentEventsByPersistenceIdQuery](../../integrations/akka.net-persistence/queries.mdx#ieventsbypersistenceidquery--icurrenteventsbypersistenceidquery) - * [IEventsByTagQuery & ICurrentEventsByTagQuery](../../integrations/akka.net-persistence/queries.mdx#ieventsbytagquery--icurrenteventsbytagquery) - * [IAllEventsQuery & ICurrentAllEventsQuery](../../integrations/akka.net-persistence/queries.mdx#ialleventsquery--icurrentalleventsquery) - * [Inner implementation details](../../integrations/akka.net-persistence/queries.mdx#inner-implementation-details) + * [Interface types](#interface-types) + * [Supported interfaces](#supported-interfaces) + * [IPersistenceIdsQuery & ICurrentPersistenceIdsQuery](#ipersistenceidsquery--icurrentpersistenceidsquery) + * [IEventsByPersistenceIdQuery & ICurrentEventsByPersistenceIdQuery](#ieventsbypersistenceidquery--icurrenteventsbypersistenceidquery) + * [IEventsByTagQuery & ICurrentEventsByTagQuery](#ieventsbytagquery--icurrenteventsbytagquery) + * [IAllEventsQuery & ICurrentAllEventsQuery](#ialleventsquery--icurrentalleventsquery) + * [Inner implementation details](#inner-implementation-details) ## Interface types diff --git a/versioned_docs/version-7.1/integrations/postgresql-protocol/overview.mdx b/versioned_docs/version-7.1/integrations/postgresql-protocol/overview.mdx index 35c8f00c7b..f4b2b26a73 100644 --- a/versioned_docs/version-7.1/integrations/postgresql-protocol/overview.mdx +++ b/versioned_docs/version-7.1/integrations/postgresql-protocol/overview.mdx @@ -27,11 +27,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Enabling PostgreSQL support](../../integrations/postgresql-protocol/overview.mdx#enabling-postgresql-support) - * [License](../../integrations/postgresql-protocol/overview.mdx#license) - * [Settings](../../integrations/postgresql-protocol/overview.mdx#settings) - * [PostgreSQL Port](../../integrations/postgresql-protocol/overview.mdx#postgresql-port) - * [Security](../../integrations/postgresql-protocol/overview.mdx#security) + * [Enabling PostgreSQL support](#enabling-postgresql-support) + * [License](#license) + * [Settings](#settings) + * [PostgreSQL Port](#postgresql-port) + * [Security](#security) ## Enabling PostgreSQL support diff --git a/versioned_docs/version-7.1/integrations/postgresql-protocol/power-bi.mdx b/versioned_docs/version-7.1/integrations/postgresql-protocol/power-bi.mdx index 2ff17bd572..8663471d67 100644 --- a/versioned_docs/version-7.1/integrations/postgresql-protocol/power-bi.mdx +++ b/versioned_docs/version-7.1/integrations/postgresql-protocol/power-bi.mdx @@ -25,10 +25,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; must explicitly enable **Power BI** Support. * In this page: - * [Using RavenDB From Power BI Desktop](../../integrations/postgresql-protocol/power-bi.mdx#using-ravendb-from-power-bi-desktop) - * [Connect to RavenDB](../../integrations/postgresql-protocol/power-bi.mdx#connect-to-ravendb) - * [Retrieve Collections Data](../../integrations/postgresql-protocol/power-bi.mdx#retrieve-collections-data) - * [Query RavenDB Using RQL](../../integrations/postgresql-protocol/power-bi.mdx#query-ravendb-using-rql) + * [Using RavenDB From Power BI Desktop](#using-ravendb-from-power-bi-desktop) + * [Connect to RavenDB](#connect-to-ravendb) + * [Retrieve Collections Data](#retrieve-collections-data) + * [Query RavenDB Using RQL](#query-ravendb-using-rql) ## Using RavenDB From Power BI Desktop diff --git a/versioned_docs/version-7.1/integrations/terraform.mdx b/versioned_docs/version-7.1/integrations/terraform.mdx index 12bee81d1f..0842bc389c 100644 --- a/versioned_docs/version-7.1/integrations/terraform.mdx +++ b/versioned_docs/version-7.1/integrations/terraform.mdx @@ -29,13 +29,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; and concisely and can always be used to review and easily modify it. * In this page: - * [Prerequisites](../integrations/terraform.mdx#prerequisites) - * [Prepare Terraform Configuration](../integrations/terraform.mdx#prepare-terraform-configuration) - * [Provider](../integrations/terraform.mdx#provider) - * [Terraform Local Parameters](../integrations/terraform.mdx#terraform-local-parameters) - * [RavenDB Resource](../integrations/terraform.mdx#ravendb-resource) - * [Terraform Output Values](../integrations/terraform.mdx#terraform-output-values) - * [Apply Terraform Configuration](../integrations/terraform.mdx#apply-terraform-configuration) + * [Prerequisites](#prerequisites) + * [Prepare Terraform Configuration](#prepare-terraform-configuration) + * [Provider](#provider) + * [Terraform Local Parameters](#terraform-local-parameters) + * [RavenDB Resource](#ravendb-resource) + * [Terraform Output Values](#terraform-output-values) + * [Apply Terraform Configuration](#apply-terraform-configuration) ## Prerequisites @@ -45,7 +45,7 @@ To deploy RavenDB using Terraform, you need: * Find [here](https://ravendb.net/buy) what features are supported by each RavenDB license, and acquire the product that suits your needs. * The license you acquire will be provided to RavenDB via the - [Terraform configuration file](../integrations/terraform.mdx#prepare-terraform-configuration) + [Terraform configuration file](#prepare-terraform-configuration) to validate your product and determine which of its features would be enabled. * **Hosts** @@ -58,7 +58,7 @@ To deploy RavenDB using Terraform, you need: * **Terraform Configuration File** * Learn [here](https://www.terraform.io/docs/language/index.html) the basics of Terraform's configuration language. - * Read [below](../integrations/terraform.mdx#prepare-terraform-configuration) + * Read [below](#prepare-terraform-configuration) how to set the configuration file to provision RavenDB. * **Terraform Application** @@ -92,7 +92,7 @@ Use the `provider` object to **set RavenDB as the provider**. Note that the **version number** relates to the RavenDB Terraform Provider version, **not** to the RavenDB Product version (that is -defined in the [resource](../integrations/terraform.mdx#ravendb-resource) +defined in the [resource](#ravendb-resource) block's **package** field). diff --git a/versioned_docs/version-7.1/migration/client-api/client-breaking-changes.mdx b/versioned_docs/version-7.1/migration/client-api/client-breaking-changes.mdx index f163f6e89a..5f7a128e1d 100644 --- a/versioned_docs/version-7.1/migration/client-api/client-breaking-changes.mdx +++ b/versioned_docs/version-7.1/migration/client-api/client-breaking-changes.mdx @@ -18,12 +18,12 @@ In RavenDB `7.0`, they are either unavailable or their behavior is inconsistent with their behavior in previous versions. * In this page: - * [Subscription creation overload modification](../../migration/client-api/client-breaking-changes.mdx#subscription-creation-overload-modification) - * [HTTP-Compression algorithm is now `Zstd` by default](../../migration/client-api/client-breaking-changes.mdx#http-compression-algorithm-is-now-zstd-by-default) - * [Bulk-insert Compression is now Enabled by default](../../migration/client-api/client-breaking-changes.mdx#bulk-insert-compression-is-now-enabled-by-default) - * [Removed irrelevant `SingleNodeBatchCommand` parameters](../../migration/client-api/client-breaking-changes.mdx#removed-irrelevant-singlenodebatchcommand-parameters) - * [Removed obsolete methods](../../migration/client-api/client-breaking-changes.mdx#removed-obsolete-methods) - * [`FromEtl` is now internal](../../migration/client-api/client-breaking-changes.mdx#frometl-is-now-internal) + * [Subscription creation overload modification](#subscription-creation-overload-modification) + * [HTTP-Compression algorithm is now `Zstd` by default](#http-compression-algorithm-is-now-zstd-by-default) + * [Bulk-insert Compression is now Enabled by default](#bulk-insert-compression-is-now-enabled-by-default) + * [Removed irrelevant `SingleNodeBatchCommand` parameters](#removed-irrelevant-singlenodebatchcommand-parameters) + * [Removed obsolete methods](#removed-obsolete-methods) + * [`FromEtl` is now internal](#frometl-is-now-internal) ## Subscription creation overload modification diff --git a/versioned_docs/version-7.1/migration/client-api/client-migration.mdx b/versioned_docs/version-7.1/migration/client-api/client-migration.mdx index 9253b0ab4a..c9554273dd 100644 --- a/versioned_docs/version-7.1/migration/client-api/client-migration.mdx +++ b/versioned_docs/version-7.1/migration/client-api/client-migration.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Client migration to RavenDB `7.x`](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7x) + * [Client migration to RavenDB `7.x`](#client-migration-to-ravendb-7x) ## Client migration to RavenDB `7.x` diff --git a/versioned_docs/version-7.1/migration/embedded/testdriver-breaking-changes.mdx b/versioned_docs/version-7.1/migration/embedded/testdriver-breaking-changes.mdx index fabb1442ea..392917fa2e 100644 --- a/versioned_docs/version-7.1/migration/embedded/testdriver-breaking-changes.mdx +++ b/versioned_docs/version-7.1/migration/embedded/testdriver-breaking-changes.mdx @@ -18,7 +18,7 @@ In RavenDB `6.2.x`, they are either unavailable or their behavior is inconsisten with their behavior in previous versions. * In this page: - * [Unlicensed TestDriver throws an exception](../../migration/embedded/testdriver-breaking-changes.mdx#unlicensed-testdriver-throws-an-exception) + * [Unlicensed TestDriver throws an exception](#unlicensed-testdriver-throws-an-exception) ## Unlicensed TestDriver throws an exception diff --git a/versioned_docs/version-7.1/migration/server/data-migration.mdx b/versioned_docs/version-7.1/migration/server/data-migration.mdx index 4541b81cc6..0dc8a37c5e 100644 --- a/versioned_docs/version-7.1/migration/server/data-migration.mdx +++ b/versioned_docs/version-7.1/migration/server/data-migration.mdx @@ -15,11 +15,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Migration to RavenDB `7.x`](../../migration/server/data-migration.mdx#migration-to-ravendb-7x) - * [Migration from RavenDB 5.x to 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-5x-to-6x) - * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-4x-to-ravendb-5x-and-6x) - * [Migration from RavenDB 3.x](../../migration/server/data-migration.mdx#migration-from-ravendb-3x) - * [Migrating data into a sharded database](../../migration/server/data-migration.mdx#migrating-data-into-a-sharded-database) + * [Migration to RavenDB `7.x`](#migration-to-ravendb-7x) + * [Migration from RavenDB 5.x to 6.x](#migration-from-ravendb-5x-to-6x) + * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](#migration-from-ravendb-4x-to-ravendb-5x-and-6x) + * [Migration from RavenDB 3.x](#migration-from-ravendb-3x) + * [Migrating data into a sharded database](#migrating-data-into-a-sharded-database) ## Migration to RavenDB `7.x` diff --git a/versioned_docs/version-7.1/migration/server/docker.mdx b/versioned_docs/version-7.1/migration/server/docker.mdx index aa318f8bb2..b1755540e5 100644 --- a/versioned_docs/version-7.1/migration/server/docker.mdx +++ b/versioned_docs/version-7.1/migration/server/docker.mdx @@ -23,11 +23,11 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Read [here](../../start/containers/image-usage.mdx) more about running a RavenDB Docker image. * In this article: - * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-6-0-and-up) - * [Migrating To RavenDB `6.0` And Up](../../migration/server/docker.mdx#migrating-to-ravendb-6-0-and-up) - * [Permit the `ravendb` user to access the mounted data directory](../../migration/server/docker.mdx#permit-the-ravendb-user-to-access-the-mounted-data-directory) - * [Customize the UID/GID of the RavenDB data directory owner](../../migration/server/docker.mdx#customize-the-uidgid-of-the-ravendb-data-directory-owner) - * [Migrate files and data](../../migration/server/docker.mdx#migrate-files-and-data) + * [Changes Made In RavenDB `6.0` And Up](#changes-made-in-ravendb-6-0-and-up) + * [Migrating To RavenDB `6.0` And Up](#migrating-to-ravendb-6-0-and-up) + * [Permit the `ravendb` user to access the mounted data directory](#permit-the-ravendb-user-to-access-the-mounted-data-directory) + * [Customize the UID/GID of the RavenDB data directory owner](#customize-the-uidgid-of-the-ravendb-data-directory-owner) + * [Migrate files and data](#migrate-files-and-data) diff --git a/versioned_docs/version-7.1/migration/server/server-breaking-changes.mdx b/versioned_docs/version-7.1/migration/server/server-breaking-changes.mdx index 62308222da..3f67a101a0 100644 --- a/versioned_docs/version-7.1/migration/server/server-breaking-changes.mdx +++ b/versioned_docs/version-7.1/migration/server/server-breaking-changes.mdx @@ -19,9 +19,9 @@ The features listed on this page were available in former RavenDB versions. In RavenDB `7.1.x`, they are either unavailable or their behavior is inconsistent with their behavior in previous versions. * In this article: - * [RavenDB now incorporates NLog as its logging system](../../migration/server/server-breaking-changes.mdx#ravendb-incorporates-nlog-as-its-logging-system) - * [Removed obsolete properties](../../migration/server/server-breaking-changes.mdx#removed-obsolete-properties) - * [Filtered vector search behavior](../../migration/server/server-breaking-changes.mdx#filtered-vector-search-behavior) + * [RavenDB now incorporates NLog as its logging system](#ravendb-incorporates-nlog-as-its-logging-system) + * [Removed obsolete properties](#removed-obsolete-properties) + * [Filtered vector search behavior](#filtered-vector-search-behavior) diff --git a/versioned_docs/version-7.1/server/administration/cli.mdx b/versioned_docs/version-7.1/server/administration/cli.mdx index ac8bce7890..670d4ade05 100644 --- a/versioned_docs/version-7.1/server/administration/cli.mdx +++ b/versioned_docs/version-7.1/server/administration/cli.mdx @@ -21,26 +21,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page lists available CLI commands and explains their usage. * In this page: - * [`rvn`](../../server/administration/cli.mdx#rvn) - * [`info`](../../server/administration/cli.mdx#info) - * [`stats`](../../server/administration/cli.mdx#stats) - * [`log`](../../server/administration/cli.mdx#log) - * [`gc`](../../server/administration/cli.mdx#gc) + * [`rvn`](#rvn) + * [`info`](#info) + * [`stats`](#stats) + * [`log`](#log) + * [`gc`](#gc) * [`shutdown | q`](../../server/administration/cli.mdx#shutdown-|-q) * [`restartServer`, `resetServer`](../../server/administration/cli.mdx#restartserver,-resetserver) - * [`script`](../../server/administration/cli.mdx#script) - * [`generateClientCert`](../../server/administration/cli.mdx#generateclientcert) - * [`trustServerCert`](../../server/administration/cli.mdx#trustservercert) - * [`trustClientCert`](../../server/administration/cli.mdx#trustclientcert) - * [`replaceClusterCert`](../../server/administration/cli.mdx#replaceclustercert) - * [`triggerCertificateRefresh`](../../server/administration/cli.mdx#triggercertificaterefresh) - * [`clear`](../../server/administration/cli.mdx#clear) - * [`prompt`](../../server/administration/cli.mdx#prompt) - * [`logout`](../../server/administration/cli.mdx#logout) - * [`logo`](../../server/administration/cli.mdx#logo) - * [`help`](../../server/administration/cli.mdx#help) - * [`lowMem`](../../server/administration/cli.mdx#lowmem) - * [`timer`](../../server/administration/cli.mdx#timer) + * [`script`](#script) + * [`generateClientCert`](#generateclientcert) + * [`trustServerCert`](#trustservercert) + * [`trustClientCert`](#trustclientcert) + * [`replaceClusterCert`](#replaceclustercert) + * [`triggerCertificateRefresh`](#triggercertificaterefresh) + * [`clear`](#clear) + * [`prompt`](#prompt) + * [`logout`](#logout) + * [`logo`](#logo) + * [`help`](#help) + * [`lowMem`](#lowmem) + * [`timer`](#timer) ## `rvn` diff --git a/versioned_docs/version-7.1/server/administration/monitoring/mib-generation.mdx b/versioned_docs/version-7.1/server/administration/monitoring/mib-generation.mdx index aba1f4aaf7..753777aa7f 100644 --- a/versioned_docs/version-7.1/server/administration/monitoring/mib-generation.mdx +++ b/versioned_docs/version-7.1/server/administration/monitoring/mib-generation.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The created MIB can be used by monitoring tools to extract RavenDB metrics via SNMP. * In this page: - * [Generating a MIB](../../../server/administration/monitoring/mib-generation.mdx#generating-a-mib) - * [MIB generation endpoint](../../../server/administration/monitoring/mib-generation.mdx#mib-generation-endpoint) - * [Fine-tune the OIDs list](../../../server/administration/monitoring/mib-generation.mdx#fine-tune-the-oids-list) + * [Generating a MIB](#generating-a-mib) + * [MIB generation endpoint](#mib-generation-endpoint) + * [Fine-tune the OIDs list](#fine-tune-the-oids-list) ## Generating a MIB diff --git a/versioned_docs/version-7.1/server/administration/monitoring/open-telemetry.mdx b/versioned_docs/version-7.1/server/administration/monitoring/open-telemetry.mdx index 6388725524..f58161f4ad 100644 --- a/versioned_docs/version-7.1/server/administration/monitoring/open-telemetry.mdx +++ b/versioned_docs/version-7.1/server/administration/monitoring/open-telemetry.mdx @@ -22,22 +22,22 @@ import LanguageContent from "@site/src/components/LanguageContent"; allowing seamless data collection and analysis by an OpenTelemetry retriever. * In addition, an OpenTelemetry collector can retrieve data from RavenDB's [Prometheus](../../../server/administration/monitoring/prometheus.mdx) endpoint. - Learn more [below](../../../server/administration/monitoring/open-telemetry.mdx#retrieve-data-from-prometheus). + Learn more [below](#retrieve-data-from-prometheus). * OpenTelemetry support is provided for RavenDB instances both on-premises and in the cloud. * In this article: - * [Enabling OpenTelemetry in RavenDB](../../../server/administration/monitoring/open-telemetry.mdx#enabling-opentelemetry-in-ravendb) - * [RavenDB OpenTelemetry meters](../../../server/administration/monitoring/open-telemetry.mdx#ravendb-opentelemetry-meters) - * [Server identification in metrics](../../../server/administration/monitoring/open-telemetry.mdx#server-identification-in-metrics) - * [Service name and namespace](../../../server/administration/monitoring/open-telemetry.mdx#service-name-and-namespace) - * [The metric instruments](../../../server/administration/monitoring/open-telemetry.mdx#the-metric-instruments) - * [Metrics export options](../../../server/administration/monitoring/open-telemetry.mdx#metrics-export-options) - * [Console](../../../server/administration/monitoring/open-telemetry.mdx#console) - * [OpenTelemetry Protocol](../../../server/administration/monitoring/open-telemetry.mdx#opentelemetry-protocol) - * [Configuring the OpenTelemetry Collector](../../../server/administration/monitoring/open-telemetry.mdx#configuring-the-opentelemetry-collector) - * [Receive data via OLTP ](../../../server/administration/monitoring/open-telemetry.mdx#receive-data-via-otlp) - * [Retrieve data from Prometheus](../../../server/administration/monitoring/open-telemetry.mdx#retrieve-data-from-prometheus) + * [Enabling OpenTelemetry in RavenDB](#enabling-opentelemetry-in-ravendb) + * [RavenDB OpenTelemetry meters](#ravendb-opentelemetry-meters) + * [Server identification in metrics](#server-identification-in-metrics) + * [Service name and namespace](#service-name-and-namespace) + * [The metric instruments](#the-metric-instruments) + * [Metrics export options](#metrics-export-options) + * [Console](#console) + * [OpenTelemetry Protocol](#opentelemetry-protocol) + * [Configuring the OpenTelemetry Collector](#configuring-the-opentelemetry-collector) + * [Receive data via OLTP ](#receive-data-via-otlp) + * [Retrieve data from Prometheus](#retrieve-data-from-prometheus) @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## RavenDB OpenTelemetry meters -Each meter listed below groups similar or related [metric instruments](../../../server/administration/monitoring/open-telemetry.mdx#the-metric-instruments). +Each meter listed below groups similar or related [metric instruments](#the-metric-instruments). Each metric instrument observes some metric value. Only the most commonly used meters are enabled by default. @@ -304,7 +304,7 @@ RavenDB offers two options for exporting metrics: | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.ExportProcessorType](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolexportprocessortype) | Export processor type | Simple / Batch | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Headers](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolheaders) | Custom headers | string | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Protocol](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolprotocol) | Defines the transport protocol that OpenTelemetry Protocol should use to send data. | gRPC / HttpProtobuf | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](../../../server/administration/monitoring/open-telemetry.mdx#configure-endpoint). | string | +| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](#configure-endpoint). | string | | Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) | Timeout | int | @@ -312,7 +312,7 @@ RavenDB offers two options for exporting metrics: __Configuring the OpenTelemetry Protocol endpoint__: -The defined endpoint must correspond to the endpoint [configured on the collector](../../../server/administration/monitoring/open-telemetry.mdx#configuring-the-opentelemetry-collector) for receiving metrics data. +The defined endpoint must correspond to the endpoint [configured on the collector](#configuring-the-opentelemetry-collector) for receiving metrics data. The endpoint format should match the transport protocol you are using:
diff --git a/versioned_docs/version-7.1/server/administration/monitoring/prometheus.mdx b/versioned_docs/version-7.1/server/administration/monitoring/prometheus.mdx index eb588d2e37..f24ea1beda 100644 --- a/versioned_docs/version-7.1/server/administration/monitoring/prometheus.mdx +++ b/versioned_docs/version-7.1/server/administration/monitoring/prometheus.mdx @@ -23,12 +23,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A Prometheus endpoint is provided by RavenDB instances both on-premise and on the cloud. * In this page: - * [Prometheus](../../../server/administration/monitoring/prometheus.mdx#prometheus) - * [RavenDB Prometheus Endpoint](../../../server/administration/monitoring/prometheus.mdx#ravendb-prometheus-endpoint) - * [Omit or Include Selected Metrics](../../../server/administration/monitoring/prometheus.mdx#omit-or-include-selected-metrics) - * [Metrics Provided by the Prometheus Endpoint](../../../server/administration/monitoring/prometheus.mdx#metrics-provided-by-the-prometheus-endpoint) - * [Using the RavenDB Endpoint by a Prometheus Server](../../../server/administration/monitoring/prometheus.mdx#using-the-ravendb-endpoint-by-a-prometheus-server) - * [Fetching Additional RavenDB Information](../../../server/administration/monitoring/prometheus.mdx#fetching-additional-ravendb-information) + * [Prometheus](#prometheus) + * [RavenDB Prometheus Endpoint](#ravendb-prometheus-endpoint) + * [Omit or Include Selected Metrics](#omit-or-include-selected-metrics) + * [Metrics Provided by the Prometheus Endpoint](#metrics-provided-by-the-prometheus-endpoint) + * [Using the RavenDB Endpoint by a Prometheus Server](#using-the-ravendb-endpoint-by-a-prometheus-server) + * [Fetching Additional RavenDB Information](#fetching-additional-ravendb-information) ## Prometheus @@ -50,7 +50,7 @@ E.g. [http://live-test.ravendb.net/admin/monitoring/v1/prometheus](http://live-t * As prometheus handles only numeric values, the endpoint outputs all values as numbers, providing legends that explain what the numbers mean. - Metrics values are also explained in the [table below](../../../server/administration/monitoring/prometheus.mdx#metrics-provided-by-the-prometheus-endpoint). + Metrics values are also explained in the [table below](#metrics-provided-by-the-prometheus-endpoint). ## Omit or Include Selected Metrics diff --git a/versioned_docs/version-7.1/server/administration/monitoring/telegraf.mdx b/versioned_docs/version-7.1/server/administration/monitoring/telegraf.mdx index aa685e1bf0..b63c759aae 100644 --- a/versioned_docs/version-7.1/server/administration/monitoring/telegraf.mdx +++ b/versioned_docs/version-7.1/server/administration/monitoring/telegraf.mdx @@ -22,9 +22,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and displayed as live graphs using [Grafana](https://grafana.com/). * In this page: - * [Telegraf](../../../server/administration/monitoring/telegraf.mdx#telegraf) - * [Monitoring Endpoints](../../../server/administration/monitoring/telegraf.mdx#monitoring-endpoints) - * [JSON Fields Returned by the Endpoints](../../../server/administration/monitoring/telegraf.mdx#json-fields-returned-by-the-endpoints) + * [Telegraf](#telegraf) + * [Monitoring Endpoints](#monitoring-endpoints) + * [JSON Fields Returned by the Endpoints](#json-fields-returned-by-the-endpoints) ## Telegraf diff --git a/versioned_docs/version-7.1/server/administration/snmp/setup-zabbix.mdx b/versioned_docs/version-7.1/server/administration/snmp/setup-zabbix.mdx index ab9d93f565..9175413df2 100644 --- a/versioned_docs/version-7.1/server/administration/snmp/setup-zabbix.mdx +++ b/versioned_docs/version-7.1/server/administration/snmp/setup-zabbix.mdx @@ -38,16 +38,16 @@ import ContentFrame from "@site/src/components/ContentFrame"; see [Set up Zabbix monitoring for RavenDB Cloud](https://docs.ravendb.net/guides/zabbix-setup-guide). * In this article: - * [Prerequisites](./setup-zabbix.mdx#prerequisites) - * [Importing the template](./setup-zabbix.mdx#importing-the-template) - * [Creating a host](./setup-zabbix.mdx#creating-a-host) - * [Configuring the SNMP interface](./setup-zabbix.mdx#configuring-the-snmp-interface) - * [Overriding the memory threshold macros](./setup-zabbix.mdx#overriding-the-memory-threshold-macros) - * [Confirming Zabbix is collecting values](./setup-zabbix.mdx#confirming-zabbix-is-collecting-values) - * [Triggers](./setup-zabbix.mdx#triggers) - * [Triggers included with the template](./setup-zabbix.mdx#triggers-included-with-the-template) - * [Adding a custom trigger](./setup-zabbix.mdx#adding-a-custom-trigger) - * [Setting up notifications](./setup-zabbix.mdx#setting-up-notifications) + * [Prerequisites](#prerequisites) + * [Importing the template](#importing-the-template) + * [Creating a host](#creating-a-host) + * [Configuring the SNMP interface](#configuring-the-snmp-interface) + * [Overriding the memory threshold macros](#overriding-the-memory-threshold-macros) + * [Confirming Zabbix is collecting values](#confirming-zabbix-is-collecting-values) + * [Triggers](#triggers) + * [Triggers included with the template](#triggers-included-with-the-template) + * [Adding a custom trigger](#adding-a-custom-trigger) + * [Setting up notifications](#setting-up-notifications) diff --git a/versioned_docs/version-7.1/server/administration/snmp/snmp-overview.mdx b/versioned_docs/version-7.1/server/administration/snmp/snmp-overview.mdx index 553d624560..a584723bda 100644 --- a/versioned_docs/version-7.1/server/administration/snmp/snmp-overview.mdx +++ b/versioned_docs/version-7.1/server/administration/snmp/snmp-overview.mdx @@ -23,20 +23,20 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov * This page explains how to use SNMP to monitor RavenDB and what metrics can be accessed. * In this page: - * [Overview](../../../server/administration/snmp/snmp-overview.mdx#overview) - * [Enabling SNMP in RavenDB](../../../server/administration/snmp/snmp-overview.mdx#enabling-snmp-in-ravendb) - * [SNMP Configuration options](../../../server/administration/snmp/snmp-overview.mdx#snmp-configuration-options) - * [The Metrics](../../../server/administration/snmp/snmp-overview.mdx#the-metrics) - * [Access metrics via monitoring tools](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-monitoring-tools) - * [Access metrics via SNMP agents](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-snmp-agents) - * [Access metrics via HTTP](../../../server/administration/snmp/snmp-overview.mdx#access-metrics-via-http) - * [List of OIDs](../../../server/administration/snmp/snmp-overview.mdx#list-of-oids) - * [Server OIDs](../../../server/administration/snmp/snmp-overview.mdx#server-oids) - * [Cluster OIDs](../../../server/administration/snmp/snmp-overview.mdx#cluster-oids) - * [Database OIDs](../../../server/administration/snmp/snmp-overview.mdx#database-oids) - * [Index OIDs](../../../server/administration/snmp/snmp-overview.mdx#index-oids) - * [General OIDs](../../../server/administration/snmp/snmp-overview.mdx#general-oids) - * [Ongoing tasks OIDs](../../../server/administration/snmp/snmp-overview.mdx#ongoing-tasks-oids) + * [Overview](#overview) + * [Enabling SNMP in RavenDB](#enabling-snmp-in-ravendb) + * [SNMP Configuration options](#snmp-configuration-options) + * [The Metrics](#the-metrics) + * [Access metrics via monitoring tools](#access-metrics-via-monitoring-tools) + * [Access metrics via SNMP agents](#access-metrics-via-snmp-agents) + * [Access metrics via HTTP](#access-metrics-via-http) + * [List of OIDs](#list-of-oids) + * [Server OIDs](#server-oids) + * [Cluster OIDs](#cluster-oids) + * [Database OIDs](#database-oids) + * [Index OIDs](#index-oids) + * [General OIDs](#general-oids) + * [Ongoing tasks OIDs](#ongoing-tasks-oids) ## Overview @@ -49,7 +49,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov * In RavenDB we have support for SNMP which allows monitoring tools like [Zabbix](https://www.zabbix.com), [PRTG](https://www.paessler.com/prtg), and [Datadog](https://www.datadoghq.com/) direct access to the - internal details of RavenDB. We expose a long [list of metrics](../../../server/administration/snmp/snmp-overview.mdx#list-of-oids): CPU and memory usage, server total requests, + internal details of RavenDB. We expose a long [list of metrics](#list-of-oids): CPU and memory usage, server total requests, the loaded databases, and database-specific metrics like the number of indexed items per second, document writes per second, storage space each database takes, and more. @@ -148,7 +148,7 @@ There are several configurable SNMP properties in RavenDB: Each metric has a unique object identifier (OID) and can be accessed individually. * The most basic SNMP commands are `snmpget`, `snmpset` and `snmpwalk`. - For example, you can execute the following _snmpget_ commands to retrieve the server's [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13). + For example, you can execute the following _snmpget_ commands to retrieve the server's [up-time metric](#13). ##### For SNMPv2c: @@ -192,7 +192,7 @@ iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73 * An individual OID value can be retrieved via HTTP `GET` endpoint: `/monitoring/snmp?oid=` -* For example, a cURL request for the server [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13): +* For example, a cURL request for the server [up-time metric](#13): @@ -209,7 +209,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 * Multiple OID values can be retrieved by making either a `GET` or a `POST` request to the following HTTP endpoint: `/monitoring/snmp/bulk` -* For example, cURL requests for the server [managed memory](../../../server/administration/snmp/snmp-overview.mdx#167) and [unmanaged memory](../../../server/administration/snmp/snmp-overview.mdx#168) metrics: +* For example, cURL requests for the server [managed memory](#167) and [unmanaged memory](#168) metrics: @@ -317,7 +317,7 @@ curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1 | 1.6.11.`X`.14 | GC info for `X`.
Gets the total available memory (in MB) for the garbage collector to use when the last garbage collection occurred. | | 1.6.11.`X`.15 | GC info for `X`.
Gets the total committed MB of the managed heap. | | 1.6.11.`X`.16.3 | GC info for `X`.
Gets the large object heap size (in MB) after the last garbage collection of given kind occurred. | -| 1.6.12.{0} | Monitor [/proc/meminfo/](https://man7.org/linux/man-pages/man5/proc.5.html) metrics (unix/linux).
The description of each metric is available via endpoint `/monitoring/snmp/oids`.
See [Get all OIDs](../../../server/administration/snmp/snmp-overview.mdx#getalloids). | +| 1.6.12.{0} | Monitor [/proc/meminfo/](https://man7.org/linux/man-pages/man5/proc.5.html) metrics (unix/linux).
The description of each metric is available via endpoint `/monitoring/snmp/oids`.
See [Get all OIDs](#getalloids). | | 1.6.13 | Available memory for processing (in MB) | | 1.7.1 | Number of concurrent requests | | 1.7.2 | Total number of requests since server startup | diff --git a/versioned_docs/version-7.1/server/clustering/cluster-api.mdx b/versioned_docs/version-7.1/server/clustering/cluster-api.mdx index 4136070c86..5b45948293 100644 --- a/versioned_docs/version-7.1/server/clustering/cluster-api.mdx +++ b/versioned_docs/version-7.1/server/clustering/cluster-api.mdx @@ -19,13 +19,13 @@ All cluster operations are available through the GUI. However, sometimes you'd w In this section we will demonstrate of how to perform certain cluster operations programmatically using the REST API. In the first example we will show how to make a secure call using PowerShell, cURL and the RavenDB C# Client. The rest of the examples are cURL only. -- [Add node to the cluster](../../server/clustering/cluster-api.mdx#add-node-to-the-cluster) -- [Delete node from the cluster](../../server/clustering/cluster-api.mdx#delete-node-from-the-cluster) -- [Promote a watcher node](../../server/clustering/cluster-api.mdx#promote-a-node) -- [Demote a watcher node](../../server/clustering/cluster-api.mdx#demote-a-node) -- [Force elections](../../server/clustering/cluster-api.mdx#force-elections) -- [Force timeout](../../server/clustering/cluster-api.mdx#force-timeout) -- [Bootstrap the cluster](../../server/clustering/cluster-api.mdx#bootstrap-cluster) +- [Add node to the cluster](#add-node-to-the-cluster) +- [Delete node from the cluster](#delete-node-from-the-cluster) +- [Promote a watcher node](#promote-a-node) +- [Demote a watcher node](#demote-a-node) +- [Force elections](#force-elections) +- [Force timeout](#force-timeout) +- [Bootstrap the cluster](#bootstrap-cluster) If authentication is turned on, a client certificate with either `Cluster Admin` or `Operator` [Security Clearance](../../server/security/authorization/security-clearance-and-permissions.mdx) must be supplied, depending on the endpoint. diff --git a/versioned_docs/version-7.1/server/clustering/cluster-best-practice-and-configuration.mdx b/versioned_docs/version-7.1/server/clustering/cluster-best-practice-and-configuration.mdx index dac986e47b..5322a402d4 100644 --- a/versioned_docs/version-7.1/server/clustering/cluster-best-practice-and-configuration.mdx +++ b/versioned_docs/version-7.1/server/clustering/cluster-best-practice-and-configuration.mdx @@ -15,8 +15,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Clusters should have an odd number of at least 3 nodes](../../server/clustering/cluster-best-practice-and-configuration.mdx#clusters-should-have-an-odd-number-of-at-least-3-nodes) - * [Avoid different cluster configurations among the cluster's nodes](../../server/clustering/cluster-best-practice-and-configuration.mdx#avoid-different-cluster-configurations-among-the-clusters-nodes) + * [Clusters should have an odd number of at least 3 nodes](#clusters-should-have-an-odd-number-of-at-least-3-nodes) + * [Avoid different cluster configurations among the cluster's nodes](#avoid-different-cluster-configurations-among-the-clusters-nodes) diff --git a/versioned_docs/version-7.1/server/clustering/cluster-transactions.mdx b/versioned_docs/version-7.1/server/clustering/cluster-transactions.mdx index ed41bf05d8..c277883784 100644 --- a/versioned_docs/version-7.1/server/clustering/cluster-transactions.mdx +++ b/versioned_docs/version-7.1/server/clustering/cluster-transactions.mdx @@ -19,12 +19,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Code examples and client API can be found [here](../../client-api/session/saving-changes.mdx#transaction-mode---cluster-wide). * In this page: - * [Why Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#why-cluster-wide-transactions) - * [How Cluster Transactions Work](../../server/clustering/cluster-transactions.mdx#how-cluster-transactions-work) described by the flow of a cluster transaction request example. - * [Cluster Transactions Properties](../../server/clustering/cluster-transactions.mdx#cluster-transactions-properties) - * [Concurrent Cluster-Wide and Single-Node Transactions](../../server/clustering/cluster-transactions.mdx#concurrent-cluster-wide-and-single-node-transactions) - * [Failure Modes in Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#failure-modes-in-cluster-wide-transactions) - * [Debug Cluster-Wide Transactions](../../server/clustering/cluster-transactions.mdx#debug-cluster-wide-transactions) + * [Why Cluster-Wide Transactions](#why-cluster-wide-transactions) + * [How Cluster Transactions Work](#how-cluster-transactions-work) described by the flow of a cluster transaction request example. + * [Cluster Transactions Properties](#cluster-transactions-properties) + * [Concurrent Cluster-Wide and Single-Node Transactions](#concurrent-cluster-wide-and-single-node-transactions) + * [Failure Modes in Cluster-Wide Transactions](#failure-modes-in-cluster-wide-transactions) + * [Debug Cluster-Wide Transactions](#debug-cluster-wide-transactions) ## Why Cluster-Wide Transactions @@ -94,7 +94,7 @@ After having a quorum for the cluster transaction request by raft and a successf of the compare exchange values, the transaction is guaranteed to be executed. Failure during the quorum or the concurrency check will roll back the entire session transaction, while failure during the commit of the documents will halt any further cluster transactions execution on the database -until that failure is remedied (failure mode for the documents commits are described later [here](../../server/clustering/cluster-transactions.mdx#failure-modes-in-cluster-wide-transactions)). +until that failure is remedied (failure mode for the documents commits are described later [here](#failure-modes-in-cluster-wide-transactions)). **Consistency** Consistency is guaranteed on the requested node. The node will complete the request only when the transaction is completed diff --git a/versioned_docs/version-7.1/server/clustering/distribution/cluster-observer.mdx b/versioned_docs/version-7.1/server/clustering/distribution/cluster-observer.mdx index 1856067658..d23ac4d583 100644 --- a/versioned_docs/version-7.1/server/clustering/distribution/cluster-observer.mdx +++ b/versioned_docs/version-7.1/server/clustering/distribution/cluster-observer.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This observer is always running on the [Leader](../../../server/clustering/rachis/cluster-topology.mdx#leader) node. * In this page: - * [Operation flow](../../../server/clustering/distribution/cluster-observer.mdx#operation-flow) - * [Interacting with the Cluster Observer](../../../server/clustering/distribution/cluster-observer.mdx#interacting-with-the-cluster-observer) + * [Operation flow](#operation-flow) + * [Interacting with the Cluster Observer](#interacting-with-the-cluster-observer) ## Operation flow diff --git a/versioned_docs/version-7.1/server/clustering/distribution/distributed-database.mdx b/versioned_docs/version-7.1/server/clustering/distribution/distributed-database.mdx index 903275f53f..acc36acec5 100644 --- a/versioned_docs/version-7.1/server/clustering/distribution/distributed-database.mdx +++ b/versioned_docs/version-7.1/server/clustering/distribution/distributed-database.mdx @@ -14,21 +14,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Distributed Database -* In RavenDB, a database can be replicated across multiple nodes, depending on its [Replication Factor](../../../server/clustering/distribution/distributed-database.mdx#replication-factor). +* In RavenDB, a database can be replicated across multiple nodes, depending on its [Replication Factor](#replication-factor). * A node where a database resides is referred to as a `Database Node`. The group of _Database Nodes_ that assemble the distributed database, is called a [Database Group](../../../studio/database/settings/manage-database-group.mdx). -* Unless [Sharding](../../../server/clustering/distribution/distributed-database.mdx#sharding) is employed, +* Unless [Sharding](#sharding) is employed, each Database Node has a **full copy** of the database, containing **all** the database documents, and indexes them **locally**. This greatly simplifies executing query requests, as there is no need to aggregate data from multiple nodes. * In this page: - * [The Database Record](../../../server/clustering/distribution/distributed-database.mdx#the-database-record) - * [Replication Factor](../../../server/clustering/distribution/distributed-database.mdx#replication-factor) - * [Database Topology](../../../server/clustering/distribution/distributed-database.mdx#database-topology) - * [Dynamic Database Distribution](../../../server/clustering/distribution/distributed-database.mdx#dynamic-database-distribution) - * [Sharding](../../../server/clustering/distribution/distributed-database.mdx#sharding) + * [The Database Record](#the-database-record) + * [Replication Factor](#replication-factor) + * [Database Topology](#database-topology) + * [Dynamic Database Distribution](#dynamic-database-distribution) + * [Sharding](#sharding) ## The Database Record diff --git a/versioned_docs/version-7.1/server/clustering/distribution/highly-available-tasks.mdx b/versioned_docs/version-7.1/server/clustering/distribution/highly-available-tasks.mdx index ceb1ad8c1f..f69017a554 100644 --- a/versioned_docs/version-7.1/server/clustering/distribution/highly-available-tasks.mdx +++ b/versioned_docs/version-7.1/server/clustering/distribution/highly-available-tasks.mdx @@ -20,17 +20,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Updating a `Rehab` or a `Promotable` [Database Node](../../../server/clustering/distribution/distributed-database.mdx#database-topology) * There is no single coordinator handing out tasks to a specific node. - Instaed, each node decides on its own if it is the [Reponsible Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) of the task. + Instaed, each node decides on its own if it is the [Reponsible Node](#responsible-node) of the task. * Each node will re-evaluate its responsibilities with every change made to the [Database Record](../../../client-api/operations/server-wide/create-database.mdx), such as defining a new _index_, configuring or modifying an _Ongoing Task_, any _Database Topology_ change, etc. * In this page: - * [License](../../../server/clustering/distribution/highly-available-tasks.mdx#license) - * [Constraints](../../../server/clustering/distribution/highly-available-tasks.mdx#constraints) - * [Responsible Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) - * [Tasks Relocation](../../../server/clustering/distribution/highly-available-tasks.mdx#tasks-relocation) - * [Pinning a Task](../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) + * [License](#license) + * [Constraints](#constraints) + * [Responsible Node](#responsible-node) + * [Tasks Relocation](#tasks-relocation) + * [Pinning a Task](#pinning-a-task) ## License @@ -49,7 +49,7 @@ to verify whether the Highly Available Tasks feature is activated in your databa * If your license does **not** provide highly available tasks, the responsibilites of a failed node will be resumed when the node returns online. -* Scenarios [below](../../../server/clustering/distribution/highly-available-tasks.mdx#tasks-relocation) +* Scenarios [below](#tasks-relocation) are meant to demonstrate the behavior of a system licensed for highly available tasks. diff --git a/versioned_docs/version-7.1/server/clustering/rachis/cluster-topology.mdx b/versioned_docs/version-7.1/server/clustering/rachis/cluster-topology.mdx index 789d3001bd..c4fac32713 100644 --- a/versioned_docs/version-7.1/server/clustering/rachis/cluster-topology.mdx +++ b/versioned_docs/version-7.1/server/clustering/rachis/cluster-topology.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Clusters are typically composed of any odd number of nodes equal or greater than 3, see [Clusters Best Practice](../../../server/clustering/cluster-best-practice-and-configuration.mdx). * In this page: - * [Fetching the topology](../../../server/clustering/rachis/cluster-topology.mdx#fetching-the-topology) - * [Modifying the topology](../../../server/clustering/rachis/cluster-topology.mdx#modifying-the-topology) - * [Nodes states and types](../../../server/clustering/rachis/cluster-topology.mdx#nodes-states-and-types) - * [Changing node type](../../../server/clustering/rachis/cluster-topology.mdx#changing-node-type) + * [Fetching the topology](#fetching-the-topology) + * [Modifying the topology](#modifying-the-topology) + * [Nodes states and types](#nodes-states-and-types) + * [Changing node type](#changing-node-type) ## Fetching the topology @@ -52,14 +52,14 @@ Optional parameters (for the Add Node endpoint): | Name | Value type | Description | |------------------|--------------|--------------------------------------------------------------------------------------------------------------| | tag | `string` | The node tag. 1-4 uppercase unicode letters.
Default: 'A' - 'Z' assigned by order of addition. | -| watcher | `bool` | Add the node as a [Watcher](../../../server/clustering/rachis/cluster-topology.mdx#watcher).
Default: `false` | +| watcher | `bool` | Add the node as a [Watcher](#watcher).
Default: `false` | | maxUtilizedCores | `uint` | Maximum number of cores that can be assigned to this node.
Default: number of processors. | See the [Cluster API page](../../../server/clustering/cluster-api.mdx) for usage examples. ## Nodes states and types -In Rachis every cluster node has a [state](../../../server/clustering/rachis/cluster-topology.mdx#state) and a [type](../../../server/clustering/rachis/cluster-topology.mdx#type). +In Rachis every cluster node has a [state](#state) and a [type](#type). @@ -72,7 +72,7 @@ and **elect** a new leader when needed. |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Member** | A fully functional voting node in the cluster. | | **Promotable** | A non-voting node.
This is an intermediate stage until node is promoted by the Leader to a Member. | -| **Watcher** | A non-voting node that is still fully managed by the cluster.
Can be assigned with databases and tasks. See more [below](../../../server/clustering/rachis/cluster-topology.mdx#watcher). | +| **Watcher** | A non-voting node that is still fully managed by the cluster.
Can be assigned with databases and tasks. See more [below](#watcher). | @@ -88,7 +88,7 @@ The Rachis state defines the **current role** of the node in the cluster. | **Candidate** | Has no Leader and tries to get elected for leadership. | | **Follower** | Has a Leader and operates normally. | | **Leader-Elect** | Just elected for leadership, but will take office and become the leader only after the dummy `noop` raft command was successfully applied in the cluster. | -| **Leader** | Leader of the cluster. See more [below](../../../server/clustering/rachis/cluster-topology.mdx#leader). | +| **Leader** | Leader of the cluster. See more [below](#leader). | diff --git a/versioned_docs/version-7.1/server/clustering/rachis/consensus-operations.mdx b/versioned_docs/version-7.1/server/clustering/rachis/consensus-operations.mdx index b906754cd4..e9fb539f30 100644 --- a/versioned_docs/version-7.1/server/clustering/rachis/consensus-operations.mdx +++ b/versioned_docs/version-7.1/server/clustering/rachis/consensus-operations.mdx @@ -22,9 +22,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Only after the cluster's approval (majority of nodes ), it will _eventually_ be executed on all cluster nodes. * In this page: - * [Operations that require Consensus](../../../server/clustering/rachis/consensus-operations.mdx#operations-that-require-consensus) - * [Operations that do not require Consensus](../../../server/clustering/rachis/consensus-operations.mdx#operations-that-do-not-require-consensus) - * [Raft Commands Implementation Details](../../../server/clustering/rachis/consensus-operations.mdx#raft-commands-implementation-details) + * [Operations that require Consensus](#operations-that-require-consensus) + * [Operations that do not require Consensus](#operations-that-do-not-require-consensus) + * [Raft Commands Implementation Details](#raft-commands-implementation-details) ## Operations that require Consensus @@ -36,7 +36,7 @@ Since getting a consensus is an expensive operation, it is limited to the follow * Creating / Deleting Indexes (static and auto indexes) * Configuring the [Ongoing Tasks](../../../studio/database/tasks/ongoing-tasks/general-info.mdx) -See [Implementation Details](../../../server/clustering/rachis/consensus-operations.mdx#implementation-details) below. +See [Implementation Details](#implementation-details) below. diff --git a/versioned_docs/version-7.1/server/clustering/replication/advanced-replication.mdx b/versioned_docs/version-7.1/server/clustering/replication/advanced-replication.mdx index b6b780d0ce..ab3effb019 100644 --- a/versioned_docs/version-7.1/server/clustering/replication/advanced-replication.mdx +++ b/versioned_docs/version-7.1/server/clustering/replication/advanced-replication.mdx @@ -22,7 +22,7 @@ Whenever the replication process between two databases is initiated it has to de 3. Once the _source_ gets the OK message it queries the _destination_ about the latest ETag it got from him. 4. The _destination_ sends back a heartbeat message with both the latest `ETag` he got from the _source_ and the current [Change Vector](../../../server/clustering/replication/change-vector.mdx) of the database. 5. The `ETag` is used as a starting point for the replication process but it is then been filtered by the _destination's_ current `change vector`, -meaning we will skip documents with higher `ETag` and lower `Change Vector`, this is done to prevent the [Ripple Effect](../../../server/clustering/replication/advanced-replication.mdx#preventing-the-ripple-effect). +meaning we will skip documents with higher `ETag` and lower `Change Vector`, this is done to prevent the [Ripple Effect](#preventing-the-ripple-effect). ## Preventing the Ripple Effect diff --git a/versioned_docs/version-7.1/server/clustering/replication/change-vector.mdx b/versioned_docs/version-7.1/server/clustering/replication/change-vector.mdx index 2135fa47d9..bba9fbeb35 100644 --- a/versioned_docs/version-7.1/server/clustering/replication/change-vector.mdx +++ b/versioned_docs/version-7.1/server/clustering/replication/change-vector.mdx @@ -17,17 +17,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Change vectors are the RavenDB implementation of the [Vector clock](https://en.wikipedia.org/wiki/Vector_clock) concept. They give us partial order over modifications of documents in a RavenDB cluster. -* Change vectors are updated every time a document is [modified](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors) +* Change vectors are updated every time a document is [modified](#concurrency-control--change-vectors) in any way. * In this page: - * [What are Change Vectors Constructed From?](../../../server/clustering/replication/change-vector.mdx#what-are-change-vectors-constructed-from) - * [How are Change Vectors used to Determine Order?](../../../server/clustering/replication/change-vector.mdx#how-are-change-vectors-used-to-determine-order) - * [Concurrency Control & Change Vectors](../../../server/clustering/replication/change-vector.mdx#concurrency-control--change-vectors) - * [Change Vector Comparisons](../../../server/clustering/replication/change-vector.mdx#change-vector-comparisons) - * [Concurrency Control at the Cluster](../../../server/clustering/replication/change-vector.mdx#concurrency-control-at-the-cluster) - * [Database Global Change Vector](../../../server/clustering/replication/change-vector.mdx#database-global-change-vector) - * [After Restoring a Database from Backup](../../../server/clustering/replication/change-vector.mdx#after-restoring-a-database-from-backup) + * [What are Change Vectors Constructed From?](#what-are-change-vectors-constructed-from) + * [How are Change Vectors used to Determine Order?](#how-are-change-vectors-used-to-determine-order) + * [Concurrency Control & Change Vectors](#concurrency-control--change-vectors) + * [Change Vector Comparisons](#change-vector-comparisons) + * [Concurrency Control at the Cluster](#concurrency-control-at-the-cluster) + * [Database Global Change Vector](#database-global-change-vector) + * [After Restoring a Database from Backup](#after-restoring-a-database-from-backup) ## What are Change Vectors Constructed From? @@ -182,7 +182,7 @@ Note that if data is considered contained by a database it doesn't mean it is pr * [Snapshot backups](../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) save [change vector data](../../../server/ongoing-tasks/backup-overview.mdx#backup-contents). * [Logical backups](../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup) do not save change vector data. - Restoring a database from a logical backup will renew the document change vector's frequently [incrementing ETag](../../../server/clustering/replication/change-vector.mdx#what-are-change-vectors-constructed-from) + Restoring a database from a logical backup will renew the document change vector's frequently [incrementing ETag](#what-are-change-vectors-constructed-from) to its original value. diff --git a/versioned_docs/version-7.1/server/clustering/replication/replication-and-embedded-instance.mdx b/versioned_docs/version-7.1/server/clustering/replication/replication-and-embedded-instance.mdx index 9a216f3cc0..f63e169ea1 100644 --- a/versioned_docs/version-7.1/server/clustering/replication/replication-and-embedded-instance.mdx +++ b/versioned_docs/version-7.1/server/clustering/replication/replication-and-embedded-instance.mdx @@ -19,10 +19,10 @@ Essentially, Embedded RavenDB is the same as non-embedded, their only difference ## Configuring Replication between Embedded Instance and a Cluster ## Examples in this page - * [Configuring cluster membership of embedded instance through the Studio](../../../server/clustering/replication/replication-and-embedded-instance.mdx#configuring-cluster-membership-of-embedded-instance-through-the-studio) - * [Programmatically configuring cluster membership of embedded instance](../../../server/clustering/replication/replication-and-embedded-instance.mdx#programmatically-configuring-cluster-membership-of-embedded-instance) - * [Configuring embedded instance as External Replication destination through the Studio](../../../server/clustering/replication/replication-and-embedded-instance.mdx#configuring-embedded-instance-as-external-replication-destination-through-the-studio) - * [Programmatically embedded instance as External Replication destination](../../../server/clustering/replication/replication-and-embedded-instance.mdx#programmatically-embedded-instance-as-external-replication-destination) + * [Configuring cluster membership of embedded instance through the Studio](#configuring-cluster-membership-of-embedded-instance-through-the-studio) + * [Programmatically configuring cluster membership of embedded instance](#programmatically-configuring-cluster-membership-of-embedded-instance) + * [Configuring embedded instance as External Replication destination through the Studio](#configuring-embedded-instance-as-external-replication-destination-through-the-studio) + * [Programmatically embedded instance as External Replication destination](#programmatically-embedded-instance-as-external-replication-destination) diff --git a/versioned_docs/version-7.1/server/clustering/replication/replication-conflicts.mdx b/versioned_docs/version-7.1/server/clustering/replication/replication-conflicts.mdx index 4a1da72661..54d59be676 100644 --- a/versioned_docs/version-7.1/server/clustering/replication/replication-conflicts.mdx +++ b/versioned_docs/version-7.1/server/clustering/replication/replication-conflicts.mdx @@ -44,8 +44,8 @@ When there is a conflict between two or more document versions, RavenDB will try The identity check applies to [Tombstone](../../../glossary/tombstone.mdx) as well, and it will always resolve to the local one, since the tombstones are always considered equal. -3. Try to resolve the conflict by using a script, which is set up by configuring a [Conflict Resolver](../../../server/clustering/replication/replication-conflicts.mdx#conflict-resolution-script). -4. If all else fails, record conflicting document variants as "Conflicted Documents" which will have to be resolved [Manually](../../../server/clustering/replication/replication-conflicts.mdx#manually-resolving-conflicts). +3. Try to resolve the conflict by using a script, which is set up by configuring a [Conflict Resolver](#conflict-resolution-script). +4. If all else fails, record conflicting document variants as "Conflicted Documents" which will have to be resolved [Manually](#manually-resolving-conflicts). ## Conflict Resolution Script A resolution script is defined per collection and have the following input arguments: diff --git a/versioned_docs/version-7.1/server/clustering/replication/replication-overview.mdx b/versioned_docs/version-7.1/server/clustering/replication/replication-overview.mdx index 9e689cc32a..9ab2c384db 100644 --- a/versioned_docs/version-7.1/server/clustering/replication/replication-overview.mdx +++ b/versioned_docs/version-7.1/server/clustering/replication/replication-overview.mdx @@ -25,13 +25,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; are resolved according to the defined [conflict resolution](../../../server/clustering/replication/replication-conflicts.mdx) policy on the receiving end. * In this page: - * [Replication types](../../../server/clustering/replication/replication-overview.mdx#replication-types) - * [Internal replication](../../../server/clustering/replication/replication-overview.mdx#internal-replication) - * [External replication](../../../server/clustering/replication/replication-overview.mdx#external-replication) - * [Hub/Sink replication](../../../server/clustering/replication/replication-overview.mdx#hubsink-replication) - * [What is replicated](../../../server/clustering/replication/replication-overview.mdx#what-is-replicated) - * [How replication works](../../../server/clustering/replication/replication-overview.mdx#how-replication-works) - * [Replication & transaction boundary](../../../server/clustering/replication/replication-overview.mdx#replication--transaction-boundary) + * [Replication types](#replication-types) + * [Internal replication](#internal-replication) + * [External replication](#external-replication) + * [Hub/Sink replication](#hubsink-replication) + * [What is replicated](#what-is-replicated) + * [How replication works](#how-replication-works) + * [Replication & transaction boundary](#replication--transaction-boundary) ## Replication types @@ -162,7 +162,7 @@ __Replication & cluster-wide transactions__ is either persisted on all database group nodes or rolled back on all upon failure. * After a cluster consensus is reached, the Raft command to be executed is propagated to all nodes. - When the command is executed locally on a node, if the items that are persisted are of the [type that replicates](../../../server/clustering/replication/replication-overview.mdx#what-is-replicated), + When the command is executed locally on a node, if the items that are persisted are of the [type that replicates](#what-is-replicated), then the node will __replicate__ them to the other nodes via the replication process. * A node that receives such replication will accept this write, diff --git a/versioned_docs/version-7.1/server/configuration/ai-integration-configuration.mdx b/versioned_docs/version-7.1/server/configuration/ai-integration-configuration.mdx index 559c645e1d..3ce02a7645 100644 --- a/versioned_docs/version-7.1/server/configuration/ai-integration-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/ai-integration-configuration.mdx @@ -20,15 +20,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Learn how to apply these keys in the [Configuration Overview](../../server/configuration/configuration-options.mdx) article. * On this page: - * [Embeddings configuration keys](../../server/configuration/ai-integration-configuration.mdx#embeddings-configuration-keys) - * [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxbatchsize) - * [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) - * [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxfallbacktimeinsec) - * [AI Agents configuration keys](../../server/configuration/ai-integration-configuration.mdx#ai-agents-configuration-keys) - * [Ai.Agent.Tools.TokenUsageThreshold](../../server/configuration/ai-integration-configuration.mdx#aiagenttoolstokenusagethreshold) - * [Ai.Agent.Trimming.Summarization.SummarizationResultPrefix](../../server/configuration/ai-integration-configuration.mdx#aiagenttrimmingsummarizationsummarizationresultprefix) - * [Ai.Agent.Trimming.Summarization.SummarizationTaskBeginningPrompt](../../server/configuration/ai-integration-configuration.mdx#aiagenttrimmingsummarizationsummarizationtaskbeginningprompt) - * [Ai.Agent.Trimming.Summarization.SummarizationTaskEndPrompt](../../server/configuration/ai-integration-configuration.mdx#aiagenttrimmingsummarizationsummarizationtaskendprompt) + * [Embeddings configuration keys](#embeddings-configuration-keys) + * [Ai.Embeddings.MaxBatchSize](#aiembeddingsmaxbatchsize) + * [Ai.Embeddings.MaxConcurrentBatches](#aiembeddingsmaxconcurrentbatches) + * [Ai.Embeddings.MaxFallbackTimeInSec](#aiembeddingsmaxfallbacktimeinsec) + * [AI Agents configuration keys](#ai-agents-configuration-keys) + * [Ai.Agent.Tools.TokenUsageThreshold](#aiagenttoolstokenusagethreshold) + * [Ai.Agent.Trimming.Summarization.SummarizationResultPrefix](#aiagenttrimmingsummarizationsummarizationresultprefix) + * [Ai.Agent.Trimming.Summarization.SummarizationTaskBeginningPrompt](#aiagenttrimmingsummarizationsummarizationtaskbeginningprompt) + * [Ai.Agent.Trimming.Summarization.SummarizationTaskEndPrompt](#aiagenttrimmingsummarizationsummarizationtaskendprompt) diff --git a/versioned_docs/version-7.1/server/configuration/backup-configuration.mdx b/versioned_docs/version-7.1/server/configuration/backup-configuration.mdx index 4a9d032b44..725bc0a0e7 100644 --- a/versioned_docs/version-7.1/server/configuration/backup-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/backup-configuration.mdx @@ -19,14 +19,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Another relevant server configuration option can be found [here](../../server/configuration/server-configuration.mdx#servercpucreditsexhaustionbackupdelayinmin). * In this page: - * [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backuptemppath) - * [Backup.LocalRootPath](../../server/configuration/backup-configuration.mdx#backuplocalrootpath) - * [Backup.AllowedDestinations](../../server/configuration/backup-configuration.mdx#backupalloweddestinations) - * [Backup.AllowedAwsRegions](../../server/configuration/backup-configuration.mdx#backupallowedawsregions) - * [Backup.MaxNumberOfConcurrentBackups](../../server/configuration/backup-configuration.mdx#backupmaxnumberofconcurrentbackups) - * [Backup.ConcurrentBackupsDelayInSec](../../server/configuration/backup-configuration.mdx#backupconcurrentbackupsdelayinsec) - * [Backup.LowMemoryBackupDelayInMin](../../server/configuration/backup-configuration.mdx#backuplowmemorybackupdelayinmin) - * [Backup.MoveToNewResponsibleNodeGracePeriodInMin](../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin) + * [Backup.TempPath](#backuptemppath) + * [Backup.LocalRootPath](#backuplocalrootpath) + * [Backup.AllowedDestinations](#backupalloweddestinations) + * [Backup.AllowedAwsRegions](#backupallowedawsregions) + * [Backup.MaxNumberOfConcurrentBackups](#backupmaxnumberofconcurrentbackups) + * [Backup.ConcurrentBackupsDelayInSec](#backupconcurrentbackupsdelayinsec) + * [Backup.LowMemoryBackupDelayInMin](#backuplowmemorybackupdelayinmin) + * [Backup.MoveToNewResponsibleNodeGracePeriodInMin](#backupmovetonewresponsiblenodegraceperiodinmin) ## Backup.TempPath diff --git a/versioned_docs/version-7.1/server/configuration/cluster-configuration.mdx b/versioned_docs/version-7.1/server/configuration/cluster-configuration.mdx index 00f4418e85..e4719125e2 100644 --- a/versioned_docs/version-7.1/server/configuration/cluster-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/cluster-configuration.mdx @@ -26,30 +26,30 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Server-wide scope: - [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](../../server/configuration/cluster-configuration.mdx#clustercompareexchangeexpireddeletefrequencyinsec) - [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration.mdx#clustercompareexchangetombstonescleanupintervalinmin) - [Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clusterelectiontimeoutinms) - [Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration.mdx#clusterharddeleteonreplacement) - [Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration.mdx#clusterloghistorymaxentries) - [Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration.mdx#clustermaxchangevectordistance) - [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) - [Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration.mdx#clustermaxsizeofsingleraftcommandinmb) - [Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration.mdx#clustermaximalallowedclusterversion) - [Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration.mdx#clusteronerrordelaytimeinms) - [Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration.mdx#clusteroperationtimeoutinsec) - [Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clusterreceivefromworkertimeoutinms) - [Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration.mdx#clusterstatsstabilizationtimeinsec) - [Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#clustersupervisorsampleperiodinms) - [Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#clustertcpreceivebuffersizeinbytes) - [Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#clustertcpsendbuffersizeinbytes) - [Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration.mdx#clustertcptimeoutinms) - [Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) - [Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) - [Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration.mdx#clustertimebeforerotatingpreferrednodeinsec) - [Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#clusterworkersampleperiodinms) + [Cluster.CompareExchangeExpiredDeleteFrequencyInSec](#clustercompareexchangeexpireddeletefrequencyinsec) + [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](#clustercompareexchangetombstonescleanupintervalinmin) + [Cluster.ElectionTimeoutInMs](#clusterelectiontimeoutinms) + [Cluster.HardDeleteOnReplacement](#clusterharddeleteonreplacement) + [Cluster.LogHistoryMaxEntries](#clusterloghistorymaxentries) + [Cluster.MaxChangeVectorDistance](#clustermaxchangevectordistance) + [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](#clustermaxclustertransactioncompareexchangetombstonecheckintervalinmin) + [Cluster.MaxSizeOfSingleRaftCommandInMb](#clustermaxsizeofsingleraftcommandinmb) + [Cluster.MaximalAllowedClusterVersion](#clustermaximalallowedclusterversion) + [Cluster.OnErrorDelayTimeInMs](#clusteronerrordelaytimeinms) + [Cluster.OperationTimeoutInSec](#clusteroperationtimeoutinsec) + [Cluster.ReceiveFromWorkerTimeoutInMs](#clusterreceivefromworkertimeoutinms) + [Cluster.StatsStabilizationTimeInSec](#clusterstatsstabilizationtimeinsec) + [Cluster.SupervisorSamplePeriodInMs](#clustersupervisorsampleperiodinms) + [Cluster.TcpReceiveBufferSizeInBytes](#clustertcpreceivebuffersizeinbytes) + [Cluster.TcpSendBufferSizeInBytes](#clustertcpsendbuffersizeinbytes) + [Cluster.TcpTimeoutInMs](#clustertcptimeoutinms) + [Cluster.TimeBeforeAddingReplicaInSec](#clustertimebeforeaddingreplicainsec) + [Cluster.TimeBeforeMovingToRehabInSec](#clustertimebeforemovingtorehabinsec) + [Cluster.TimeBeforeRotatingPreferredNodeInSec](#clustertimebeforerotatingpreferrednodeinsec) + [Cluster.WorkerSamplePeriodInMs](#clusterworkersampleperiodinms) * Server-wide, or database scope: - [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#clusterdisableatomicdocumentwrites) - [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactionbatchsize) + [Cluster.DisableAtomicDocumentWrites](#clusterdisableatomicdocumentwrites) + [Cluster.MaxClusterTransactionBatchSize](#clustermaxclustertransactionbatchsize) ## Cluster.CompareExchangeExpiredDeleteFrequencyInSec diff --git a/versioned_docs/version-7.1/server/configuration/configuration-options.mdx b/versioned_docs/version-7.1/server/configuration/configuration-options.mdx index d4e1983157..0b7e974072 100644 --- a/versioned_docs/version-7.1/server/configuration/configuration-options.mdx +++ b/versioned_docs/version-7.1/server/configuration/configuration-options.mdx @@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; If needed, you can customize the default configuration to suit your specific needs. * Any **configuration key** can be modified by either of the following options: - * [Environment variables](../../server/configuration/configuration-options.mdx#environment-variables) - * [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) - * [Command line arguments](../../server/configuration/configuration-options.mdx#command-line-arguments) - * [Database settings view](../../server/configuration/configuration-options.mdx#database-settings-view) (database scope only) + * [Environment variables](#environment-variables) + * [settings.json](#settingsjson) + * [Command line arguments](#command-line-arguments) + * [Database settings view](#database-settings-view) (database scope only) @@ -54,7 +54,7 @@ $Env:RAVEN_Security_Certificate_Path=/config/raven-server.certificate.pfx _settings.json_ configuration values **override** their matching -[environment variables](../../server/configuration/configuration-options.mdx#environment-variables) values. +[environment variables](#environment-variables) values. * The `settings.json` file is created by RavenDB when running the server for the first time, @@ -102,8 +102,8 @@ for example, use: Command line arguments configuration values **override** their matching -[environment variables](../../server/configuration/configuration-options.mdx#environment-variables) -and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) values. +[environment variables](#environment-variables) +and [settings.json](#settingsjson) values. * The server can be configured using command line arguments that are passed to the console application diff --git a/versioned_docs/version-7.1/server/configuration/database-configuration.mdx b/versioned_docs/version-7.1/server/configuration/database-configuration.mdx index 7cf37d7d18..51e2754ea5 100644 --- a/versioned_docs/version-7.1/server/configuration/database-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/database-configuration.mdx @@ -18,21 +18,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Databases.Compression.CompressAllCollectionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault) - [Databases.Compression.CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) - [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesconcurrentloadtimeoutinsec) - [Databases.FrequencyToCheckForIdleInSec](../../server/configuration/database-configuration.mdx#databasesfrequencytocheckforidleinsec) - [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databasesmaxconcurrentloads) + [Databases.Compression.CompressAllCollectionsDefault](#databasescompressioncompressallcollectionsdefault) + [Databases.Compression.CompressRevisionsDefault](#databasescompressioncompressrevisionsdefault) + [Databases.ConcurrentLoadTimeoutInSec](#databasesconcurrentloadtimeoutinsec) + [Databases.FrequencyToCheckForIdleInSec](#databasesfrequencytocheckforidleinsec) + [Databases.MaxConcurrentLoads](#databasesmaxconcurrentloads) * Server-wide, or database scope: - [Databases.CollectionOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasescollectionoperationtimeoutinsec) - [Databases.DeepCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databasesdeepcleanupthresholdinmin) - [Databases.MaxIdleTimeInSec](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec) - [Databases.OperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesoperationtimeoutinsec) - [Databases.PulseReadTransactionLimitInMb](../../server/configuration/database-configuration.mdx#databasespulsereadtransactionlimitinmb) - [Databases.QueryOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) - [Databases.QueryTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) - [Databases.RegularCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databasesregularcleanupthresholdinmin) + [Databases.CollectionOperationTimeoutInSec](#databasescollectionoperationtimeoutinsec) + [Databases.DeepCleanupThresholdInMin](#databasesdeepcleanupthresholdinmin) + [Databases.MaxIdleTimeInSec](#databasesmaxidletimeinsec) + [Databases.OperationTimeoutInSec](#databasesoperationtimeoutinsec) + [Databases.PulseReadTransactionLimitInMb](#databasespulsereadtransactionlimitinmb) + [Databases.QueryOperationTimeoutInSec](#databasesqueryoperationtimeoutinsec) + [Databases.QueryTimeoutInSec](#databasesquerytimeoutinsec) + [Databases.RegularCleanupThresholdInMin](#databasesregularcleanupthresholdinmin) ## Databases.Compression.CompressAllCollectionsDefault @@ -64,7 +64,7 @@ The time (in seconds) that a database waits for a free loading slot before the load attempt times out. RavenDB limits the number of databases that load at the same time -(set by [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databasesmaxconcurrentloads)). +(set by [Databases.MaxConcurrentLoads](#databasesmaxconcurrentloads)). When this limit is reached, each additional database that needs to load waits for a slot to free up. This can happen when a burst of requests accesses many idle databases at once. @@ -95,7 +95,7 @@ The interval (in seconds) at which the system checks for idle databases. Specifies the maximum number of databases that can be loaded concurrently. If more databases need to load at the same time, each database waits for a free slot -for the period set by [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databasesconcurrentloadtimeoutinsec). +for the period set by [Databases.ConcurrentLoadTimeoutInSec](#databasesconcurrentloadtimeoutinsec). - **Type**: `int` - **Default**: `8` diff --git a/versioned_docs/version-7.1/server/configuration/etl-configuration.mdx b/versioned_docs/version-7.1/server/configuration/etl-configuration.mdx index cb80ca3fd1..191b412ae7 100644 --- a/versioned_docs/version-7.1/server/configuration/etl-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/etl-configuration.mdx @@ -17,17 +17,17 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [ETL.ExtractAndTransformTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlextractandtransformtimeoutinsec) - * [ETL.MaxBatchSizeInMb](../../server/configuration/etl-configuration.mdx#etlmaxbatchsizeinmb) - * [ETL.MaxFallbackTimeInSec](../../server/configuration/etl-configuration.mdx#etlmaxfallbacktimeinsec) - * [ETL.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteddocuments) - * [ETL.MaxNumberOfExtractedItems](../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteditems) - * [ETL.OLAP.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etlolapmaxnumberofextracteddocuments) - * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragetimetoliveinsec) - * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragevisibilitytimeoutinsec) - * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlqueuekafkainittransactionstimeoutinsec) - * [ETL.Raven.LoadRequestTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlravenloadrequesttimeoutinsec) - * [ETL.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) + * [ETL.ExtractAndTransformTimeoutInSec](#etlextractandtransformtimeoutinsec) + * [ETL.MaxBatchSizeInMb](#etlmaxbatchsizeinmb) + * [ETL.MaxFallbackTimeInSec](#etlmaxfallbacktimeinsec) + * [ETL.MaxNumberOfExtractedDocuments](#etlmaxnumberofextracteddocuments) + * [ETL.MaxNumberOfExtractedItems](#etlmaxnumberofextracteditems) + * [ETL.OLAP.MaxNumberOfExtractedDocuments](#etlolapmaxnumberofextracteddocuments) + * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](#etlqueueazurequeuestoragetimetoliveinsec) + * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](#etlqueueazurequeuestoragevisibilitytimeoutinsec) + * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](#etlqueuekafkainittransactionstimeoutinsec) + * [ETL.Raven.LoadRequestTimeoutInSec](#etlravenloadrequesttimeoutinsec) + * [ETL.SQL.CommandTimeoutInSec](#etlsqlcommandtimeoutinsec) diff --git a/versioned_docs/version-7.1/server/configuration/http-configuration.mdx b/versioned_docs/version-7.1/server/configuration/http-configuration.mdx index 5385bebfa5..6a7054660b 100644 --- a/versioned_docs/version-7.1/server/configuration/http-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/http-configuration.mdx @@ -19,28 +19,28 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can set Kestrel's properties via the following RavenDB configuration keys. * In this page: - * [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#httpmindataratebytespersec) - * [Http.MinDataRateGracePeriodInSec](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec) - * [Http.MaxRequestBufferSizeInKb](../../server/configuration/http-configuration.mdx#httpmaxrequestbuffersizeinkb) - * [Http.MaxRequestLineSizeInKb](../../server/configuration/http-configuration.mdx#httpmaxrequestlinesizeinkb) - * [Http.Http2.KeepAlivePingTimeoutInSec](../../server/configuration/http-configuration.mdx#httphttp2keepalivepingtimeoutinsec) - * [Http.Http2.KeepAlivePingDelayInSec](../../server/configuration/http-configuration.mdx#httphttp2keepalivepingdelayinsec) - * [Http.Http2.MaxStreamsPerConnection](../../server/configuration/http-configuration.mdx#httphttp2maxstreamsperconnection) - * [Http.UseResponseCompression](../../server/configuration/http-configuration.mdx#httpuseresponsecompression) - * [Http.AllowResponseCompressionOverHttps](../../server/configuration/http-configuration.mdx#httpallowresponsecompressionoverhttps) - * [Http.GzipResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpgzipresponsecompressionlevel) - * [Http.DeflateResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpdeflateresponsecompressionlevel) - * [Http.ZstdResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpzstdresponsecompressionlevel) - * [Http.StaticFilesResponseCompressionLevel](../../server/configuration/http-configuration.mdx#httpstaticfilesresponsecompressionlevel) - * [Http.Protocols](../../server/configuration/http-configuration.mdx#httpprotocols) - * [Http.AllowSynchronousIO](../../server/configuration/http-configuration.mdx#httpallowsynchronousio) + * [Http.MinDataRateBytesPerSec](#httpmindataratebytespersec) + * [Http.MinDataRateGracePeriodInSec](#httpmindatarategraceperiodinsec) + * [Http.MaxRequestBufferSizeInKb](#httpmaxrequestbuffersizeinkb) + * [Http.MaxRequestLineSizeInKb](#httpmaxrequestlinesizeinkb) + * [Http.Http2.KeepAlivePingTimeoutInSec](#httphttp2keepalivepingtimeoutinsec) + * [Http.Http2.KeepAlivePingDelayInSec](#httphttp2keepalivepingdelayinsec) + * [Http.Http2.MaxStreamsPerConnection](#httphttp2maxstreamsperconnection) + * [Http.UseResponseCompression](#httpuseresponsecompression) + * [Http.AllowResponseCompressionOverHttps](#httpallowresponsecompressionoverhttps) + * [Http.GzipResponseCompressionLevel](#httpgzipresponsecompressionlevel) + * [Http.DeflateResponseCompressionLevel](#httpdeflateresponsecompressionlevel) + * [Http.ZstdResponseCompressionLevel](#httpzstdresponsecompressionlevel) + * [Http.StaticFilesResponseCompressionLevel](#httpstaticfilesresponsecompressionlevel) + * [Http.Protocols](#httpprotocols) + * [Http.AllowSynchronousIO](#httpallowsynchronousio) ## Http.MinDataRateBytesPerSec * Set Kestrel's minimum required data rate in bytes per second. -* This option must be configured together with [Http.MinDataRateGracePeriod](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec). +* This option must be configured together with [Http.MinDataRateGracePeriod](#httpmindatarategraceperiodinsec). - **Type**: `int` - **Default**: `null` - **Scope**: Server-wide only @@ -53,7 +53,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Http.MinDataRateGracePeriodInSec * Set Kestrel's allowed request and response grace period in seconds. - This option must be configured together with [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#httpmindataratebytespersec) + This option must be configured together with [Http.MinDataRateBytesPerSec](#httpmindataratebytespersec) * Kestrel checks every second if data is coming in at the specified rate in bytes/second. If the rate drops below the minimum set by _MinResponseDataRate_, the connection is timed out. diff --git a/versioned_docs/version-7.1/server/configuration/indexing-configuration.mdx b/versioned_docs/version-7.1/server/configuration/indexing-configuration.mdx index 3ff0ff574f..1948246a5f 100644 --- a/versioned_docs/version-7.1/server/configuration/indexing-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/indexing-configuration.mdx @@ -25,90 +25,90 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Indexing.CleanupIntervalInMin](../../server/configuration/indexing-configuration.mdx#indexingcleanupintervalinmin) - [Indexing.Corax.VectorSearch.MaxNumberOfThreadsForLocalEmbeddingsGeneration](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchmaxnumberofthreadsforlocalembeddingsgeneration) - [Indexing.GlobalScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingglobalscratchspacelimitinmb) - [Indexing.MaxNumberOfConcurrentlyRunningIndexes](../../server/configuration/indexing-configuration.mdx#indexingmaxnumberofconcurrentlyrunningindexes) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) - [Indexing.NuGetAllowPreReleasePackages](../../server/configuration/indexing-configuration.mdx#indexingnugetallowprereleasepackages) - [Indexing.NuGetPackageSourceUrl](../../server/configuration/indexing-configuration.mdx#indexingnugetpackagesourceurl) - [Indexing.NuGetPackagesPath](../../server/configuration/indexing-configuration.mdx#indexingnugetpackagespath) - [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacheexpirationscanfrequencyinsec) - [Indexing.QueryClauseCache.RepeatedQueriesCount](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacherepeatedqueriescount) - [Indexing.QueryClauseCache.SizeInMb](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecachesizeinmb) + [Indexing.CleanupIntervalInMin](#indexingcleanupintervalinmin) + [Indexing.Corax.VectorSearch.MaxNumberOfThreadsForLocalEmbeddingsGeneration](#indexingcoraxvectorsearchmaxnumberofthreadsforlocalembeddingsgeneration) + [Indexing.GlobalScratchSpaceLimitInMb](#indexingglobalscratchspacelimitinmb) + [Indexing.MaxNumberOfConcurrentlyRunningIndexes](#indexingmaxnumberofconcurrentlyrunningindexes) + [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](#indexingmaxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) + [Indexing.NuGetAllowPreReleasePackages](#indexingnugetallowprereleasepackages) + [Indexing.NuGetPackageSourceUrl](#indexingnugetpackagesourceurl) + [Indexing.NuGetPackagesPath](#indexingnugetpackagespath) + [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](#indexingqueryclausecacheexpirationscanfrequencyinsec) + [Indexing.QueryClauseCache.RepeatedQueriesCount](#indexingqueryclausecacherepeatedqueriescount) + [Indexing.QueryClauseCache.SizeInMb](#indexingqueryclausecachesizeinmb) * Server-wide, or database scope: - [Indexing.Auto.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) - [Indexing.Auto.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexingautodeploymentmode) - [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) - [Indexing.Disable](../../server/configuration/indexing-configuration.mdx#indexingdisable) - [Indexing.DisableQueryOptimizerGeneratedIndexes](../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) - [Indexing.ErrorIndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexingerrorindexstartupbehavior) - [Indexing.History.NumberOfRevisions](../../server/configuration/indexing-configuration.mdx#indexinghistorynumberofrevisions) - [Indexing.IndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexingindexstartupbehavior) - [Indexing.ResetMode](../../server/configuration/indexing-configuration.mdx#indexingresetmode) - [Indexing.RunInMemory](../../server/configuration/indexing-configuration.mdx#indexingruninmemory) - [Indexing.SkipDatabaseIdValidationOnIndexOpening](../../server/configuration/indexing-configuration.mdx#indexingskipdatabaseidvalidationonindexopening) - [Indexing.Static.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) - [Indexing.Static.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexingstaticdeploymentmode) - [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) - [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath) - [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](../../server/configuration/indexing-configuration.mdx#indexingtimebeforedeletionofsupersededautoindexinsec) - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin) + [Indexing.Auto.ArchivedDataProcessingBehavior](#indexingautoarchiveddataprocessingbehavior) + [Indexing.Auto.DeploymentMode](#indexingautodeploymentmode) + [Indexing.Auto.SearchEngineType](#indexingautosearchenginetype) + [Indexing.Disable](#indexingdisable) + [Indexing.DisableQueryOptimizerGeneratedIndexes](#indexingdisablequeryoptimizergeneratedindexes) + [Indexing.ErrorIndexStartupBehavior](#indexingerrorindexstartupbehavior) + [Indexing.History.NumberOfRevisions](#indexinghistorynumberofrevisions) + [Indexing.IndexStartupBehavior](#indexingindexstartupbehavior) + [Indexing.ResetMode](#indexingresetmode) + [Indexing.RunInMemory](#indexingruninmemory) + [Indexing.SkipDatabaseIdValidationOnIndexOpening](#indexingskipdatabaseidvalidationonindexopening) + [Indexing.Static.ArchivedDataProcessingBehavior](#indexingstaticarchiveddataprocessingbehavior) + [Indexing.Static.DeploymentMode](#indexingstaticdeploymentmode) + [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](#indexingstaticrequireadmintodeployjavascriptindexes) + [Indexing.TempPath](#indexingtemppath) + [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](#indexingtimebeforedeletionofsupersededautoindexinsec) + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) + [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](#indexingtimetowaitbeforemarkingautoindexasidleinmin) * Server-wide, or database, or per index: - [Indexing.AllowStringCompilation](../../server/configuration/indexing-configuration.mdx#indexingallowstringcompilation) - [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) - [Indexing.Analyzers.Exact.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) - [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) - [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) - [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) - [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) - [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) - [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxmemoizationsizeinmb) - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) - [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxunmanagedallocationsbatchsizelimitinmb) - [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) - [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofedges) - [Indexing.Corax.VectorSearch.MaximumConcurrentBatchesForHnswAcceleration](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchmaximumconcurrentbatchesforhnswacceleration) - [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchorderbyscoreautomatically) - [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchvectorsearchscanningthreshold) - [Indexing.Encrypted.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb) - [Indexing.IndexEmptyEntries](../../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) - [Indexing.IndexMissingFieldsAsNull](../../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) - [Indexing.Lucene.Analyzers.NGram.MaxGram](../../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) - [Indexing.Lucene.Analyzers.NGram.MinGram](../../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) - [Indexing.Lucene.IndexInputType](../../server/configuration/indexing-configuration.mdx#indexingluceneindexinputtype) - [Indexing.Lucene.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglucenelargesegmentsizetomergeinmb) - [Indexing.Lucene.MaximumSizePerSegmentInMb](../../server/configuration/indexing-configuration.mdx#indexinglucenemaximumsizepersegmentinmb) - [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](../../server/configuration/indexing-configuration.mdx#indexinglucenemaxtimeformergestokeeprunninginsec) - [Indexing.Lucene.MergeFactor](../../server/configuration/indexing-configuration.mdx#indexinglucenemergefactor) - [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexinglucenenumberoflargesegmentstomergeinsinglebatch) - [Indexing.Lucene.ReaderTermsIndexDivisor](../../server/configuration/indexing-configuration.mdx#indexinglucenereadertermsindexdivisor) - [Indexing.Lucene.UseCompoundFileInMerging](../../server/configuration/indexing-configuration.mdx#indexingluceneusecompoundfileinmerging) - [Indexing.ManagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingmanagedallocationsbatchsizelimitinmb) - [Indexing.MapBatchSize](../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) - [Indexing.MapTimeoutAfterEtagReachedInMin](../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutafteretagreachedinmin) - [Indexing.MapTimeoutInSec](../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) - [Indexing.MaxStepsForScript](../../server/configuration/indexing-configuration.mdx#indexingmaxstepsforscript) - [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimefordocumenttransactiontoremainopeninsec) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](../../server/configuration/indexing-configuration.mdx#indexingmaxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) - [Indexing.Metrics.Enabled](../../server/configuration/indexing-configuration.mdx#indexingmetricsenabled) - [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexingminnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) - [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](../../server/configuration/indexing-configuration.mdx#indexingminimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) - [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexingnumberofconcurrentstoppedbatchesifrunninglowonmemory) - [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexingnumberoflargesegmentstomergeinsinglebatch) - [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](../../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) - [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](../../server/configuration/indexing-configuration.mdx#indexingorderbyticksautomaticallywhendatesareinvolved) - [Indexing.QueryClauseCache.Disabled](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecachedisabled) - [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](../../server/configuration/indexing-configuration.mdx#indexingqueryclausecacherepeatedqueriestimeframeinsec) - [Indexing.Querying.UseSearchAnalyzerForDynamicFieldsIfNotSetExplicitlyInSearchQuery](../../server/configuration/indexing-configuration.mdx#indexingqueryingusesearchanalyzerfordynamicfieldsifnotsetexplicitlyinsearchquery) - [Indexing.ScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingscratchspacelimitinmb) - [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) - [Indexing.Throttling.TimeIntervalInMs](../../server/configuration/indexing-configuration.mdx#indexingthrottlingtimeintervalinms) - [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](../../server/configuration/indexing-configuration.mdx#indexingtimesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) - [Indexing.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexingtransactionsizelimitinmb) + [Indexing.AllowStringCompilation](#indexingallowstringcompilation) + [Indexing.Analyzers.Default](#indexinganalyzersdefault) + [Indexing.Analyzers.Exact.Default](#indexinganalyzersexactdefault) + [Indexing.Analyzers.Search.Default](#indexinganalyzerssearchdefault) + [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](#indexingcoraxdocumentslimitforcompressiondictionarycreation) + [Indexing.Corax.IncludeDocumentScore](#indexingcoraxincludedocumentscore) + [Indexing.Corax.IncludeSpatialDistance](#indexingcoraxincludespatialdistance) + [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](#indexingcoraxmaxallocationsatdictionarytraininginmb) + [Indexing.Corax.MaxMemoizationSizeInMb](#indexingcoraxmaxmemoizationsizeinmb) + [Indexing.Corax.Static.ComplexFieldIndexingBehavior](#indexingcoraxstaticcomplexfieldindexingbehavior) + [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](#indexingcoraxunmanagedallocationsbatchsizelimitinmb) + [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](#indexingcoraxvectorsearchdefaultminimumsimilarity) + [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing) + [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) + [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](#indexingcoraxvectorsearchdefaultnumberofedges) + [Indexing.Corax.VectorSearch.MaximumConcurrentBatchesForHnswAcceleration](#indexingcoraxvectorsearchmaximumconcurrentbatchesforhnswacceleration) + [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](#indexingcoraxvectorsearchorderbyscoreautomatically) + [Indexing.Corax.VectorSearch.VectorSearchScanningThreshold](#indexingcoraxvectorsearchvectorsearchscanningthreshold) + [Indexing.Encrypted.TransactionSizeLimitInMb](#indexingencryptedtransactionsizelimitinmb) + [Indexing.IndexEmptyEntries](#indexingindexemptyentries) + [Indexing.IndexMissingFieldsAsNull](#indexingindexmissingfieldsasnull) + [Indexing.Lucene.Analyzers.NGram.MaxGram](#indexingluceneanalyzersngrammaxgram) + [Indexing.Lucene.Analyzers.NGram.MinGram](#indexingluceneanalyzersngrammingram) + [Indexing.Lucene.IndexInputType](#indexingluceneindexinputtype) + [Indexing.Lucene.LargeSegmentSizeToMergeInMb](#indexinglucenelargesegmentsizetomergeinmb) + [Indexing.Lucene.MaximumSizePerSegmentInMb](#indexinglucenemaximumsizepersegmentinmb) + [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](#indexinglucenemaxtimeformergestokeeprunninginsec) + [Indexing.Lucene.MergeFactor](#indexinglucenemergefactor) + [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](#indexinglucenenumberoflargesegmentstomergeinsinglebatch) + [Indexing.Lucene.ReaderTermsIndexDivisor](#indexinglucenereadertermsindexdivisor) + [Indexing.Lucene.UseCompoundFileInMerging](#indexingluceneusecompoundfileinmerging) + [Indexing.ManagedAllocationsBatchSizeLimitInMb](#indexingmanagedallocationsbatchsizelimitinmb) + [Indexing.MapBatchSize](#indexingmapbatchsize) + [Indexing.MapTimeoutAfterEtagReachedInMin](#indexingmaptimeoutafteretagreachedinmin) + [Indexing.MapTimeoutInSec](#indexingmaptimeoutinsec) + [Indexing.MaxStepsForScript](#indexingmaxstepsforscript) + [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](#indexingmaxtimefordocumenttransactiontoremainopeninsec) + [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](#indexingmaxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) + [Indexing.Metrics.Enabled](#indexingmetricsenabled) + [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](#indexingminnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) + [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](#indexingminimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) + [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](#indexingnumberofconcurrentstoppedbatchesifrunninglowonmemory) + [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](#indexingnumberoflargesegmentstomergeinsinglebatch) + [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](#indexingorderbyscoreautomaticallywhenboostingisinvolved) + [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](#indexingorderbyticksautomaticallywhendatesareinvolved) + [Indexing.QueryClauseCache.Disabled](#indexingqueryclausecachedisabled) + [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](#indexingqueryclausecacherepeatedqueriestimeframeinsec) + [Indexing.Querying.UseSearchAnalyzerForDynamicFieldsIfNotSetExplicitlyInSearchQuery](#indexingqueryingusesearchanalyzerfordynamicfieldsifnotsetexplicitlyinsearchquery) + [Indexing.ScratchSpaceLimitInMb](#indexingscratchspacelimitinmb) + [Indexing.Static.SearchEngineType](#indexingstaticsearchenginetype) + [Indexing.Throttling.TimeIntervalInMs](#indexingthrottlingtimeintervalinms) + [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](#indexingtimesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) + [Indexing.TransactionSizeLimitInMb](#indexingtransactionsizelimitinmb) ## Indexing.CleanupIntervalInMin @@ -746,7 +746,7 @@ EXPERT ONLY: * This configuration applies only to the Lucene indexing engine. * The definition of a large segment in MB. - We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexingnumberoflargesegmentstomergeinsinglebatch) in a single batch. + We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](#indexingnumberoflargesegmentstomergeinsinglebatch) in a single batch. * The default value, which is determined based on your platform details, is set by the constructor of class `IndexingConfiguration`. - **Type**: `int` @@ -809,7 +809,7 @@ EXPERT ONLY: * This configuration applies only to the Lucene indexing engine. -* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglargesegmentsizetomergeinmb) to merge in a single batch. +* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](#indexinglargesegmentsizetomergeinmb) to merge in a single batch. - **Type**: `int` - **Default**: `2` - **Scope**: Server-wide, or per database, or per index @@ -1016,11 +1016,11 @@ Queries that repeat within this time frame will be considered worth caching. * `false` (default): The [Default analyzer](../../indexes/using-analyzers.mdx#using-the-default-analyzer) is used to analyze the **query term**. - This analyzer can be configured via the [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. + This analyzer can be configured via the [Indexing.Analyzers.Default](#indexinganalyzersdefault) configuration key. * `true`: The [Default search analyzer](../../indexes/using-analyzers.mdx#using-the-default-search-analyzer) is used to analyze the **query term**. - This analyzer can be configured via the [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. + This analyzer can be configured via the [Indexing.Analyzers.Search.Default](#indexinganalyzerssearchdefault) configuration key. * See the table in [Which analyzer is used for the query term?](../../indexes/using-dynamic-fields.mdx#which-analyzer-is-used-for-the-query-term) for the complete analyzer-selection rules based on this configuration key and the analyzer configured for the dynamic index field. diff --git a/versioned_docs/version-7.1/server/configuration/license-configuration.mdx b/versioned_docs/version-7.1/server/configuration/license-configuration.mdx index 7dfaae1ac1..2bbca0e6a3 100644 --- a/versioned_docs/version-7.1/server/configuration/license-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/license-configuration.mdx @@ -116,8 +116,8 @@ EXPERT ONLY. Disable automatic updates of the license from the License Server (api.ravendb.net). Can still update the license by either: -* Setting the [License](../../server/configuration/license-configuration.mdx#license) configuration -* Setting the [License.Path](../../server/configuration/license-configuration.mdx#licensepath) configuration +* Setting the [License](#license) configuration +* Setting the [License.Path](#licensepath) configuration * Replacing the _license.json_ file on disk - **Type**: `bool` - **Default**: `false` diff --git a/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx b/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx index 71b68bb617..a2669fb000 100644 --- a/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx @@ -19,25 +19,25 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * RavenDB logging configuration keys: - [Logs.ArchiveAboveSizeInMb](../../server/configuration/logs-configuration.mdx#logsarchiveabovesizeinmb) - [Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logsconfigpath) - [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logsenablearchivefilecompression) - [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) - [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) - [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) - [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) - [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) - [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) - [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logsnugetallowprereleasepackages) - [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logsnugetpackagespath) - [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logsnugetpackagesourceurl) - [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) - [Logs.ThrowConfigExceptions](../../server/configuration/logs-configuration.mdx#logsthrowconfigexceptions) + [Logs.ArchiveAboveSizeInMb](#logsarchiveabovesizeinmb) + [Logs.ConfigPath](#logsconfigpath) + [Logs.EnableArchiveFileCompression](#logsenablearchivefilecompression) + [Logs.MaxArchiveDays](#logsmaxarchivedays) + [Logs.MaxArchiveFiles](#logsmaxarchivefiles) + [Logs.Microsoft.Enabled](#logsmicrosoftenabled) + [Logs.Microsoft.MinLevel](#logsmicrosoftminlevel) + [Logs.MinLevel](#logsminlevel) + [Logs.NuGet.AdditionalPackages](#logsnugetadditionalpackages) + [Logs.NuGet.AllowPreReleasePackages](#logsnugetallowprereleasepackages) + [Logs.NuGet.PackagesPath](#logsnugetpackagespath) + [Logs.NuGet.PackageSourceUrl](#logsnugetpackagesourceurl) + [Logs.Path](#logspath) + [Logs.ThrowConfigExceptions](#logsthrowconfigexceptions) * Internal NLog configuration keys: - [Logs.Internal.Level](../../server/configuration/logs-configuration.mdx#logsinternallevel) - [Logs.Internal.LogToStandardError](../../server/configuration/logs-configuration.mdx#logsinternallogtostandarderror) - [Logs.Internal.LogToStandardOutput](../../server/configuration/logs-configuration.mdx#logsinternallogtostandardoutput) - [Logs.Internal.Path](../../server/configuration/logs-configuration.mdx#logsinternalpath) + [Logs.Internal.Level](#logsinternallevel) + [Logs.Internal.LogToStandardError](#logsinternallogtostandarderror) + [Logs.Internal.LogToStandardOutput](#logsinternallogtostandardoutput) + [Logs.Internal.Path](#logsinternalpath) ## Logs.ArchiveAboveSizeInMb diff --git a/versioned_docs/version-7.1/server/configuration/memory-configuration.mdx b/versioned_docs/version-7.1/server/configuration/memory-configuration.mdx index bb73de1b8c..d6dfd55e97 100644 --- a/versioned_docs/version-7.1/server/configuration/memory-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/memory-configuration.mdx @@ -20,12 +20,12 @@ Use the configuration keys listed below to control how your RavenDB server manag Learn how to apply these keys in the [Configuration Overview](../../server/configuration/configuration-options.mdx) article. * On this page: - * [Configuration keys](../../server/configuration/memory-configuration.mdx#configuration-keys) - * [Memory.LowMemoryLimitInMb](../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) - * [Memory.LowMemoryCommitLimitInMb](../../server/configuration/memory-configuration.mdx#memorylowmemorycommitlimitinmb) - * [Memory.MinimumFreeCommittedMemoryPercentage](../../server/configuration/memory-configuration.mdx#memoryminimumfreecommittedmemorypercentage) - * [Memory.MaxFreeCommittedMemoryToKeepInMb](../../server/configuration/memory-configuration.mdx#memorymaxfreecommittedmemorytokeepinmb) - * [Memory.GC.LargeObjectHeapCompactionThresholdPercentage](../../server/configuration/memory-configuration.mdx#memorygclargeobjectheapcompactionthresholdpercentage) + * [Configuration keys](#configuration-keys) + * [Memory.LowMemoryLimitInMb](#memorylowmemorylimitinmb) + * [Memory.LowMemoryCommitLimitInMb](#memorylowmemorycommitlimitinmb) + * [Memory.MinimumFreeCommittedMemoryPercentage](#memoryminimumfreecommittedmemorypercentage) + * [Memory.MaxFreeCommittedMemoryToKeepInMb](#memorymaxfreecommittedmemorytokeepinmb) + * [Memory.GC.LargeObjectHeapCompactionThresholdPercentage](#memorygclargeobjectheapcompactionthresholdpercentage) diff --git a/versioned_docs/version-7.1/server/configuration/monitoring-configuration.mdx b/versioned_docs/version-7.1/server/configuration/monitoring-configuration.mdx index cbbc989ece..75ca1cc91c 100644 --- a/versioned_docs/version-7.1/server/configuration/monitoring-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/monitoring-configuration.mdx @@ -15,47 +15,47 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * OpenTelemetry monitoring: - [Monitoring.OpenTelemetry.ConsoleExporter](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryconsoleexporter) - [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) - [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersaspnetcoreenabled) - [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersruntimeenabled) - [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservercpucreditsenabled) - [Monitoring.OpenTelemetry.Meters.Server.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverenabled) - [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergcenabled) - [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergeneralenabled) - [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverrequestsenabled) - [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverresourcesenabled) - [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverstorageenabled) - [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservertotaldatabasesenabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolenabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolendpoint) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolexportprocessortype) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolheaders) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolprotocol) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) - [Monitoring.OpenTelemetry.ServiceInstanceId](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryserviceinstanceid) - [Monitoring.OpenTelemetry.ServiceName](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryservicename) - [Monitoring.OpenTelemetry.ServiceNamespace](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryservicenamespace) + [Monitoring.OpenTelemetry.ConsoleExporter](#monitoringopentelemetryconsoleexporter) + [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) + [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](#monitoringopentelemetrymetersaspnetcoreenabled) + [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](#monitoringopentelemetrymetersruntimeenabled) + [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](#monitoringopentelemetrymetersservercpucreditsenabled) + [Monitoring.OpenTelemetry.Meters.Server.Enabled](#monitoringopentelemetrymetersserverenabled) + [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](#monitoringopentelemetrymetersservergcenabled) + [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](#monitoringopentelemetrymetersservergeneralenabled) + [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](#monitoringopentelemetrymetersserverrequestsenabled) + [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](#monitoringopentelemetrymetersserverresourcesenabled) + [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](#monitoringopentelemetrymetersserverstorageenabled) + [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](#monitoringopentelemetrymetersservertotaldatabasesenabled) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](#monitoringopentelemetryopentelemetryprotocolenabled) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](#monitoringopentelemetryopentelemetryprotocolendpoint) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](#monitoringopentelemetryopentelemetryprotocolexportprocessortype) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](#monitoringopentelemetryopentelemetryprotocolheaders) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](#monitoringopentelemetryopentelemetryprotocolprotocol) + [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](#monitoringopentelemetryopentelemetryprotocoltimeout) + [Monitoring.OpenTelemetry.ServiceInstanceId](#monitoringopentelemetryserviceinstanceid) + [Monitoring.OpenTelemetry.ServiceName](#monitoringopentelemetryservicename) + [Monitoring.OpenTelemetry.ServiceNamespace](#monitoringopentelemetryservicenamespace) * SNMP monitoring - [Monitoring.Snmp.AuthenticationPassword](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpassword) - [Monitoring.Snmp.AuthenticationPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpasswordsecondary) - [Monitoring.Snmp.AuthenticationProtocol](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocol) - [Monitoring.Snmp.AuthenticationProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocolsecondary) - [Monitoring.Snmp.AuthenticationUser](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationuser) - [Monitoring.Snmp.AuthenticationUser.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationusersecondary) - [Monitoring.Snmp.Community](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) - [Monitoring.Snmp.DisableTimeWindowChecks](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpdisabletimewindowchecks) - [Monitoring.Snmp.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpenabled) - [Monitoring.Snmp.Port](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpport) - [Monitoring.Snmp.PrivacyPassword](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypassword) - [Monitoring.Snmp.PrivacyPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypasswordsecondary) - [Monitoring.Snmp.PrivacyProtocol](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocol) - [Monitoring.Snmp.PrivacyProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocolsecondary) - [Monitoring.Snmp.SupportedVersions](../../server/configuration/monitoring-configuration.mdx#monitoringsnmpsupportedversions) + [Monitoring.Snmp.AuthenticationPassword](#monitoringsnmpauthenticationpassword) + [Monitoring.Snmp.AuthenticationPassword.Secondary](#monitoringsnmpauthenticationpasswordsecondary) + [Monitoring.Snmp.AuthenticationProtocol](#monitoringsnmpauthenticationprotocol) + [Monitoring.Snmp.AuthenticationProtocol.Secondary](#monitoringsnmpauthenticationprotocolsecondary) + [Monitoring.Snmp.AuthenticationUser](#monitoringsnmpauthenticationuser) + [Monitoring.Snmp.AuthenticationUser.Secondary](#monitoringsnmpauthenticationusersecondary) + [Monitoring.Snmp.Community](#monitoringsnmpcommunity) + [Monitoring.Snmp.DisableTimeWindowChecks](#monitoringsnmpdisabletimewindowchecks) + [Monitoring.Snmp.Enabled](#monitoringsnmpenabled) + [Monitoring.Snmp.Port](#monitoringsnmpport) + [Monitoring.Snmp.PrivacyPassword](#monitoringsnmpprivacypassword) + [Monitoring.Snmp.PrivacyPassword.Secondary](#monitoringsnmpprivacypasswordsecondary) + [Monitoring.Snmp.PrivacyProtocol](#monitoringsnmpprivacyprotocol) + [Monitoring.Snmp.PrivacyProtocol.Secondary](#monitoringsnmpprivacyprotocolsecondary) + [Monitoring.Snmp.SupportedVersions](#monitoringsnmpsupportedversions) * Other monitoring: - [Monitoring.Cpu.Exec](../../server/configuration/monitoring-configuration.mdx#monitoringcpuexec) - [Monitoring.Cpu.Exec.Arguments](../../server/configuration/monitoring-configuration.mdx#monitoringcpuexecarguments) - [Monitoring.Disk.ReadStatsDebounceTimeInMs](../../server/configuration/monitoring-configuration.mdx#monitoringdiskreadstatsdebouncetimeinms) + [Monitoring.Cpu.Exec](#monitoringcpuexec) + [Monitoring.Cpu.Exec.Arguments](#monitoringcpuexecarguments) + [Monitoring.Disk.ReadStatsDebounceTimeInMs](#monitoringdiskreadstatsdebouncetimeinms) @@ -257,7 +257,7 @@ OpenTelemetryProtocol timeout value. * Sets the OpenTelemetry **service name**. This value is reported as the `service.name` resource attribute and is used to identify the RavenDB service in observability tools, such as the .NET Aspire dashboard. -* If [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) is set to `true`, +* If [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) is set to `true`, the effective value must not be `null`, empty, or whitespace. Otherwise, the server will fail to start. @@ -274,7 +274,7 @@ OpenTelemetryProtocol timeout value. * Sets the OpenTelemetry **service namespace**. This value is reported as the `service.namespace` resource attribute and is used to group related services together in observability tools. -* If [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) is set to `true`, +* If [Monitoring.OpenTelemetry.Enabled](#monitoringopentelemetryenabled) is set to `true`, the effective value must not be `null`, empty, or whitespace. Otherwise, the server will fail to start. diff --git a/versioned_docs/version-7.1/server/configuration/patching-configuration.mdx b/versioned_docs/version-7.1/server/configuration/patching-configuration.mdx index 081e55e895..613dc8b1b1 100644 --- a/versioned_docs/version-7.1/server/configuration/patching-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/patching-configuration.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Set-base patch operations](../../client-api/operations/patching/set-based.mdx) * [Apply patching from the Studio](../../studio/database/documents/patch-view.mdx) * In this article: - * [Patching.AllowStringCompilation](../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) - * [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) - * [Patching.StrictMode](../../server/configuration/patching-configuration.mdx#patchingstrictmode) + * [Patching.AllowStringCompilation](#patchingallowstringcompilation) + * [Patching.MaxStepsForScript](#patchingmaxstepsforscript) + * [Patching.StrictMode](#patchingstrictmode) ## Patching.AllowStringCompilation diff --git a/versioned_docs/version-7.1/server/configuration/performance-hints-configuration.mdx b/versioned_docs/version-7.1/server/configuration/performance-hints-configuration.mdx index d0135f6555..e4f488f395 100644 --- a/versioned_docs/version-7.1/server/configuration/performance-hints-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/performance-hints-configuration.mdx @@ -15,15 +15,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [PerformanceHints.Documents.HugeDocumentsCollectionSize](../../server/configuration/performance-hints-configuration.mdx#performancehintsdocumentshugedocumentscollectionsize) - * [PerformanceHints.Documents.HugeDocumentSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehintsdocumentshugedocumentsizeinmb) - * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingalertwhensourcedocumentincludedinoutput) - * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxdepthofrecursioninlinqselect) - * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) - * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](../../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxnumberofloadsperreference) - * [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) - * [PerformanceHints.Memory.MinSwapSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehintsmemoryminswapsizeinmb) - * [PerformanceHints.TooLongRequestThresholdInSec](../../server/configuration/performance-hints-configuration.mdx#performancehintstoolongrequestthresholdinsec) + * [PerformanceHints.Documents.HugeDocumentsCollectionSize](#performancehintsdocumentshugedocumentscollectionsize) + * [PerformanceHints.Documents.HugeDocumentSizeInMb](#performancehintsdocumentshugedocumentsizeinmb) + * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](#performancehintsindexingalertwhensourcedocumentincludedinoutput) + * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](#performancehintsindexingmaxdepthofrecursioninlinqselect) + * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](#performancehintsindexingmaxindexoutputsperdocument) + * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](#performancehintsindexingmaxnumberofloadsperreference) + * [PerformanceHints.MaxNumberOfResults](#performancehintsmaxnumberofresults) + * [PerformanceHints.Memory.MinSwapSizeInMb](#performancehintsmemoryminswapsizeinmb) + * [PerformanceHints.TooLongRequestThresholdInSec](#performancehintstoolongrequestthresholdinsec) ## PerformanceHints.Documents.HugeDocumentsCollectionSize diff --git a/versioned_docs/version-7.1/server/configuration/security-configuration.mdx b/versioned_docs/version-7.1/server/configuration/security-configuration.mdx index 5536dbb5e9..3464bd5435 100644 --- a/versioned_docs/version-7.1/server/configuration/security-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/security-configuration.mdx @@ -19,50 +19,50 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Security.AuditLog: - [Security.AuditLog.EnableArchiveFileCompression](../../server/configuration/security-configuration.mdx#securityauditlogenablearchivefilecompression) - [Security.AuditLog.FolderPath](../../server/configuration/security-configuration.mdx#securityauditlogfolderpath) - [Security.AuditLog.ArchiveAboveSizeInMb](../../server/configuration/security-configuration.mdx#securityauditlogarchiveabovesizeinmb) - [Security.AuditLog.MaxArchiveDays](../../server/configuration/security-configuration.mdx#securityauditlogmaxarchivedays) + [Security.AuditLog.EnableArchiveFileCompression](#securityauditlogenablearchivefilecompression) + [Security.AuditLog.FolderPath](#securityauditlogfolderpath) + [Security.AuditLog.ArchiveAboveSizeInMb](#securityauditlogarchiveabovesizeinmb) + [Security.AuditLog.MaxArchiveDays](#securityauditlogmaxarchivedays) * Security.Certificate: - [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) - [Security.Certificate.Change.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificatechangeexecarguments) - [Security.Certificate.Exec](../../server/configuration/security-configuration.mdx#securitycertificateexec) - [Security.Certificate.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitycertificateexectimeoutinsec) - [Security.Certificate.ExpiringThresholdInDays](../../server/configuration/security-configuration.mdx#securitycertificateexpiringthresholdindays) - [Security.Certificate.LetsEncrypt.Email](../../server/configuration/security-configuration.mdx#securitycertificateletsencryptemail) - [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) - [Security.Certificate.Load.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificateloadexecarguments) - [Security.Certificate.Password](../../server/configuration/security-configuration.mdx#securitycertificatepassword) - [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) - [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) - [Security.Certificate.Renew.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) - [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexec) - [Security.Certificate.Validation.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) - [Security.Certificate.Validation.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexectimeoutinsec) - [Security.Certificate.Validation.KeyUsages](../../server/configuration/security-configuration.mdx#securitycertificatevalidationkeyusages) + [Security.Certificate.Change.Exec](#securitycertificatechangeexec) + [Security.Certificate.Change.Exec.Arguments](#securitycertificatechangeexecarguments) + [Security.Certificate.Exec](#securitycertificateexec) + [Security.Certificate.Exec.TimeoutInSec](#securitycertificateexectimeoutinsec) + [Security.Certificate.ExpiringThresholdInDays](#securitycertificateexpiringthresholdindays) + [Security.Certificate.LetsEncrypt.Email](#securitycertificateletsencryptemail) + [Security.Certificate.Load.Exec](#securitycertificateloadexec) + [Security.Certificate.Load.Exec.Arguments](#securitycertificateloadexecarguments) + [Security.Certificate.Password](#securitycertificatepassword) + [Security.Certificate.Path](#securitycertificatepath) + [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) + [Security.Certificate.Renew.Exec.Arguments](#securitycertificaterenewexecarguments) + [Security.Certificate.Validation.Exec](#securitycertificatevalidationexec) + [Security.Certificate.Validation.Exec.Arguments](#securitycertificatevalidationexecarguments) + [Security.Certificate.Validation.Exec.TimeoutInSec](#securitycertificatevalidationexectimeoutinsec) + [Security.Certificate.Validation.KeyUsages](#securitycertificatevalidationkeyusages) * Security.Csrf: - [Security.Csrf.AdditionalOriginHeaders](../../server/configuration/security-configuration.mdx#securitycsrfadditionaloriginheaders) - [Security.Csrf.Enabled](../../server/configuration/security-configuration.mdx#securitycsrfenabled) - [Security.Csrf.TrustedOrigins](../../server/configuration/security-configuration.mdx#securitycsrftrustedorigins) + [Security.Csrf.AdditionalOriginHeaders](#securitycsrfadditionaloriginheaders) + [Security.Csrf.Enabled](#securitycsrfenabled) + [Security.Csrf.TrustedOrigins](#securitycsrftrustedorigins) * Security.MasterKey: - [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) - [Security.MasterKey.Exec.Arguments](../../server/configuration/security-configuration.mdx#securitymasterkeyexecarguments) - [Security.MasterKey.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#securitymasterkeyexectimeoutinsec) - [Security.MasterKey.Path](../../server/configuration/security-configuration.mdx#securitymasterkeypath) + [Security.MasterKey.Exec](#securitymasterkeyexec) + [Security.MasterKey.Exec.Arguments](#securitymasterkeyexecarguments) + [Security.MasterKey.Exec.TimeoutInSec](#securitymasterkeyexectimeoutinsec) + [Security.MasterKey.Path](#securitymasterkeypath) * Security.TwoFactor: - [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactordefaultsessiondurationinmin) - [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactormaxsessiondurationinmin) + [Security.TwoFactor.DefaultSessionDurationInMin](#securitytwofactordefaultsessiondurationinmin) + [Security.TwoFactor.MaxSessionDurationInMin](#securitytwofactormaxsessiondurationinmin) * Certificate and issuer validation: - [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) - [Security.WellKnownIssuerHashes.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuerhashesadmin) - [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) - [Security.WellKnownIssuers.Admin.ValidateCertificateNames](../../server/configuration/security-configuration.mdx#securitywellknownissuersadminvalidatecertificatenames) + [Security.WellKnownCertificates.Admin](#securitywellknowncertificatesadmin) + [Security.WellKnownIssuerHashes.Admin](#securitywellknownissuerhashesadmin) + [Security.WellKnownIssuers.Admin](#securitywellknownissuersadmin) + [Security.WellKnownIssuers.Admin.ValidateCertificateNames](#securitywellknownissuersadminvalidatecertificatenames) * Other: - [Security.DisableHsts](../../server/configuration/security-configuration.mdx#securitydisablehsts) - [Security.DisableHttpsRedirection](../../server/configuration/security-configuration.mdx#securitydisablehttpsredirection) - [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror) - [Security.TlsCipherSuites](../../server/configuration/security-configuration.mdx#securitytlsciphersuites) - [Security.UnsecuredAccessAllowed](../../server/configuration/security-configuration.mdx#securityunsecuredaccessallowed) + [Security.DisableHsts](#securitydisablehsts) + [Security.DisableHttpsRedirection](#securitydisablehttpsredirection) + [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](#securitydonotconsidermemorylockfailureascatastrophicerror) + [Security.TlsCipherSuites](#securitytlsciphersuites) + [Security.UnsecuredAccessAllowed](#securityunsecuredaccessallowed) ## Security.AuditLog.EnableArchiveFileCompression @@ -127,7 +127,7 @@ or set it to `null` to refrain from removing audit log files. A command or executable that handles cluster certificate changes. This executable allows you to implement your own custom logic for persisting the new certificate on all nodes. -Note: it will only be triggered if [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) is not defined. +Note: it will only be triggered if [Security.Certificate.Path](#securitycertificatepath) is not defined. - **Type**: `string` - **Default**: `null` @@ -137,7 +137,7 @@ Note: it will only be triggered if [Security.Certificate.Path](../../server/conf ## Security.Certificate.Change.Exec.Arguments -The command line arguments for the [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) command or executable. +The command line arguments for the [Security.Certificate.Change.Exec](#securitycertificatechangeexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -148,9 +148,9 @@ The command line arguments for the [Security.Certificate.Change.Exec](../../serv ## Security.Certificate.Exec Deprecated. -Use [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) -along with [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) -and [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) instead. +Use [Security.Certificate.Load.Exec](#securitycertificateloadexec) +along with [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) +and [Security.Certificate.Change.Exec](#securitycertificatechangeexec) instead. @@ -158,9 +158,9 @@ and [Security.Certificate.Change.Exec](../../server/configuration/security-confi * The number of seconds to wait for the certificate executables to exit. * Applies to: - * [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) - * [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) - * [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) + * [Security.Certificate.Load.Exec](#securitycertificateloadexec) + * [Security.Certificate.Renew.Exec](#securitycertificaterenewexec) + * [Security.Certificate.Change.Exec](#securitycertificatechangeexec) - **Type**: `int` - **Default**: `30` - **Scope**: Server-wide only @@ -193,7 +193,7 @@ Used for renewal requests. * A command or executable that provides the `.pfx` cluster certificate when invoked by RavenDB. If specified, RavenDB will use HTTPS/SSL for all network activities. -* The [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) setting takes precedence over this executable. +* The [Security.Certificate.Path](#securitycertificatepath) setting takes precedence over this executable. * Learn more in [get certificate via loader](../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage). - **Type**: `string` @@ -204,7 +204,7 @@ Used for renewal requests. ## Security.Certificate.Load.Exec.Arguments -The command line arguments for the [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) command or executable. +The command line arguments for the [Security.Certificate.Load.Exec](#securitycertificateloadexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -242,7 +242,7 @@ Certificate setting priority order: * The [leader node](../../server/clustering/rachis/cluster-topology.mdx#leader) will invoke this executable once every hour, and if a new certificate is received, it will be sent to all other nodes. -* The executable specified in [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) +* The executable specified in [Security.Certificate.Change.Exec](#securitycertificatechangeexec) will then be used to persist the certificate across the cluster on all nodes. - **Type**: `string` - **Default**: `null` @@ -252,7 +252,7 @@ Certificate setting priority order: ## Security.Certificate.Renew.Exec.Arguments -The command line arguments for the [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) command or executable. +The command line arguments for the [Security.Certificate.Renew.Exec](#securitycertificaterenewexecarguments) command or executable. - **Type**: `string` - **Default**: `null` @@ -279,7 +279,7 @@ The executable will return a case-insensitive boolean string through the standar EXPERT ONLY: -The optional user arguments for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) command or executable. +The optional user arguments for the [Security.Certificate.Validation.Exec](#securitycertificatevalidationexecarguments) command or executable. The arguments must be escaped for the command line. - **Type**: `string` @@ -290,7 +290,7 @@ The arguments must be escaped for the command line. ## Security.Certificate.Validation.Exec.TimeoutInSec -The number of seconds to wait for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) executable to exit. +The number of seconds to wait for the [Security.Certificate.Validation.Exec](#securitycertificatevalidationexecarguments) executable to exit. - **Type**: `int` - **Default**: `5` @@ -355,7 +355,7 @@ If specified, RavenDB will use this key to protect secrets. ## Security.MasterKey.Exec.Arguments -The command line arguments for the [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) command or executable. +The command line arguments for the [Security.MasterKey.Exec](#securitymasterkeyexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -422,7 +422,7 @@ Specify well-known certificate thumbprints that will be trusted by the server as OBSOLETE. This is no longer supported or used. -Use [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) instead. +Use [Security.WellKnownIssuers.Admin](#securitywellknownissuersadmin) instead. diff --git a/versioned_docs/version-7.1/server/configuration/server-configuration.mdx b/versioned_docs/version-7.1/server/configuration/server-configuration.mdx index 4a5764017a..5175a507c1 100644 --- a/versioned_docs/version-7.1/server/configuration/server-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/server-configuration.mdx @@ -17,12 +17,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Various configuration options for the server's behavior. * In this page: - * [Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec](../../server/configuration/server-configuration.mdx#servermaxtimefortasktowaitfordatabasetoloadinsec) - * [Server.ProcessAffinityMask](../../server/configuration/server-configuration.mdx#serverprocessaffinitymask) - * [Server.IndexingAffinityMask](../../server/configuration/server-configuration.mdx#serverindexingaffinitymask) - * [Server.NumberOfUnusedCoresByIndexes](../../server/configuration/server-configuration.mdx#servernumberofunusedcoresbyindexes) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../../server/configuration/server-configuration.mdx#servercpucreditsexhaustionbackupdelayinmin) - * [Server.Tcp.Compression.Disable](../../server/configuration/server-configuration.mdx#servertcpcompressiondisable) + * [Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec](#servermaxtimefortasktowaitfordatabasetoloadinsec) + * [Server.ProcessAffinityMask](#serverprocessaffinitymask) + * [Server.IndexingAffinityMask](#serverindexingaffinitymask) + * [Server.NumberOfUnusedCoresByIndexes](#servernumberofunusedcoresbyindexes) + * [Server.CpuCredits.ExhaustionBackupDelayInMin](#servercpucreditsexhaustionbackupdelayinmin) + * [Server.Tcp.Compression.Disable](#servertcpcompressiondisable) ## Server.MaxTimeForTaskToWaitForDatabaseToLoadInSec diff --git a/versioned_docs/version-7.1/server/configuration/subscription-configuration.mdx b/versioned_docs/version-7.1/server/configuration/subscription-configuration.mdx index ad34d3c879..e6f3f9c33a 100644 --- a/versioned_docs/version-7.1/server/configuration/subscription-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/subscription-configuration.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more about subscriptions in [Data subscriptions](../../client-api/data-subscriptions/what-are-data-subscriptions.mdx). * In this article: - * [Subscriptions.ArchivedDataProcessingBehavior](../../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) - * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptionsmaxnumberofconcurrentconnections) + * [Subscriptions.ArchivedDataProcessingBehavior](#subscriptionsarchiveddataprocessingbehavior) + * [Subscriptions.MaxNumberOfConcurrentConnections](#subscriptionsmaxnumberofconcurrentconnections) diff --git a/versioned_docs/version-7.1/server/content/_embedded-csharp.mdx b/versioned_docs/version-7.1/server/content/_embedded-csharp.mdx index 6613c7a0e4..9c02d1a8ab 100644 --- a/versioned_docs/version-7.1/server/content/_embedded-csharp.mdx +++ b/versioned_docs/version-7.1/server/content/_embedded-csharp.mdx @@ -9,22 +9,22 @@ import CodeBlock from '@theme/CodeBlock'; * In this page: - * [Overview](../../server/embedded.mdx#overview) - * [Prerequisites and Recommendations](../../server/embedded.mdx#prerequisites-and-recommendations) - * [Installation](../../server/embedded.mdx#installation) - * [Starting the server](../../server/embedded.mdx#starting-the-server) - * [Server options](../../server/embedded.mdx#server-options) - * [Setting server directory](../../server/embedded.mdx#setting-server-directory) - * [Restarting the server](../../server/embedded.mdx#restarting-the-server) - * [ServerProcessExited Event](../../server/embedded.mdx#serverprocessexited-event) - * [Embedded server licensing](../../server/embedded.mdx#embedded-server-licensing) - * [Licensing configuration options](../../server/embedded.mdx#licensing-configuration-options) - * [License an embedded server using an Environment variable](../../server/embedded.mdx#license-an-embedded-server-using-an-environment-variable) - * [`.NET` FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) - * [Security](../../server/embedded.mdx#security) - * [Document store](../../server/embedded.mdx#document-store) - * [Get server URL and process ID](../../server/embedded.mdx#get-server-url-and-process-id) - * [Remarks](../../server/embedded.mdx#remarks) + * [Overview](#overview) + * [Prerequisites and Recommendations](#prerequisites-and-recommendations) + * [Installation](#installation) + * [Starting the server](#starting-the-server) + * [Server options](#server-options) + * [Setting server directory](#setting-server-directory) + * [Restarting the server](#restarting-the-server) + * [ServerProcessExited Event](#serverprocessexited-event) + * [Embedded server licensing](#embedded-server-licensing) + * [Licensing configuration options](#licensing-configuration-options) + * [License an embedded server using an Environment variable](#license-an-embedded-server-using-an-environment-variable) + * [`.NET` FrameworkVersion](#net-frameworkversion) + * [Security](#security) + * [Document store](#document-store) + * [Get server URL and process ID](#get-server-url-and-process-id) + * [Remarks](#remarks) ## Overview @@ -67,14 +67,14 @@ using (var store = await EmbeddedServer.Instance.GetDocumentStoreAsync("Embedded * **Prerequisites** * Install [`.NET` Core runtime](https://dotnet.microsoft.com/en-us/download), - either manually or [along with a RavenDB full version](../embedded.mdx#setting-server-directory). - * Verify that the RavenDB server [FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) + either manually or [along with a RavenDB full version](#setting-server-directory). + * Verify that the RavenDB server [FrameworkVersion](#net-frameworkversion) definition matches the `.NET` Core version that you install. * **Recommendations** * Projects targeting `.NET Framework 4.6.1+` that use the old `packages.config` for NuGet packages maintenance, should migrate to `PackageReference` package management. - Find additional details [below](../../server/embedded.mdx#migrating-from--to--in-old-csproj-projects). + Find additional details [below](#migrating-from--to--in-old-csproj-projects). ### `.NET` Core Runtime: RavenDB Embedded **does not include** the `.NET` Core runtime engine required for its operation. @@ -175,7 +175,7 @@ and additional options. | **ServerUrl** | `string` | What address we want to start our server (default `127.0.0.1:0`) | | **MaxServerStartupTimeDuration** | `TimeSpan` | The timeout for the server to start | | **CommandLineArgs** | `List` | The [command lines arguments](../../server/configuration/configuration-options.mdx#command-line-arguments) to start the server with | -| **ServerDirectory** | `string` | The path to the server binary files<sup>[*](../../server/embedded.mdx#setting-server-directory) | +| **ServerDirectory** | `string` | The path to the server binary files<sup>[*](#setting-server-directory) | diff --git a/versioned_docs/version-7.1/server/extensions/content/_expiration-csharp.mdx b/versioned_docs/version-7.1/server/extensions/content/_expiration-csharp.mdx index 2652a382ec..a34339b38d 100644 --- a/versioned_docs/version-7.1/server/extensions/content/_expiration-csharp.mdx +++ b/versioned_docs/version-7.1/server/extensions/content/_expiration-csharp.mdx @@ -10,11 +10,11 @@ import CodeBlock from '@theme/CodeBlock'; * You can enable or disable the expiration feature while the database is already live with data. * In this page: - * [Expiration feature usages](../../../server/extensions/expiration.mdx#expiration-feature-usages) - * [Configuring the expiration feature](../../../server/extensions/expiration.mdx#configuring-the-expiration-feature) - * [Configure expiration settings using the client API](../../../server/extensions/expiration.mdx#configure-expiration-settings-using-the-client-api) - * [Setting the document expiration time](../../../server/extensions/expiration.mdx#setting-the-document-expiration-time) - * [Eventual consistency considerations](../../../server/extensions/expiration.mdx#eventual-consistency-considerations) + * [Expiration feature usages](#expiration-feature-usages) + * [Configuring the expiration feature](#configuring-the-expiration-feature) + * [Configure expiration settings using the client API](#configure-expiration-settings-using-the-client-api) + * [Setting the document expiration time](#setting-the-document-expiration-time) + * [Eventual consistency considerations](#eventual-consistency-considerations) ## Expiration feature usages @@ -101,7 +101,7 @@ object and sending it to RavenDB using a `ConfigureExpirationOperation` operatio * If and when the expiration feature is enabled, it will process all documents carrying the `@expires` flag and automatically delete each document - [by its expiration time](../../../server/extensions/expiration.mdx#eventual-consistency-considerations). + [by its expiration time](#eventual-consistency-considerations). * To set the document expiration time from the client, use the following code: diff --git a/versioned_docs/version-7.1/server/extensions/content/_refresh-csharp.mdx b/versioned_docs/version-7.1/server/extensions/content/_refresh-csharp.mdx index 7b5e51c496..84dda44c34 100644 --- a/versioned_docs/version-7.1/server/extensions/content/_refresh-csharp.mdx +++ b/versioned_docs/version-7.1/server/extensions/content/_refresh-csharp.mdx @@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock'; * Refresh is scheduled using the `@refresh` flag in a document's [metadata](../../../client-api/session/how-to/get-and-modify-entity-metadata.mdx). * In this page: - * [Overview](../../../server/extensions/refresh.mdx#overview) - * [Examples](../../../server/extensions/refresh.mdx#examples) - * [Syntax](../../../server/extensions/refresh.mdx#syntax) - * [Configure from Studio](../../../server/extensions/refresh.mdx#configure-from-studio) + * [Overview](#overview) + * [Examples](#examples) + * [Syntax](#syntax) + * [Configure from Studio](#configure-from-studio) @@ -35,7 +35,7 @@ import CodeBlock from '@theme/CodeBlock'; 1. The refresh time value set for the `@refresh` property. - 2. The way you set the [Refresh Configuration](../../../server/extensions/refresh.mdx#syntax), + 2. The way you set the [Refresh Configuration](#syntax), including - - The interval by which the server refreshes documents (set by default to 60 seconds). - The way you set **maximal items to process**, potentially limiting the number diff --git a/versioned_docs/version-7.1/server/kb/content/_document-identifier-generation-csharp.mdx b/versioned_docs/version-7.1/server/kb/content/_document-identifier-generation-csharp.mdx index ede36ea509..d938fda326 100644 --- a/versioned_docs/version-7.1/server/kb/content/_document-identifier-generation-csharp.mdx +++ b/versioned_docs/version-7.1/server/kb/content/_document-identifier-generation-csharp.mdx @@ -15,18 +15,18 @@ import Panel from '@site/src/components/Panel'; To create a document from the Studio, see [Create new document](../../../studio/database/documents/create-new-document.mdx#create-new-document). * In this article: - * [Overview](../../../server/kb/document-identifier-generation.mdx#overview) - * [ID types](../../../server/kb/document-identifier-generation.mdx#id-types) - * [ID structure](../../../server/kb/document-identifier-generation.mdx#id-structure) - * [ID limitations](../../../server/kb/document-identifier-generation.mdx#id-limitations) - * [Document IDs:](../../../server/kb/document-identifier-generation.mdx#document-ids) - * [Semantic ID](../../../server/kb/document-identifier-generation.mdx#semantic-id) - * [GUID](../../../server/kb/document-identifier-generation.mdx#guid) - * [Server-side ID](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * [Identity ID](../../../server/kb/document-identifier-generation.mdx#identity-id) - * [HiLo algorithm ID](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) - * [Artificial document ID](../../../server/kb/document-identifier-generation.mdx#artificial-document-id) - * [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character) + * [Overview](#overview) + * [ID types](#id-types) + * [ID structure](#id-structure) + * [ID limitations](#id-limitations) + * [Document IDs:](#document-ids) + * [Semantic ID](#semantic-id) + * [GUID](#guid) + * [Server-side ID](#server-side-id) + * [Identity ID](#identity-id) + * [HiLo algorithm ID](#hilo-algorithm-id) + * [Artificial document ID](#artificial-document-id) + * [Customizing the separator character](#customizing-the-separator-character) @@ -39,22 +39,22 @@ RavenDB supports several document ID types, where the ID string can be generated * **Defined by the user**: You explicitly specify the document ID. - * [Semantic ID](../../../server/kb/document-identifier-generation.mdx#semantic-id) + * [Semantic ID](#semantic-id) * **Generated by the server**: The server generates the document ID based on the ID string format you provide when creating the document. - * [GUID](../../../server/kb/document-identifier-generation.mdx#guid) - * [Server-side ID](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * [Identity ID](../../../server/kb/document-identifier-generation.mdx#identity-id) + * [GUID](#guid) + * [Server-side ID](#server-side-id) + * [Identity ID](#identity-id) * **Generated by the client (from a range provided by the server)**: The server assigns a range of IDs to the client upon request. The client then uses that range to generate document IDs locally within the session. - * [HiLo algorithm ID](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) + * [HiLo algorithm ID](#hilo-algorithm-id) * **Generated from a Map-Reduce index output**: The ID is generated by the server when saving map-reduce results as artificial documents. - * [Artificial document ID](../../../server/kb/document-identifier-generation.mdx#artificial-document-id) + * [Artificial document ID](#artificial-document-id) @@ -67,9 +67,9 @@ For example: `users/123-A` (HiLo ID), or `users/000000000001-A` (Server-side ID) This structure is common but not mandatory: * RavenDB does not require the ID to include a collection prefix. - * The default slash separator (`/`) can be **customized** for [HiLo IDs](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id) - and [Identity IDs](../../../server/kb/document-identifier-generation.mdx#identity-id). - See [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character) below. + * The default slash separator (`/`) can be **customized** for [HiLo IDs](#hilo-algorithm-id) + and [Identity IDs](#identity-id). + See [Customizing the separator character](#customizing-the-separator-character) below. @@ -80,8 +80,8 @@ The following limitations apply to document IDs: * Maximum length: `512` bytes (in UTF-8) * Document IDs cannot end with the following reserved characters: - * `/` - reserved for [Server-side ID generation](../../../server/kb/document-identifier-generation.mdx#server-side-id) - * `|` - reserved for [Identity ID generation](../../../server/kb/document-identifier-generation.mdx#identity-id) + * `/` - reserved for [Server-side ID generation](#server-side-id) + * `|` - reserved for [Identity ID generation](#identity-id) @@ -230,7 +230,7 @@ using (var session = store.OpenSession()) The leading zeros in server-side generated IDs help reduce the risk of such accidental collisions. * **Customizing the separator character**: - The separator character can be customized. See: [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + The separator character can be customized. See: [Customizing the separator character](#customizing-the-separator-character). If it was modified (e.g., to `$`), you must end your ID string with that character instead of `/`. --- @@ -308,7 +308,7 @@ using (var session = store.OpenSession()) * **Customizing the separator character**: The separator character used in the identity IDs can be customized. - Learn more in [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + Learn more in [Customizing the separator character](#customizing-the-separator-character). * **Customizing the identity number**: The numeric part of an identity ID is an always-incrementing value managed by the server. @@ -375,7 +375,7 @@ using (var session = store.OpenSession()) * **Customizing the separator character**: The separator character used in the HiLo document IDs can be customized. - Learn more in [Customizing the separator character](../../../server/kb/document-identifier-generation.mdx#customizing-the-separator-character). + Learn more in [Customizing the separator character](#customizing-the-separator-character). --- @@ -425,8 +425,8 @@ using (var session = store.OpenSession()) -The separator character used in the [Identity](../../../server/kb/document-identifier-generation.mdx#identity-id), -[HiLo](../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id), and [Server-side](../../../server/kb/document-identifier-generation.mdx#server-side-id) document IDs can be customized. +The separator character used in the [Identity](#identity-id), +[HiLo](#hilo-algorithm-id), and [Server-side](#server-side-id) document IDs can be customized. By default, the separator is a _slash_ (`/`), but this can be changed to any other character, except _pipe_ (`|`). There are several ways to customize the separator. diff --git a/versioned_docs/version-7.1/server/kb/javascript-engine.mdx b/versioned_docs/version-7.1/server/kb/javascript-engine.mdx index fdec9dadb4..eff69e97ff 100644 --- a/versioned_docs/version-7.1/server/kb/javascript-engine.mdx +++ b/versioned_docs/version-7.1/server/kb/javascript-engine.mdx @@ -29,8 +29,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; RavenDB uses [Jint](https://github.com/sebastienros/jint), an open source JavaScript interpreter supporting ECMAScript 5.1. * In this page: - * [How RavenDB uses Jint](../../server/kb/javascript-engine.mdx#how-ravendb-uses-jint) - * [Predefined JavaScript functions](../../server/kb/javascript-engine.mdx#predefined-javascript-functions) + * [How RavenDB uses Jint](#how-ravendb-uses-jint) + * [Predefined JavaScript functions](#predefined-javascript-functions) diff --git a/versioned_docs/version-7.1/server/kb/numbers-in-ravendb.mdx b/versioned_docs/version-7.1/server/kb/numbers-in-ravendb.mdx index aaba9fe80c..0c2baa8c63 100644 --- a/versioned_docs/version-7.1/server/kb/numbers-in-ravendb.mdx +++ b/versioned_docs/version-7.1/server/kb/numbers-in-ravendb.mdx @@ -24,12 +24,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [About numbers](../../server/kb/numbers-in-ravendb.mdx#about-numbers) -* [Numbers in documents](../../server/kb/numbers-in-ravendb.mdx#numbers-in-documents) -* [Numbers in JavaScript](../../server/kb/numbers-in-ravendb.mdx#numbers-in-javascript-engine) -* [Numbers in indexes and queries](../../server/kb/numbers-in-ravendb.mdx#numbers-in-indexes-and-queries) -* [Numbers in studio](../../server/kb/numbers-in-ravendb.mdx#numbers-in-management-studio) -* [Numbers in client API](../../server/kb/numbers-in-ravendb.mdx#numbers-in-client-api) +* [About numbers](#about-numbers) +* [Numbers in documents](#numbers-in-documents) +* [Numbers in JavaScript](#numbers-in-javascript-engine) +* [Numbers in indexes and queries](#numbers-in-indexes-and-queries) +* [Numbers in studio](#numbers-in-management-studio) +* [Numbers in client API](#numbers-in-client-api) diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/backup-overview.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/backup-overview.mdx index 907a4aff40..b8915b503f 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/backup-overview.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/backup-overview.mdx @@ -36,27 +36,27 @@ import LanguageContent from "@site/src/components/LanguageContent"; Read about backups on a sharded database [in the section dedicated to it](../../sharding/backup-and-restore/backup.mdx). * In this page: - * [Backup Type](../../server/ongoing-tasks/backup-overview.mdx#backup-type) - * [Backup Contents](../../server/ongoing-tasks/backup-overview.mdx#backup-contents) + * [Backup Type](#backup-type) + * [Backup Contents](#backup-contents) * [Backup Scope: Full or Incremental](../../server/ongoing-tasks/backup-overview.mdx#backup-scope:-full-or-incremental) - * [Backup Name and Folder Structure](../../server/ongoing-tasks/backup-overview.mdx#backup-name-and-folder-structure) - * [Encryption](../../server/ongoing-tasks/backup-overview.mdx#encryption) - * [Compression](../../server/ongoing-tasks/backup-overview.mdx#compression) - * [Retention Policy](../../server/ongoing-tasks/backup-overview.mdx#retention-policy) - * [Restoration Procedure](../../server/ongoing-tasks/backup-overview.mdx#restoration-procedure) + * [Backup Name and Folder Structure](#backup-name-and-folder-structure) + * [Encryption](#encryption) + * [Compression](#compression) + * [Retention Policy](#retention-policy) + * [Restoration Procedure](#restoration-procedure) ## Backup Type There are two backup types: [Logical-backup](../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup) (or simply "Backup") and [Snapshot](../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot). #### Logical Backup - A logical backup is a compressed JSON dump of database contents, including documents, index definitions, and [additional data](../../server/ongoing-tasks/backup-overview.mdx#backup-contents) - that can be stored in [full](../../server/ongoing-tasks/backup-overview.mdx#full-backup) and [incremental](../../server/ongoing-tasks/backup-overview.mdx#incremental-backup) backups. + A logical backup is a compressed JSON dump of database contents, including documents, index definitions, and [additional data](#backup-contents) + that can be stored in [full](#full-backup) and [incremental](#incremental-backup) backups. * After a database restore, the dataset is re-indexed by the backed-up index definitions. This can be time-consuming in large datasets. #### Snapshot - A snapshot is a binary image of the database contents, full indexes, and [additional data](../../server/ongoing-tasks/backup-overview.mdx#backup-contents) + A snapshot is a binary image of the database contents, full indexes, and [additional data](#backup-contents) at a given point in time. * Restoration time is reduced because no re-indexing is needed, but more data is transferred during backups. @@ -72,7 +72,7 @@ There are two backup types: [Logical-backup](../../client-api/operations/mainten Backed-up data includes both database-level and cluster-level contents, as detailed below. -| Database-level data | [Logical Backup](../../server/ongoing-tasks/backup-overview.mdx#logical-backup) | [Snapshot](../../server/ongoing-tasks/backup-overview.mdx#snapshot) | +| Database-level data | [Logical Backup](#logical-backup) | [Snapshot](#snapshot) | |---- | - | - | | [Documents & Revisions](https://ravendb.net/learn/inside-ravendb-book/reader/4.0/3-document-modeling) | ✔ | ✔ | | [Attachments](../../document-extensions/attachments/what-are-attachments.mdx) | ✔ | ✔ | @@ -83,7 +83,7 @@ Backed-up data includes both database-level and cluster-level contents, as detai | [Conflicts](../../server/clustering/replication/replication-conflicts.mdx) | ✔ | ✔ | -| Cluster-level data | [Logical Backup](../../server/ongoing-tasks/backup-overview.mdx#logical-backup) | [Snapshot](../../server/ongoing-tasks/backup-overview.mdx#snapshot) | +| Cluster-level data | [Logical Backup](#logical-backup) | [Snapshot](#snapshot) | |---- | - | - | | [Database Record](../../studio/database/settings/database-record.mdx) | ✔ | ✔ | | [Compare-exchange values](../../compare-exchange/overview.mdx) | ✔ | ✔ | diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/basics.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/basics.mdx index 310a7bf5f5..d3d001e55e 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/basics.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/basics.mdx @@ -29,13 +29,13 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more about how ETL works on a sharded database [here](../../../sharding/etl.mdx). * In this article: - * [Why use ETL](../../../server/ongoing-tasks/etl/basics.mdx#why-use-etl) - * [Defining ETL Tasks](../../../server/ongoing-tasks/etl/basics.mdx#defining-etl-tasks) - * [ETL Stages:](../../../server/ongoing-tasks/etl/basics.mdx#etl-stages) - * [Extract](../../../server/ongoing-tasks/etl/basics.mdx#extract) - * [Transform](../../../server/ongoing-tasks/etl/basics.mdx#transform) - * [Load](../../../server/ongoing-tasks/etl/basics.mdx#load) - * [Troubleshooting](../../../server/ongoing-tasks/etl/basics.mdx#troubleshooting) + * [Why use ETL](#why-use-etl) + * [Defining ETL Tasks](#defining-etl-tasks) + * [ETL Stages:](#etl-stages) + * [Extract](#extract) + * [Transform](#transform) + * [Load](#load) + * [Troubleshooting](#troubleshooting) @@ -89,9 +89,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; ETL's three stages are: -* [Extract](../../../server/ongoing-tasks/etl/basics.mdx#extract) - Extract the documents from the database -* [Transform](../../../server/ongoing-tasks/etl/basics.mdx#transform) - Transform & filter the documents data according to the supplied script (optional) -* [Load](../../../server/ongoing-tasks/etl/basics.mdx#load) - Load (write) the transformed data into the target destination +* [Extract](#extract) - Extract the documents from the database +* [Transform](#transform) - Transform & filter the documents data according to the supplied script (optional) +* [Load](#load) - Load (write) the transformed data into the target destination --- @@ -161,7 +161,7 @@ These are not part of the general JavaScript engine and **apply to ETL scripts o | Function / Member | Type | Description | |-----------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `loadTo` | function | Loads an object to the specified target. An object will only be sent to the destination if this method is called.
This command has several syntax options,
see [The loadTo method](../../../server/ongoing-tasks/etl/basics.mdx#theloadtomethod) below. | +| `loadTo` | function | Loads an object to the specified target. An object will only be sent to the destination if this method is called.
This command has several syntax options,
see [The loadTo method](#theloadtomethod) below. | | **Attachments:** | | | | `loadAttachment(name)` | function | Loads an attachment of the current document. | | `hasAttachment(name)` | function | Returns `true` if an attachment with the given name exists on the current document. | diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/elasticsearch.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/elasticsearch.mdx index fa3541da5c..44feb73351 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/elasticsearch.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/elasticsearch.mdx @@ -21,39 +21,39 @@ import LanguageContent from "@site/src/components/LanguageContent"; or your [client](../../../client-api/operations/maintenance/etl/add-etl.mdx#example---add-elasticsearch-etl-task). * In this page: - * [Elasticsearch ETL](../../../server/ongoing-tasks/etl/elasticsearch.mdx#elasticsearch-etl) - * [Transformation Script](../../../server/ongoing-tasks/etl/elasticsearch.mdx#transformation-script) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/elasticsearch.mdx#alternative-syntax) - * [Data Delivery](../../../server/ongoing-tasks/etl/elasticsearch.mdx#data-delivery) - * [What is Transferred](../../../server/ongoing-tasks/etl/elasticsearch.mdx#what-is-transferred) - * [Document Identifiers](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) - * [Transactions](../../../server/ongoing-tasks/etl/elasticsearch.mdx#transactions) - * [Insert Only Mode](../../../server/ongoing-tasks/etl/elasticsearch.mdx#insert-only-mode) - * [Elasticsearch Index Definition](../../../server/ongoing-tasks/etl/elasticsearch.mdx#elasticsearch-index-definition) - * [Client API](../../../server/ongoing-tasks/etl/elasticsearch.mdx#client-api) - * [Add an Elasticsearch ETL Task](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) - * [Add an Elasticsearch Connection String](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) - * [Supported Elasticsearch Versions](../../../server/ongoing-tasks/etl/elasticsearch.mdx#supported-elasticsearch-versions) + * [Elasticsearch ETL](#elasticsearch-etl) + * [Transformation Script](#transformation-script) + * [Alternative Syntax](#alternative-syntax) + * [Data Delivery](#data-delivery) + * [What is Transferred](#what-is-transferred) + * [Document Identifiers](#document-identifiers) + * [Transactions](#transactions) + * [Insert Only Mode](#insert-only-mode) + * [Elasticsearch Index Definition](#elasticsearch-index-definition) + * [Client API](#client-api) + * [Add an Elasticsearch ETL Task](#add-an-elasticsearch-etl-task) + * [Add an Elasticsearch Connection String](#add-an-elasticsearch-connection-string) + * [Supported Elasticsearch Versions](#supported-elasticsearch-versions) ## Elasticsearch ETL * The following steps are required when creating an Elasticsearch ETL task: - * Define a [connection string](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) which includes: + * Define a [connection string](#add-an-elasticsearch-connection-string) which includes: * URLs to Elasticsearch nodes. * Authentication method required by the Elasticsearch nodes. * **Define the Elasticsearch Indexes** * Indexes are used by Elasticsearch to store and locate documents. * The ETL task will send new documents to the specified Elasticsearch indexes. * If not otherwise specified, existing Elasticsearch documents will be removed before adding new documents. - * A [document identifier](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) + * A [document identifier](#document-identifiers) field property is defined per document, and used by the delete command to locate the matching documents. * **Define Transformation Scripts**. The transformation script determines which RavenDB documents will be transferred, to which Elasticsearch Indexes, and in what form. * For a thorough step-by-step explanation: - * Learn [here](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) + * Learn [here](#add-an-elasticsearch-etl-task) to define an Elasticsearch ETL task using **code**. * Learn [here](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx) to define an Elasticsearch ETL task using **Studio**. @@ -148,7 +148,7 @@ adToOrders(orderData); * In addition to specifying this document property in the script, it must be defined for the ETL task: - * Either set `DocumentIdProperty` through code (see [code sample](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task)), + * Either set `DocumentIdProperty` through code (see [code sample](#add-an-elasticsearch-etl-task)), * or Set the [Document ID Property Name](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) field via Studio. ### Transactions @@ -176,7 +176,7 @@ OrderLinesCount":3,"TotalCost":0,"DocID":"orders/1-a"\} ### Insert Only Mode -You can enable the task's **Insert Only** mode using [code](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-etl-task) +You can enable the task's **Insert Only** mode using [code](#add-an-elasticsearch-etl-task) or via [Studio](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes), to **omit** _delete_by_query commands and so refrain from deleting documents before the transfer. @@ -235,7 +235,7 @@ as **"keyword"** in your index definition. Pass it an `ElasticSearchEtlConfiguration`instance with - * The name of a defined **Connection String**. You can define a connection string - [using code](../../../server/ongoing-tasks/etl/elasticsearch.mdx#add-an-elasticsearch-connection-string) + [using code](#add-an-elasticsearch-connection-string) or via [Studio](../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#define-the-elasticsearch-etl-task). * A list of **Elasticsearch Indexes**. * A list of **Transformation Scripts**. @@ -309,7 +309,7 @@ store.Maintenance.Send(operation); | Property | Type | Description | |:-------------|:-------------|:-------------| | **IndexName** | `string` | Elasticsearch Index name.
Name indexes **using lower-case characters only**, e.g. `orders`. | - | **DocumentIdProperty** | `string` | The [document ID property](../../../server/ongoing-tasks/etl/elasticsearch.mdx#document-identifiers) defined on the transferred document object inside the transformation script. | + | **DocumentIdProperty** | `string` | The [document ID property](#document-identifiers) defined on the transferred document object inside the transformation script. | | **InsertOnlyMode** | `bool` | `true` - Do not delete existing documents before appending new ones.
`false` - Delete existing document versions before appending documents.| diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/olap.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/olap.mdx index be938872b8..8ee0555977 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/olap.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/olap.mdx @@ -28,10 +28,10 @@ an alternative to CSV that is much faster to query. Unlike CSV, Parquet groups t column (by field) instead of by row (by document). * In this page: - * [Client API](../../../server/ongoing-tasks/etl/olap.mdx#client-api) - * [Transform Script](../../../server/ongoing-tasks/etl/olap.mdx#transform-script) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/olap.mdx#alternative-syntax) - * [Athena Examples](../../../server/ongoing-tasks/etl/olap.mdx#athena-examples) + * [Client API](#client-api) + * [Transform Script](#transform-script) + * [Alternative Syntax](#alternative-syntax) + * [Athena Examples](#athena-examples) ## Client API @@ -82,7 +82,7 @@ AddEtlOperationResult result = store.Maintenance.Send(operation); | Property | Type | Description | | - | - | - | | `RunFrequency` | `string` | Takes a [cron expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm) which determines how often the server will execute the ETL process. | -| `CustomPartitionValue` | `string` | A value that can be used as a partition name in multiple scripts. See [below](../../../server/ongoing-tasks/etl/olap.mdx#the-custom-partition-value). | +| `CustomPartitionValue` | `string` | A value that can be used as a partition name in multiple scripts. See [below](#the-custom-partition-value). | | `OlapTables` | `List` | List of naming configurations for individual tables. See more details below. | #### `OlapConnectionString` @@ -284,7 +284,7 @@ using this syntax: `loadTo('folder_name', key, object)` #### The Custom Partition Value The custom partition value is a string value that can be set in the -[`OlapEtlConfiguration` object](../../../server/ongoing-tasks/etl/olap.mdx#section). This value can be +[`OlapEtlConfiguration` object](#section). This value can be referenced in the transform script as `$customPartitionValue`. This setting gives you another way to distinguish data from different ETL tasks that use the same transform script. diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx index 32f0733c3c..7c55974642 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx @@ -33,21 +33,21 @@ For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../ * In this page: - * [RavenDB ETL and Amazon SQS](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#ravendb-etl-and-amazon-sqs) - * [Queue methods](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#queue-methods) - * [Standard queueing](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#standard-queueing) - * [FIFO queueing](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#fifo-queueing) - * [Caution: ETL message size -vs- Queue message size](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#caution-etl-message-size--vs--queue-message-size) - * [Add an Amazon SQS connection string](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#add-an-amazon-sqs-connection-string) - * [Authentication methods](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#authentication-methods) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#syntax) - * [Add an Amazon SQS ETL task](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#add-an-amazon-sqs-etl-task) - * [Example: Add SQS ETL task](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#example-add-sqs-etl-task) - * [Delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#the-loadto-method) + * [RavenDB ETL and Amazon SQS](#ravendb-etl-and-amazon-sqs) + * [Queue methods](#queue-methods) + * [Standard queueing](#standard-queueing) + * [FIFO queueing](#fifo-queueing) + * [Caution: ETL message size -vs- Queue message size](#caution-etl-message-size--vs--queue-message-size) + * [Add an Amazon SQS connection string](#add-an-amazon-sqs-connection-string) + * [Authentication methods](#authentication-methods) + * [Example](#example) + * [Syntax](#syntax) + * [Add an Amazon SQS ETL task](#add-an-amazon-sqs-etl-task) + * [Example: Add SQS ETL task](#example-add-sqs-etl-task) + * [Delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) ## RavenDB ETL and Amazon SQS @@ -90,7 +90,7 @@ the delivery of each message exactly once, in exchange for a much slower transfe than that of the Standard Queueing method. To load messages to a FIFO queue, add `.fifo` to the queue name while calling the -transformation script's [loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#the-loadto-method): +transformation script's [loadTo method](#the-loadto-method): {`Script = @"// Create an orderData object @@ -450,7 +450,7 @@ Source: '/promotion-campaigns/summer-sale' like `'-'` and `'.'` in target names. This is not possible when the `loadTo<QueueName>` syntax is used because including special characters in the name of a JavaScript function makes it invalid. - * To deliver messages to a [FIFO queue](../../../../server/ongoing-tasks/etl/queue-etl/amazon-sqs.mdx#fifo-queueing), + * To deliver messages to a [FIFO queue](#fifo-queueing), use this format and add `.fifo` to the queue name. `loadTo('QueueName.fifo', obj, {attributes})` diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx index 4b525de193..53a7e5b3fa 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx @@ -37,16 +37,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this page: - * [Add an Azure Queue Storage connection string](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#add-an-azure-queue-storage-connection-string) - * [Authentication methods](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#authentication-methods) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#syntax) - * [Add an Azure Queue Storage ETL task](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#add-an-azure-queue-storage-etl-task) - * [Example](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#example-basic) - * [Delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-loadto-method) + * [Add an Azure Queue Storage connection string](#add-an-azure-queue-storage-connection-string) + * [Authentication methods](#authentication-methods) + * [Example](#example) + * [Syntax](#syntax) + * [Add an Azure Queue Storage ETL task](#add-an-azure-queue-storage-etl-task) + * [Example](#example-basic) + * [Delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) ## Add an Azure Queue Storage connection string @@ -172,7 +172,7 @@ public class Passwordless * Extract source documents from the "Orders" collection in RavenDB. * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersQueue" in an Azure Queue Storage. -* For more details about the script and the `loadTo` method, see the [transromation script](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx#the-transformation-script) section below. +* For more details about the script and the `loadTo` method, see the [transromation script](#the-transformation-script) section below. diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/kafka.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/kafka.mdx index 1dee1ad681..79b0c1f9f3 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/kafka.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/kafka.mdx @@ -36,25 +36,25 @@ import ContentFrame from "@site/src/components/ContentFrame"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this article: - * [Setup workflow](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#setup-workflow) - * [Creating a Kafka ETL task using the Client API](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#creating-a-kafka-etl-task-using-the-client-api) - * [Add a Kafka connection string](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#add-a-kafka-connection-string) - * [Example: connecting to a secure Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-secure-kafka-cluster) - * [Use RavenDB Certificate](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#use-ravendb-certificate) - * [Add a Kafka ETL task](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#add-a-kafka-etl-task) - * [Example: basic](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-basic) - * [Example: delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#delete-processed-documents) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-loadto-method) - * [Prerequisites for a secure Kafka server](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#prerequisites-for-a-secure-kafka-server) - * [What needs to be granted](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#what-needs-to-be-granted) - * [Computing the transactional IDs](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#computing-the-transactional-ids) - * [Example: building the transactional ID](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#example-building-the-transactional-id) - * [Entering the grants on the Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#entering-the-grants-on-the-kafka-cluster) - * [Single-node Kafka cluster](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#single-node-kafka-cluster) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#syntax) - * [Connection string classes](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#connection-string-classes) - * [ETL task classes](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#etl-task-classes) + * [Setup workflow](#setup-workflow) + * [Creating a Kafka ETL task using the Client API](#creating-a-kafka-etl-task-using-the-client-api) + * [Add a Kafka connection string](#add-a-kafka-connection-string) + * [Example: connecting to a secure Kafka cluster](#example-secure-kafka-cluster) + * [Use RavenDB Certificate](#use-ravendb-certificate) + * [Add a Kafka ETL task](#add-a-kafka-etl-task) + * [Example: basic](#example-basic) + * [Example: delete processed documents](#delete-processed-documents) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) + * [Prerequisites for a secure Kafka server](#prerequisites-for-a-secure-kafka-server) + * [What needs to be granted](#what-needs-to-be-granted) + * [Computing the transactional IDs](#computing-the-transactional-ids) + * [Example: building the transactional ID](#example-building-the-transactional-id) + * [Entering the grants on the Kafka cluster](#entering-the-grants-on-the-kafka-cluster) + * [Single-node Kafka cluster](#single-node-kafka-cluster) + * [Syntax](#syntax) + * [Connection string classes](#connection-string-classes) + * [ETL task classes](#etl-task-classes) @@ -192,7 +192,7 @@ In this example, the Kafka ETL Task will: * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersTopic" in a Kafka broker. -For more details about the script and the `loadTo` method, see [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx#the-transformation-script) below. +For more details about the script and the `loadTo` method, see [The transformation script](#the-transformation-script) below. ```csharp // Define a transformation script for the task: diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx index bd9c87054c..0d196230cc 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/overview.mdx @@ -23,19 +23,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Azure Queue Storage** * **Amazon SQS** -* This functionality is achieved by defining [Queue ETL tasks](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#queue-etl-tasks) within a RavenDB database. +* This functionality is achieved by defining [Queue ETL tasks](#queue-etl-tasks) within a RavenDB database. * RavenDB can also function as a _Consumer_. To learn about RavenDB's role as a _Consumer_ please refer to the [Queue Sink section](../../../../server/ongoing-tasks/queue-sink/overview.mdx). * In this page: - * [Queue ETL tasks](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#queue-etl-tasks) - * [Data delivery](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#data-delivery) - * [What is transferred](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#what-is-transferred) - * [How are messages produced and consumed](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#how-are-messages-produced-and-consumed) - * [Idempotence and message duplication](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#idempotence-and-message-duplication) - * [CloudEvents](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#cloudevents) - * [Task statistics](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#task-statistics) + * [Queue ETL tasks](#queue-etl-tasks) + * [Data delivery](#data-delivery) + * [What is transferred](#what-is-transferred) + * [How are messages produced and consumed](#how-are-messages-produced-and-consumed) + * [Idempotence and message duplication](#idempotence-and-message-duplication) + * [CloudEvents](#cloudevents) + * [Task statistics](#task-statistics) ## Queue ETL tasks @@ -72,7 +72,7 @@ The above ETL tasks: Document extensions like attachments, counters, or time series, will not be transferred. * **CloudEvents messages** JSON objects produced by the task's transformation script are wrapped - and delivered as [CloudEvents Messages](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx#cloudevents). + and delivered as [CloudEvents Messages](#cloudevents). #### How are messages produced and consumed: diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx index 7e8d667597..a24c1995f0 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx @@ -30,16 +30,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; For an **overview of Queue ETL tasks**, see [Queue ETL tasks overview](../../../../server/ongoing-tasks/etl/queue-etl/overview.mdx). * In this page: - * [Add a RabbitMQ connection string](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#add-a-rabbitmq-connection-string) - * [Exmaple](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#example) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#syntax) - * [Add a RabbitMQ ETL task](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#add-a-rabbitmq-etl-task) - * [Example - basic](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#example-basic) - * [Example - delete processed documents](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#delete-processed-documents) - * [Syntax](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#syntax-1) - * [The transformation script](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-transformation-script) - * [The loadTo method](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-loadto-method) - * [Available method overloads](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#available-method-overloads) + * [Add a RabbitMQ connection string](#add-a-rabbitmq-connection-string) + * [Exmaple](#example) + * [Syntax](#syntax) + * [Add a RabbitMQ ETL task](#add-a-rabbitmq-etl-task) + * [Example - basic](#example-basic) + * [Example - delete processed documents](#delete-processed-documents) + * [Syntax](#syntax-1) + * [The transformation script](#the-transformation-script) + * [The loadTo method](#the-loadto-method) + * [Available method overloads](#available-method-overloads) ## Add a RabbitMQ connection string @@ -126,7 +126,7 @@ var res = store.Maintenance.Send( * Extract source documents from the "Orders" collection in RavenDB. * Process each "Order" document using a defined script that creates a new `orderData` object. * Load the `orderData` object to the "OrdersExchange" in a RabbitMQ broker. -* For more details about the script and the `loadTo` method overloads, see the [transromation script](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx#the-transformation-script) section below. +* For more details about the script and the `loadTo` method overloads, see the [transromation script](#the-transformation-script) section below. diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/raven.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/raven.mdx index f51de534a6..463e0627ef 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/raven.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/raven.mdx @@ -30,24 +30,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; * RavenDB ETL tasks can be defined via the Client API or the [Studio](../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx). * In this article: - * [Transformation script options](../../../server/ongoing-tasks/etl/raven.mdx#transformation-script-options) - * [Empty Script](../../../server/ongoing-tasks/etl/raven.mdx#empty-script) - * [Attachments](../../../server/ongoing-tasks/etl/raven.mdx#attachments) - * [Counters](../../../server/ongoing-tasks/etl/raven.mdx#counters) - * [Time Series](../../../server/ongoing-tasks/etl/raven.mdx#time-series) - * [Revisions](../../../server/ongoing-tasks/etl/raven.mdx#revisions) - * [Deletions](../../../server/ongoing-tasks/etl/raven.mdx#deletions) + * [Transformation script options](#transformation-script-options) + * [Empty Script](#empty-script) + * [Attachments](#attachments) + * [Counters](#counters) + * [Time Series](#time-series) + * [Revisions](#revisions) + * [Deletions](#deletions) -* [Loading documents to the destination database](../../../server/ongoing-tasks/etl/raven.mdx#loading-documents-to-the-destination-database) -* [Document identifiers](../../../server/ongoing-tasks/etl/raven.mdx#document-identifiers) -* [Filtering](../../../server/ongoing-tasks/etl/raven.mdx#filtering) -* [Loading data from related documents](../../../server/ongoing-tasks/etl/raven.mdx#loading-data-from-related-documents) -* [Accessing metadata](../../../server/ongoing-tasks/etl/raven.mdx#accessing-metadata) -* [Creating multiple documents from a single document](../../../server/ongoing-tasks/etl/raven.mdx#creating-multiple-documents-from-a-single-document) +* [Loading documents to the destination database](#loading-documents-to-the-destination-database) +* [Document identifiers](#document-identifiers) +* [Filtering](#filtering) +* [Loading data from related documents](#loading-data-from-related-documents) +* [Accessing metadata](#accessing-metadata) +* [Creating multiple documents from a single document](#creating-multiple-documents-from-a-single-document) --- @@ -169,7 +169,7 @@ loadToEmployees({ ### Document Identifiers Document IDs assigned to documents written to the destination depend on whether the source and destination collections share the same name. -You can also configure a [postfix](../../../server/ongoing-tasks/etl/raven.mdx#setting-a-destination-document-id-postfix) to further modify the resulting ID. +You can also configure a [postfix](#setting-a-destination-document-id-postfix) to further modify the resulting ID. @@ -202,7 +202,7 @@ the destination ID will look like: `employees/1-A/people/00000000000000000024-A` This happens because the ETL task appends `/` to the source ID, signaling the destination server to generate an [identity-based ID](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids). Since the destination ID differs from the source ID, the old document version is deleted on the destination database and replaced with each update. -This behavior can be changed - see [Deletions](../../../server/ongoing-tasks/etl/raven.mdx#deletions). +This behavior can be changed - see [Deletions](#deletions). ```js @@ -430,10 +430,10 @@ var managerMeta = getMetadata(manager); * If you use a script you can indicate that an attachment should also be sent by using dedicated functions: - `loadAttachment(name)` returns a reference to an attachment that is meant be passed to `addAttachment()` - `.addAttachment([name,] attachmentRef)` adds an attachment to a document that will be sent in the process, `` is a reference returned by `loadTo()` -* [Sending attachments together with documents](../../../server/ongoing-tasks/etl/raven.mdx#sending-attachments-together-with-documents) -* [Changing attachment name](../../../server/ongoing-tasks/etl/raven.mdx#changing-attachment-name) -* [Loading non-existent attachment](../../../server/ongoing-tasks/etl/raven.mdx#loading-non-existent-attachment) -* [Accessing attachments from metadata](../../../server/ongoing-tasks/etl/raven.mdx#accessing-attachments-from-metadata) +* [Sending attachments together with documents](#sending-attachments-together-with-documents) +* [Changing attachment name](#changing-attachment-name) +* [Loading non-existent attachment](#loading-non-existent-attachment) +* [Accessing attachments from metadata](#accessing-attachments-from-metadata) ### Sending attachments together with documents @@ -490,13 +490,13 @@ var attachments = this['@metadata']['@attachments']; * Counters are sent automatically when you send a _full_ collection to the destination using an _empty_ script. * If a script is defined RavenDB doesn't send counters by default. -* To indicate that a counter should also be sent, the [behavior function](../../../server/ongoing-tasks/etl/raven.mdx#counter-behavior-function) +* To indicate that a counter should also be sent, the [behavior function](#counter-behavior-function) (e.g. by increment operation). If the relevant function doesn't exist, a counter isn't loaded. * The reason that counters require special functions is that incrementing a counter _doesn't_ modify the change vector of a related document so the document _isn't_ processed by ETL on a change in the counter. * Another option of sending a counter is to explicitly add it in a script to a loaded document. -* [Counter behavior function](../../../server/ongoing-tasks/etl/raven.mdx#counter-behavior-function) -* [Adding counter explicitly in a script](../../../server/ongoing-tasks/etl/raven.mdx#adding-counter-explicitly-in-a-script) +* [Counter behavior function](#counter-behavior-function) +* [Adding counter explicitly in a script](#adding-counter-explicitly-in-a-script) ### Counter behavior function @@ -556,7 +556,7 @@ function loadCountersOfProductsBehavior(docId, counterName) { Counter behavior functions typically handle counters of documents that are loaded to the same collection. If a transformation script for `Employees` collection specifies that they are loaded to the `People` collection in a target database, - then due to document ID generation strategy by ETL process (see [Documents Identifiers](../../../server/ongoing-tasks/etl/raven.mdx#documents-identifiers)), + then due to document ID generation strategy by ETL process (see [Documents Identifiers](#documents-identifiers)), the counters won't be sent because the final ID of a loaded document isn't known on the source side. You can use special functions in the script code to deal with counters on documents that are loaded into different collections: @@ -595,8 +595,8 @@ but it **sets the value using a** `put` command. * If the transformation script is empty, time series are transferred along with their documents by default. * When the script is not empty, ETL can be set for time series via: - * [Time Series Load Behavior Function](../../../server/ongoing-tasks/etl/raven.mdx#time-series-load-behavior-function) - * [Adding Time Series to Documents](../../../server/ongoing-tasks/etl/raven.mdx#adding-time-series-to-documents) + * [Time Series Load Behavior Function](#time-series-load-behavior-function) + * [Adding Time Series to Documents](#adding-time-series-to-documents) ### Time Series Load Behavior Function @@ -721,12 +721,12 @@ Upon source document modifications, ETL is set to delete and replace the destina If you want to control the way deletions are handled in the destination database, you can change the default settings with the configurable functions described in this section. -* [Why documents are deleted by default](../../../server/ongoing-tasks/etl/raven.mdx#deletions-why-documents-are-deleted-by-default-in-the-destination-database) -* [When destination collections are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) -* [Collection specific function](../../../server/ongoing-tasks/etl/raven.mdx#deletions-collection-specific-function) -* [Generic function](../../../server/ongoing-tasks/etl/raven.mdx#deletions-generic-function) -* [Filtering deletions in the destination database](../../../server/ongoing-tasks/etl/raven.mdx#deletions-filtering-deletions-in-the-destination-database) -* [Deletions Example: ETL script with deletion behavior defined](../../../server/ongoing-tasks/etl/raven.mdx#deletions-example-etl-script-with-deletion-behavior-defined) +* [Why documents are deleted by default](#deletions-why-documents-are-deleted-by-default-in-the-destination-database) +* [When destination collections are different](#when-destination-collections-are-different) +* [Collection specific function](#deletions-collection-specific-function) +* [Generic function](#deletions-generic-function) +* [Filtering deletions in the destination database](#deletions-filtering-deletions-in-the-destination-database) +* [Deletions Example: ETL script with deletion behavior defined](#deletions-example-etl-script-with-deletion-behavior-defined) --- @@ -747,9 +747,9 @@ The functions in this section were created to allow developers this control. **If we ETL to a different collection than the source**, the source isn't aware of the new IDs created. This forces us to load new documents with incremented IDs instead of overwriting the fields in existing documents. -RavenDB has to create a new, updated document in the destination with an [incremented server-made identity](../../../server/ongoing-tasks/etl/raven.mdx#documents-identifiers). +RavenDB has to create a new, updated document in the destination with an [incremented server-made identity](#documents-identifiers). You can then choose if you want to delete the old version in the destination by selecting -`return false` in the transform script function [deleteDocumentsBehavior](../../../server/ongoing-tasks/etl/raven.mdx#deletions-generic-function). +`return false` in the transform script function [deleteDocumentsBehavior](#deletions-generic-function). * Each updated version of the document gets a [server generated ID](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#server-side-generated-ids) in which the number at the end is incremented with each version. @@ -775,7 +775,7 @@ sending a single delete command in the destination for a given ID. If documents are updated and not deleted in the source, they will simply be updated in the destination with no change to the destination document ID. Deletions can be controlled by defining deletion behavior functions in the ETL script. -* See a [sample ETL script with deletion behavior defined](../../../server/ongoing-tasks/etl/raven.mdx#deletions-example-etl-script-with-deletion-behavior-defined). +* See a [sample ETL script with deletion behavior defined](#deletions-example-etl-script-with-deletion-behavior-defined). --- @@ -793,7 +793,7 @@ function deleteDocumentsOfBehavior(docId, deleted) { `` needs to be substituted by a real collection name that the ETL script is working on -(same convention as for [loadTo](../../../server/ongoing-tasks/etl/raven.mdx#transformation-script-options) method). +(same convention as for [loadTo](#transformation-script-options) method). e.g. `function deleteDocumentsOfOrdersBehavior(docId, deleted) {return false;}` | Parameter | Type | Description | Notes | @@ -861,7 +861,7 @@ trigger the command regardless of whether the source document was deleted. ### Example - Generic deletions behavior function -[If the source and destination collection names are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) +[If the source and destination collection names are different](#when-destination-collections-are-different) and deletions behavior is set to false, each document change will load a new document with an incremented document identity, thus saving a history. @@ -958,7 +958,7 @@ function deleteDocumentsBehavior(docId, collection, deleted) { The following example will check if the source document was deleted or just updated before loading the transformed document. This function can be used if the destination collection is the same or different from the source. -> [In this example, the source and destination collection names are different](../../../server/ongoing-tasks/etl/raven.mdx#when-destination-collections-are-different) +> [In this example, the source and destination collection names are different](#when-destination-collections-are-different) and deletions behavior is set to false if the source is deleted, so source deletions won't delete the destination document, thus saving a history of documents even if they're deleted in the source. diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/snowflake.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/snowflake.mdx index 092a664c57..5035e0e792 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/snowflake.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/snowflake.mdx @@ -26,20 +26,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Snowflake ETL is enabled with a RavenDB [Enterprise License](https://ravendb.net/buy). * In this page: - * [Creating a Task](../../../server/ongoing-tasks/etl/snowflake.mdx#creating-a-task) - * [Snowflake warehouse setup](../../../server/ongoing-tasks/etl/snowflake.mdx#snowflake-warehouse-setup) - * [Snowflake Tables](../../../server/ongoing-tasks/etl/snowflake.mdx#snowflake-tables) - * [Performance improvement suggestions](../../../server/ongoing-tasks/etl/snowflake.mdx#performance-improvement-suggestions) - * [Transformation Scripts](../../../server/ongoing-tasks/etl/snowflake.mdx#transformation-scripts) - * [`loadTo` Method](../../../server/ongoing-tasks/etl/snowflake.mdx#method) - * [Alternative Syntax](../../../server/ongoing-tasks/etl/snowflake.mdx#alternative-syntax) - * [Filtering](../../../server/ongoing-tasks/etl/snowflake.mdx#filtering) - * [Loading Other Documents](../../../server/ongoing-tasks/etl/snowflake.mdx#loading-other-documents) - * [Accessing Metadata](../../../server/ongoing-tasks/etl/snowflake.mdx#accessing-metadata) - * [Loading to Multiple Tables](../../../server/ongoing-tasks/etl/snowflake.mdx#loading-to-multiple-tables) - * [Document Extensions](../../../server/ongoing-tasks/etl/snowflake.mdx#document-extensions) - * [Transaction Processing](../../../server/ongoing-tasks/etl/snowflake.mdx#transaction-processing) - * [Advanced Options](../../../server/ongoing-tasks/etl/snowflake.mdx#advanced-options) + * [Creating a Task](#creating-a-task) + * [Snowflake warehouse setup](#snowflake-warehouse-setup) + * [Snowflake Tables](#snowflake-tables) + * [Performance improvement suggestions](#performance-improvement-suggestions) + * [Transformation Scripts](#transformation-scripts) + * [`loadTo` Method](#method) + * [Alternative Syntax](#alternative-syntax) + * [Filtering](#filtering) + * [Loading Other Documents](#loading-other-documents) + * [Accessing Metadata](#accessing-metadata) + * [Loading to Multiple Tables](#loading-to-multiple-tables) + * [Document Extensions](#document-extensions) + * [Transaction Processing](#transaction-processing) + * [Advanced Options](#advanced-options) ## Creating a Task diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/sql.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/sql.mdx index 50d08c6960..40167d1fa9 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/sql.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/sql.mdx @@ -15,24 +15,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; * **SQL ETL** is a task that creates an [ETL process](../../../server/ongoing-tasks/etl/basics.mdx) where data from a RavenDB database is extracted, transformed, and loaded into a relational database as the destination. * In this article: - * [Supported relational databases](../../../server/ongoing-tasks/etl/sql.mdx#supported-relational-databases) - * [Creating the SQL ETL task](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task) - * [Configuring the SQL tables](../../../server/ongoing-tasks/etl/sql.mdx#configuring-the-sql-tables) - * [Document ID column](../../../server/ongoing-tasks/etl/sql.mdx#document-id-column) - * [Insert only](../../../server/ongoing-tasks/etl/sql.mdx#insert-only) - * [Transformation scripts](../../../server/ongoing-tasks/etl/sql.mdx#transformation-scripts) - * [The `loadTo` method](../../../server/ongoing-tasks/etl/sql.mdx#the-loadto-method) - * [Loading to multiple tables](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-multiple-tables) - * [Loading related documents](../../../server/ongoing-tasks/etl/sql.mdx#loading-related-documents) - * [Loading attachments](../../../server/ongoing-tasks/etl/sql.mdx#loading-attachments) - * [Loading to VARCHAR and NVARCHAR columns](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-varchar-and-nvarchar-columns) - * [Loading to specific column types](../../../server/ongoing-tasks/etl/sql.mdx#loading-to-specific-column-types) - * [Filtering](../../../server/ongoing-tasks/etl/sql.mdx#filtering) - * [Accessing the metadata](../../../server/ongoing-tasks/etl/sql.mdx#accessing-the-metadata) - * [Document extensions](../../../server/ongoing-tasks/etl/sql.mdx#document-extensions) - * [Advanced options](../../../server/ongoing-tasks/etl/sql.mdx#advanced-options) - * [Transaction processing](../../../server/ongoing-tasks/etl/sql.mdx#transaction-processing) - * [Creating the SQL ETL task from the Client API](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task-from-the-client-api) + * [Supported relational databases](#supported-relational-databases) + * [Creating the SQL ETL task](#creating-the-sql-etl-task) + * [Configuring the SQL tables](#configuring-the-sql-tables) + * [Document ID column](#document-id-column) + * [Insert only](#insert-only) + * [Transformation scripts](#transformation-scripts) + * [The `loadTo` method](#the-loadto-method) + * [Loading to multiple tables](#loading-to-multiple-tables) + * [Loading related documents](#loading-related-documents) + * [Loading attachments](#loading-attachments) + * [Loading to VARCHAR and NVARCHAR columns](#loading-to-varchar-and-nvarchar-columns) + * [Loading to specific column types](#loading-to-specific-column-types) + * [Filtering](#filtering) + * [Accessing the metadata](#accessing-the-metadata) + * [Document extensions](#document-extensions) + * [Advanced options](#advanced-options) + * [Transaction processing](#transaction-processing) + * [Creating the SQL ETL task from the Client API](#creating-the-sql-etl-task-from-the-client-api) @@ -59,7 +59,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; -To create an SQL ETL task using the Client API, see [Creating the SQL ETL task from the Client API](../../../server/ongoing-tasks/etl/sql.mdx#creating-the-sql-etl-task-from-the-client-api). +To create an SQL ETL task using the Client API, see [Creating the SQL ETL task from the Client API](#creating-the-sql-etl-task-from-the-client-api). To create an SQL ETL task from Studio, open `Tasks` > `Ongoing Tasks`. ![Configure SQL ETL task](./assets/sql-etl-setup.png) diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/etl/test-scripts.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/etl/test-scripts.mdx index d4772eca3b..05a53ddb7b 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/etl/test-scripts.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/etl/test-scripts.mdx @@ -17,8 +17,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * ETL transformations can be tested with the usage of `Test script` option. Edit your script in the Studio to enter test mode. * In this page: - * [Testing Raven ETL Scripts](../../../server/ongoing-tasks/etl/test-scripts.mdx#testing-raven-etl-scripts) - * [Testing SQL ETL Scripts](../../../server/ongoing-tasks/etl/test-scripts.mdx#testing-sql-etl-scripts) + * [Testing Raven ETL Scripts](#testing-raven-etl-scripts) + * [Testing SQL ETL Scripts](#testing-sql-etl-scripts) diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/external-replication.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/external-replication.mdx index 715fd45222..2670e550ec 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/external-replication.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/external-replication.mdx @@ -26,17 +26,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; For additional functionality such as filtration and two-way replication consider [Hub/Sink Replication](../../server/ongoing-tasks/hub-sink-replication.mdx). * To replicate between two separate, secure RavenDB servers, - you need to [pass a client certificate](../../server/ongoing-tasks/external-replication.mdx#step-by-step-guide) from the source server to the destination. + you need to [pass a client certificate](#step-by-step-guide) from the source server to the destination. * The External Replication task **does _not_ create a backup** of your data and indexes. See more in [Backup -vs- Replication](../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task) * In this page: - * [General Information about External Replication Task](../../server/ongoing-tasks/external-replication.mdx#general-information-about-external-replication-task) - * [Code Sample](../../server/ongoing-tasks/external-replication.mdx#code-sample) - * [Step-by-Step Guide](../../server/ongoing-tasks/external-replication.mdx#step-by-step-guide) - * [Definition](../../server/ongoing-tasks/external-replication.mdx#definition) - * [Offline Behavior](../../server/ongoing-tasks/external-replication.mdx#offline-behavior) - * [Delayed Replication](../../server/ongoing-tasks/external-replication.mdx#delayed-replication) + * [General Information about External Replication Task](#general-information-about-external-replication-task) + * [Code Sample](#code-sample) + * [Step-by-Step Guide](#step-by-step-guide) + * [Definition](#definition) + * [Offline Behavior](#offline-behavior) + * [Delayed Replication](#delayed-replication) @@ -167,7 +167,7 @@ To create an external replication task via the RavenDB Studio, see the [Step-by- ## Definition -To learn how to define an external replication task via code, see [code sample](../../server/ongoing-tasks/external-replication.mdx#code-sample). +To learn how to define an external replication task via code, see [code sample](#code-sample). You can also configure external eplication tasks [via RavenDB Studio](../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition). diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/hub-sink-replication.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/hub-sink-replication.mdx index d80d4f1777..103d870856 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/hub-sink-replication.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/hub-sink-replication.mdx @@ -35,14 +35,14 @@ Hub whenever they are online. * In this page: * [What is and is not replicated?](../../server/ongoing-tasks/hub-sink-replication.mdx#what-is-and-is-not-replicated?) - * [Defining Replication Tasks](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-replication-tasks) - * [Defining a Replication Hub](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-replication-hub) - * [Defining a Hub Access](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-hub-access) - * [Defining a Replication Sink](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-replication-sink) - * [Defining a Connection String](../../server/ongoing-tasks/hub-sink-replication.mdx#defining-a-connection-string) - * [Usage Sample](../../server/ongoing-tasks/hub-sink-replication.mdx#usage-sample) - * [Failover](../../server/ongoing-tasks/hub-sink-replication.mdx#failover) - * [Backward Compatibility](../../server/ongoing-tasks/hub-sink-replication.mdx#backward-compatibility) + * [Defining Replication Tasks](#defining-replication-tasks) + * [Defining a Replication Hub](#defining-a-replication-hub) + * [Defining a Hub Access](#defining-a-hub-access) + * [Defining a Replication Sink](#defining-a-replication-sink) + * [Defining a Connection String](#defining-a-connection-string) + * [Usage Sample](#usage-sample) + * [Failover](#failover) + * [Backward Compatibility](#backward-compatibility) ## What is and is not replicated? diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx index 00c431a764..8e936d3d3c 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx @@ -27,15 +27,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; user-defined scripts, and store the documents in RavenDB collections. * In this page: - * [The Queue Sink Task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#the-queue-sink-task) - * [Connecting a Kafka broker](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#connecting-a-kafka-broker) - * [Retrieving enqueued messages from selected Kafka topics](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#retrieving-enqueued-messages-from-selected-kafka-topics) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#client-api) - * [Add a Kafka Connection String](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#add-a-kafka-connection-string) - * [Add a Kafka Sink Task](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#add-a-kafka-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#configuration-options) + * [The Queue Sink Task](#the-queue-sink-task) + * [Connecting a Kafka broker](#connecting-a-kafka-broker) + * [Retrieving enqueued messages from selected Kafka topics](#retrieving-enqueued-messages-from-selected-kafka-topics) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Add a Kafka Connection String](#add-a-kafka-connection-string) + * [Add a Kafka Sink Task](#add-a-kafka-sink-task) + * [Configuration Options](#configuration-options) @@ -54,7 +54,7 @@ In the message broker architecture, RavenDB sinks take the role of data consumer A sink would connect a Kafka broker using a connection string, and retrieve messages from the broker's Topics. -Read [below](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#add-a-kafka-connection-string) +Read [below](#add-a-kafka-connection-string) about adding a connection string via API. Read [here](../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-a-kafka-sink-task) about adding a connection string using Studio. @@ -176,7 +176,7 @@ user in Studio, but **continue processing the batch**. Once a batch is consumed, the task confirms it by calling `kafkaConsumer.Commit()`. Note that the number of documents included in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). Producers may enqueue diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/overview.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/overview.mdx index 897416bb0c..909d7451ae 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/overview.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/overview.mdx @@ -39,9 +39,9 @@ ability to process this data, reveal and exploit its value. * In this page: - * [Supported Message Brokers](../../../server/ongoing-tasks/queue-sink/overview.mdx#supported-message-brokers) - * [Task Statistics](../../../server/ongoing-tasks/queue-sink/overview.mdx#task-statistics) - * [Licensing](../../../server/ongoing-tasks/queue-sink/overview.mdx#licensing) + * [Supported Message Brokers](#supported-message-brokers) + * [Task Statistics](#task-statistics) + * [Licensing](#licensing) ## Supported Message Brokers diff --git a/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx b/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx index ac6e88140f..f31619f584 100644 --- a/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx +++ b/versioned_docs/version-7.1/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx @@ -27,15 +27,15 @@ import ContentFrame from "@site/src/components/ContentFrame"; using user-defined scripts, and store the documents in RavenDB collections. * In this page: - * [The RabbitMQ Sink Task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#the-rabbitmq-sink-task) - * [Connecting a RabbitMQ broker](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#connecting-a-rabbitmq-broker) - * [Retrieving messages from RabbitMQ queues](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#retrieving-messages-from-rabbitmq-queues) - * [Running user-defined scripts](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#running-user-defined-scripts) - * [Storing documents in RavenDB collections](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#storing-documents-in-ravendb-collections) - * [Client API](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#client-api) - * [Add a RabbitMQ Connection String](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#add-a-rabbitmq-connection-string) - * [Add a RabbitMQ Sink Task](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#add-a-rabbitmq-sink-task) - * [Configuration Options](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#configuration-options) + * [The RabbitMQ Sink Task](#the-rabbitmq-sink-task) + * [Connecting a RabbitMQ broker](#connecting-a-rabbitmq-broker) + * [Retrieving messages from RabbitMQ queues](#retrieving-messages-from-rabbitmq-queues) + * [Running user-defined scripts](#running-user-defined-scripts) + * [Storing documents in RavenDB collections](#storing-documents-in-ravendb-collections) + * [Client API](#client-api) + * [Add a RabbitMQ Connection String](#add-a-rabbitmq-connection-string) + * [Add a RabbitMQ Sink Task](#add-a-rabbitmq-sink-task) + * [Configuration Options](#configuration-options) @@ -54,7 +54,7 @@ In the message broker architecture, RavenDB sinks take the role of data consumer A sink would connect a RabbitMQ broker using a connection string, and retrieve messages from the broker's queues. -Read [below](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#add-a-rabbitmq-connection-string) +Read [below](#add-a-rabbitmq-connection-string) about adding a connection string via API. Read [here](../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-a-rabbitmq-sink-task) about adding a connection string using Studio. @@ -163,7 +163,7 @@ user in Studio, but **continue processing the batch**. Once a batch is consumed, the task confirms it by sending `_channel.BasicAck`. Note that the number of documents included in a batch is -[configurable](../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx#configuration-options). +[configurable](#configuration-options). Producers may enqueue diff --git a/versioned_docs/version-7.1/server/security/audit-log/audit-log-overview.mdx b/versioned_docs/version-7.1/server/security/audit-log/audit-log-overview.mdx index 6a2f75f9d5..361666a5bf 100644 --- a/versioned_docs/version-7.1/server/security/audit-log/audit-log-overview.mdx +++ b/versioned_docs/version-7.1/server/security/audit-log/audit-log-overview.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; See the full list of what is being logged below. * In this page: - * [Enabling the audit log](../../../server/security/audit-log/audit-log-overview.mdx#enabling-the-audit-log) - * [What is being logged](../../../server/security/audit-log/audit-log-overview.mdx#what-is-being-logged) - * [Things to consider](../../../server/security/audit-log/audit-log-overview.mdx#things-to-consider) + * [Enabling the audit log](#enabling-the-audit-log) + * [What is being logged](#what-is-being-logged) + * [Things to consider](#things-to-consider) ## Enabling the audit log diff --git a/versioned_docs/version-7.1/server/security/authentication/certificate-configuration.mdx b/versioned_docs/version-7.1/server/security/authentication/certificate-configuration.mdx index 0f10089aa1..a6849c17aa 100644 --- a/versioned_docs/version-7.1/server/security/authentication/certificate-configuration.mdx +++ b/versioned_docs/version-7.1/server/security/authentication/certificate-configuration.mdx @@ -23,12 +23,12 @@ authentication in a much easier and faster way with automatic certificate renewa If you choose manual setup and/or to provide your own certificate, **you are responsible for its periodic renewal**. * In this page: - * [Prerequisites](../../../server/security/authentication/certificate-configuration.mdx#prerequisites) - * [Standard Manual Setup With Certificate Stored Locally](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) - * [Certificate Requirements](../../../server/security/authentication/certificate-configuration.mdx#certificate-requirements) - * [Certificate Location](../../../server/security/authentication/certificate-configuration.mdx#certificate-location) - * [With Logic Foreign to RavenDB or External Certificate Storage](../../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage) - * [Step-by-step Guide to Installing Certificate](../../../server/security/authentication/certificate-configuration.mdx#step-by-step-guide-to-installing-certificate) + * [Prerequisites](#prerequisites) + * [Standard Manual Setup With Certificate Stored Locally](#standard-manual-setup-with-certificate-stored-locally) + * [Certificate Requirements](#certificate-requirements) + * [Certificate Location](#certificate-location) + * [With Logic Foreign to RavenDB or External Certificate Storage](#with-logic-foreign-to-ravendb-or-external-certificate-storage) + * [Step-by-step Guide to Installing Certificate](#step-by-step-guide-to-installing-certificate) @@ -39,7 +39,7 @@ To enable authentication, either `Security.Certificate.Path` or `Security.Certif #### Setting up Client Certificates When the server is manually set up with a server certificate for the first time, there are no client certificates registered in the server yet. The first action an administrator will do is to [generate/register a new client certificate](../../../server/security/authentication/client-certificate-usage.mdx). -Find detailed instructions of the process [below](../../../server/security/authentication/certificate-configuration.mdx#step-by-step-guide-to-installing-certificate). +Find detailed instructions of the process [below](#step-by-step-guide-to-installing-certificate). You can set up various client certificates with different security clearance levels and database permissions. See [Certificate Management](../../../server/security/authentication/certificate-management.mdx) for more about permissions. @@ -180,7 +180,7 @@ In all secure configurations, the `ServerUrl` must contain the same domain name - Extract the .zip into the folders on each machine where the server nodes will permanently live. - Store server certificate in your desired location with secure permissions. -2. In each node `Server` folder, create the `settings.json` file which you will configure like the [examples](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. +2. In each node `Server` folder, create the `settings.json` file which you will configure like the [examples](#standard-manual-setup-with-certificate-stored-locally) above. * You can do this by going into the node `Server` folder > right-click > **New** > **Text Document** > name it `settings.json` instead of ...txt > click **Yes** > open it and begin configuring. * Place the `settings.json` inside each node's `Server` folder because when you run the server, RavenDB is programmed to find the settings there. @@ -189,12 +189,12 @@ In all secure configurations, the `ServerUrl` must contain the same domain name - Set the `ServerUrl`. Make sure to use `https` and that it matches the domain established in your certificate. - Set `Setup.Mode` to `None` to deactivate the RavenDB Setup Wizard. - Set `DataDir` to the desired database storage folder on each machine. - - Set the `Security.Certificate.Path` to the **.pfx** that you placed in each server folder if certificate is stored with [RavenDB logic on local machines](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) - or `Security.Certificate.Load.Exec` if using [external location or logic](../../../server/security/authentication/certificate-configuration.mdx#with-logic-foreign-to-ravendb-or-external-certificate-storage). + - Set the `Security.Certificate.Path` to the **.pfx** that you placed in each server folder if certificate is stored with [RavenDB logic on local machines](#standard-manual-setup-with-certificate-stored-locally) + or `Security.Certificate.Load.Exec` if using [external location or logic](#with-logic-foreign-to-ravendb-or-external-certificate-storage). - Make sure that the certificate .path or .load script lead to the correct certificate location. `.Path` should look something like this: `"Security.Certificate.Path": "C:/Windows/MyDomainName/A/Server/ravendb.domain.com.pfx"` - See [.json example for a .Path situation](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. - - Setting a **password** on the certificate is optional. See [settings.json example](../../../server/security/authentication/certificate-configuration.mdx#standard-manual-setup-with-certificate-stored-locally) above. + See [.json example for a .Path situation](#standard-manual-setup-with-certificate-stored-locally) above. + - Setting a **password** on the certificate is optional. See [settings.json example](#standard-manual-setup-with-certificate-stored-locally) above. Run 4. Right-click and run the `run.ps1` (or `run.sh` in Linux) in the extracted server package. In Windows, it runs in PowerShell as a default. diff --git a/versioned_docs/version-7.1/server/security/authentication/certificate-management.mdx b/versioned_docs/version-7.1/server/security/authentication/certificate-management.mdx index 20c7509084..efdc063062 100644 --- a/versioned_docs/version-7.1/server/security/authentication/certificate-management.mdx +++ b/versioned_docs/version-7.1/server/security/authentication/certificate-management.mdx @@ -17,26 +17,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Once authentication is set up, it's the administrator's responsibility to issue and manage client certificates. Each client certificate can be configured to specify which databases the certificate can access and its authorization clearance level. -* Read about the logic and rationale behind RavenDB's client certificates in [The RavenDB Security Authorization Approach](../../../server/security/authentication/certificate-management.mdx#the-ravendb-security-authorization-approach) to ensure that you configure them appropriately. +* Read about the logic and rationale behind RavenDB's client certificates in [The RavenDB Security Authorization Approach](#the-ravendb-security-authorization-approach) to ensure that you configure them appropriately. * See the API article for integrating a client certificate into an application via the [document store](../../../client-api/creating-document-store.mdx). In this page: -* [Studio Certificate Management View](../../../server/security/authentication/certificate-management.mdx#studio-certificates-management-view) -* [The RavenDB Security Authorization Approach](../../../server/security/authentication/certificate-management.mdx#the-ravendb-security-authorization-approach) - * [Authorization Levels in Client Certificates](../../../server/security/authentication/certificate-management.mdx#authorization-levels-in-client-certificates) - * [Partial Access to Database](../../../server/security/authentication/certificate-management.mdx#partial-access-to-database) -* [Create and Configure Certificates](../../../server/security/authentication/certificate-management.mdx#create-and-configure-certificates) - * [List of Registered Certificates](../../../server/security/authentication/certificate-management.mdx#list-of-registered-certificates) - * [Generate Client Certificate](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) - * [Edit Certificate](../../../server/security/authentication/certificate-management.mdx#edit-certificate) +* [Studio Certificate Management View](#studio-certificates-management-view) +* [The RavenDB Security Authorization Approach](#the-ravendb-security-authorization-approach) + * [Authorization Levels in Client Certificates](#authorization-levels-in-client-certificates) + * [Partial Access to Database](#partial-access-to-database) +* [Create and Configure Certificates](#create-and-configure-certificates) + * [List of Registered Certificates](#list-of-registered-certificates) + * [Generate Client Certificate](#generate-client-certificate) + * [Edit Certificate](#edit-certificate) * [Enabling Communication Between Servers: Importing and Exporting Certificates](../../../server/security/authentication/certificate-management.mdx#enabling-communication-between-servers:-importing-and-exporting-certificates) - * [Export Server Certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) - * [Upload an Existing Certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) - * [Certificate Collections](../../../server/security/authentication/certificate-management.mdx#certificate-collections) - * [Private Keys](../../../server/security/authentication/certificate-management.mdx#private-keys) - * [Client Certificate Chain of Trust](../../../server/security/authentication/certificate-management.mdx#client-certificate-chain-of-trust) + * [Export Server Certificates](#export-server-certificates) + * [Upload an Existing Certificate](#upload-an-existing-certificate) + * [Certificate Collections](#certificate-collections) + * [Private Keys](#private-keys) + * [Client Certificate Chain of Trust](#client-certificate-chain-of-trust) ## Studio Certificates Management View @@ -48,19 +48,19 @@ In this page: 3. **Client certificate** ![Client Certificate Button Options](./assets/client-certificate-button-options.png) * **Generate client certificate** - [Create and configure](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) a new client certificate + [Create and configure](#generate-client-certificate) a new client certificate * **Upload client certificate** - [Import a client certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) that was exported from another server so that they can communicate. + [Import a client certificate](#upload-an-existing-certificate) that was exported from another server so that they can communicate. 4. **Server certificates** ![Server Certificates Button Options](./assets/server-certificates-button-options.png) * **Export server certificates** - [Download server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) so that you can download and then import them into another server. + [Download server certificates](#export-server-certificates) so that you can download and then import them into another server. * **Replace server certificates** [Replace server certificates](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) by uploading another `.pfx` certificate. 5. Status of the current server certificate. * Click [Renew now](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) to renew a server certificate's expiration period. If you did not set up your server with the RavenDB Installation Wizard and Let's Encrypt then **you are responsible** to renew your certificates periodically. -6. Status of current client certificates active in this server. You can remove or [edit client certificates](../../../server/security/authentication/certificate-management.mdx#edit-certificate), +6. Status of current client certificates active in this server. You can remove or [edit client certificates](#edit-certificate), including configuring databases permissions and [authorization (security clearance) levels](../../../server/security/authorization/security-clearance-and-permissions.mdx#authorization-security-clearance-and-permissions) here. @@ -90,7 +90,7 @@ does not really exist within RavenDB in this manner. Instead, cluster admins or * [User](../../../server/security/authorization/security-clearance-and-permissions.mdx#user) Lowest levels of privileges. * "User" certificates are configured to specify which databases people can access with each certificate. - * ["User" authorization levels](../../../server/security/authentication/certificate-management.mdx#setting-user-access-levels) are also configured per database. + * ["User" authorization levels](#setting-user-access-levels) are also configured per database. In most cases, users do not access RavenDB directly. Aside from admins and developers during the development process, all access to the data inside RavenDB is expected to be done through your applications. A security mechanism on a per-user basis is not practical in complex systems @@ -121,19 +121,19 @@ any and all documents in that database unless protection is explicitly configure There are two approaches to giving partial access to a database: - * [Using ETL for selective, one-way data transfer](../../../server/security/authentication/certificate-management.mdx#using-etl-for-selective-one-way-data-transfer) - * [Setting "User" Access Levels](../../../server/security/authentication/certificate-management.mdx#setting-user-access-levels) + * [Using ETL for selective, one-way data transfer](#using-etl-for-selective-one-way-data-transfer) + * [Setting "User" Access Levels](#setting-user-access-levels) #### *Using ETL for selective, one-way data transfer* Some developers need to provide partial access to a database that also contains sensitive data. One approach is to set up an [Extract, Transform, Load (ETL) task](../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx): 1. [Create](../../../studio/database/create-new-database/general-flow.mdx) a dedicated database that the public will be able to access. -2. [Generate a client certificate](../../../server/security/authentication/certificate-management.mdx#generate-client-certificate) with "User" security clearance so that +2. [Generate a client certificate](#generate-client-certificate) with "User" security clearance so that you can configure it to give access only to the dedicated, public-facing database. 3. If the dedicated database is on a different cluster than the source database: (This is optional. If both databases are on the same cluster, skip to step 4.) - * [Export (download) server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) from the **destination server**. - * [Upload the .pfx certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) to the **source server** to enable the two to connect. + * [Export (download) server certificates](#export-server-certificates) from the **destination server**. + * [Upload the .pfx certificate](#upload-an-existing-certificate) to the **source server** to enable the two to connect. * While uploading, configure the certificate to give access to the target source database. 4. Then set up an [ETL](../../../server/ongoing-tasks/etl/raven.mdx) task from the source database to the exposed, destination database. * Set up a Javascript [Transform script](../../../server/ongoing-tasks/etl/basics.mdx#transform) in the ETL to automatically filter the information passed from the source to destination databases. @@ -164,12 +164,12 @@ With this clearance, you can set a different access level to each database. The -This approach is similar to the HR Manager and Customers certificates in the example given [above](../../../server/security/authentication/certificate-management.mdx#authorization-levels-in-client-certificates). +This approach is similar to the HR Manager and Customers certificates in the example given [above](#authorization-levels-in-client-certificates). It enables developers to control access levels by configuring client certificates. -* To learn how to configure each client certificate's database permissions and authorization levels via the RavenDB Studio GUI, see [Create and Configure Certificates](../../../server/security/authentication/certificate-management.mdx#create-and-configure-certificates). +* To learn how to configure each client certificate's database permissions and authorization levels via the RavenDB Studio GUI, see [Create and Configure Certificates](#create-and-configure-certificates). * To learn how to configure client certificates via CLI, see [Authentication: Client Certificate Usage](../../../server/security/authentication/client-certificate-usage.mdx#authentication-client-certificate-usage) @@ -287,8 +287,8 @@ The following section explains how to give configurable access that enables comm To connect two secure databases, the destination cluster needs to trust the source cluster. To achieve that you need to: -a. **Export** ([download](../../../server/security/authentication/certificate-management.mdx#export-server-certificates)) the server certificate **from the source server**. -b. **Upload** ([import](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate)) the downloaded certificate **into the destination server**. +a. **Export** ([download](#export-server-certificates)) the server certificate **from the source server**. +b. **Upload** ([import](#upload-an-existing-certificate)) the downloaded certificate **into the destination server**. @@ -298,19 +298,19 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana 2. Click **Server certificates** in the source server. ![Server Certificates Button Options](./assets/server-certificates-button-options.png) * **Export server certificates** - [Download server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) + [Download server certificates](#export-server-certificates) so that you can download and then import them into another server. 3. Click **Client certificate** in the destination server. ![Client Certificate Button Options](./assets/client-certificate-button-options.png) * **Upload client certificate** - [Import a client certificate](../../../server/security/authentication/certificate-management.mdx#upload-an-existing-certificate) + [Import a client certificate](#upload-an-existing-certificate) that was exported from another server so that the two can communicate. ### Export Server Certificates ![Figure 6. Export Server Certificates](./assets/export-server-certificates.png) This option allows you to export the server certificate as a .pfx file. In the case of a cluster which contains several different server certificates, -a .pfx [collection](../../../server/security/authentication/certificate-management.mdx#certificate-collections) will be exported. +a .pfx [collection](#certificate-collections) will be exported. ### Upload an Existing Certificate Click the **Client certificate** button, select **Upload client certificate** and you will see the following window. diff --git a/versioned_docs/version-7.1/server/security/authentication/lets-encrypt-certificates.mdx b/versioned_docs/version-7.1/server/security/authentication/lets-encrypt-certificates.mdx index 305554f5d4..ae4ef8c8a5 100644 --- a/versioned_docs/version-7.1/server/security/authentication/lets-encrypt-certificates.mdx +++ b/versioned_docs/version-7.1/server/security/authentication/lets-encrypt-certificates.mdx @@ -108,7 +108,7 @@ When your server uses a Let's Encrypt certificate obtained via the Setup Wizard, ravendb> triggerCertificateRefresh [-replaceImmediately] ``` -Both methods trigger the same certificate replacement process described [above](../../../server/security/authentication/lets-encrypt-certificates.mdx#automatic-renewal-for-lets-encrypt-certificates-obtained-via-ravendb). +Both methods trigger the same certificate replacement process described [above](#automatic-renewal-for-lets-encrypt-certificates-obtained-via-ravendb). If a node is down when renewal is triggered, the cluster will complete the operation without that node. **When bringing that node up, the certificate must be replaced manually.** diff --git a/versioned_docs/version-7.1/server/security/authentication/recover-from-expired-certificate.mdx b/versioned_docs/version-7.1/server/security/authentication/recover-from-expired-certificate.mdx index bb03a50a4f..338c8945eb 100644 --- a/versioned_docs/version-7.1/server/security/authentication/recover-from-expired-certificate.mdx +++ b/versioned_docs/version-7.1/server/security/authentication/recover-from-expired-certificate.mdx @@ -37,12 +37,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; the server machine. * In this article: - * [What happens when the server certificate expires](../../../server/security/authentication/recover-from-expired-certificate.mdx#what-happens-when-the-server-certificate-expires) - * [Recover the server](../../../server/security/authentication/recover-from-expired-certificate.mdx#recover-the-server) - * [Obtain a valid certificate](../../../server/security/authentication/recover-from-expired-certificate.mdx#obtain-a-valid-certificate) - * [Install the new certificate](../../../server/security/authentication/recover-from-expired-certificate.mdx#install-the-new-certificate) - * [Recover a cluster](../../../server/security/authentication/recover-from-expired-certificate.mdx#recover-a-cluster) - * [Prevent recurrence](../../../server/security/authentication/recover-from-expired-certificate.mdx#prevent-recurrence) + * [What happens when the server certificate expires](#what-happens-when-the-server-certificate-expires) + * [Recover the server](#recover-the-server) + * [Obtain a valid certificate](#obtain-a-valid-certificate) + * [Install the new certificate](#install-the-new-certificate) + * [Recover a cluster](#recover-a-cluster) + * [Prevent recurrence](#prevent-recurrence) diff --git a/versioned_docs/version-7.1/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx b/versioned_docs/version-7.1/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx index 13a60d84a2..f14626cbbb 100644 --- a/versioned_docs/version-7.1/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx +++ b/versioned_docs/version-7.1/server/security/authentication/solve-cluster-certificate-renewal-issue.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; your own Let's Encrypt certificates as client certificates, the next certificate renewal may cause permission issues that need to be handled manually. -* Find [whether this issue is relevant for you](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#current-situation) - and if so, [how to handle it](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#solutions). +* Find [whether this issue is relevant for you](#current-situation) + and if so, [how to handle it](#solutions). * **In this page**: - * [Errors Relevant To This Issue](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#errors-relevant-to-this-issue) - * [Background And Current Situation](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#background-and-current-situation) - * [Solutions](../../../server/security/authentication/solve-cluster-certificate-renewal-issue.mdx#solutions) + * [Errors Relevant To This Issue](#errors-relevant-to-this-issue) + * [Background And Current Situation](#background-and-current-situation) + * [Solutions](#solutions) ## Errors Relevant To This Issue diff --git a/versioned_docs/version-7.1/server/security/authorization/security-clearance-and-permissions.mdx b/versioned_docs/version-7.1/server/security/authorization/security-clearance-and-permissions.mdx index 9e08e8607c..db9525bb61 100644 --- a/versioned_docs/version-7.1/server/security/authorization/security-clearance-and-permissions.mdx +++ b/versioned_docs/version-7.1/server/security/authorization/security-clearance-and-permissions.mdx @@ -24,12 +24,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A client certificate's security clearance can be one of the following: Cluster Admin, Operator, User. * In this page: - * [Cluster Admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) - * [Operator](../../../server/security/authorization/security-clearance-and-permissions.mdx#operator) - * [User](../../../server/security/authorization/security-clearance-and-permissions.mdx#user) - * [Admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#section) - * [Read/Write](../../../server/security/authorization/security-clearance-and-permissions.mdx#section-1) - * [Read Only](../../../server/security/authorization/security-clearance-and-permissions.mdx#section-2) + * [Cluster Admin](#cluster-admin) + * [Operator](#operator) + * [User](#user) + * [Admin](#section) + * [Read/Write](#section-1) + * [Read Only](#section-2) ## Cluster Admin diff --git a/versioned_docs/version-7.1/server/security/common-errors-and-faq.mdx b/versioned_docs/version-7.1/server/security/common-errors-and-faq.mdx index e954648ef5..5794d23485 100644 --- a/versioned_docs/version-7.1/server/security/common-errors-and-faq.mdx +++ b/versioned_docs/version-7.1/server/security/common-errors-and-faq.mdx @@ -17,20 +17,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This article explains some of the common security configuration errors and how to handle them. * In this page - * [Setup Wizard Issues](../../server/security/common-errors-and-faq.mdx#setup-wizard-issues) - * [Changing Configurations and Renewals Issues](../../server/security/common-errors-and-faq.mdx#changing-configurations-and-renewals-issues) - * [Authentication Issues](../../server/security/common-errors-and-faq.mdx#authentication-issues) - * [Encryption Issues](../../server/security/common-errors-and-faq.mdx#encryption-issues) + * [Setup Wizard Issues](#setup-wizard-issues) + * [Changing Configurations and Renewals Issues](#changing-configurations-and-renewals-issues) + * [Authentication Issues](#authentication-issues) + * [Encryption Issues](#encryption-issues) ## Setup Wizard Issues -* [Server cannot bind to the provided private IP address](../../server/security/common-errors-and-faq.mdx#server-cannot-bind-to-the-provided-private-ip-address) -* [Ports are blocked by the firewall](../../server/security/common-errors-and-faq.mdx#ports-are-blocked-by-the-firewall) -* [DNS is cached locally](../../server/security/common-errors-and-faq.mdx#dns-is-cached-locally) -* [Long DNS propagation time](../../server/security/common-errors-and-faq.mdx#long-dns-propagation-time) -* [If I already have the Zip file, can I avoid repeating the setup process?](../../server/security/common-errors-and-faq.mdx#if-i-already-have-the-zip-file-can-i-avoid-repeating-the-setup-process) +* [Server cannot bind to the provided private IP address](#server-cannot-bind-to-the-provided-private-ip-address) +* [Ports are blocked by the firewall](#ports-are-blocked-by-the-firewall) +* [DNS is cached locally](#dns-is-cached-locally) +* [Long DNS propagation time](#long-dns-propagation-time) +* [If I already have the Zip file, can I avoid repeating the setup process?](#if-i-already-have-the-zip-file-can-i-avoid-repeating-the-setup-process) ### Server cannot bind to the provided private IP address If the IP/port is not accessible on your machine, you'll get the following error. @@ -130,12 +130,12 @@ When building a cluster, repeat this step with nodes B, C, and so on. ## Changing Configurations and Renewals Issues -* [After installing with Let's Encrypt, can I change the DNS records?](../../server/security/common-errors-and-faq.mdx#after-installing-with-lets-encrypt-can-i-change-the-dns-records) -* [Can I change the (private) IP address RavenDB binds to?](../../server/security/common-errors-and-faq.mdx#can-i-change-the-private-ip-address-ravendb-binds-to) -* [The Let's Encrypt certificate is about to expire but doesn't renew automatically](../../server/security/common-errors-and-faq.mdx#the-lets-encrypt-certificate-is-about-to-expire-but-doesnt-renew-automatically) -* [What should I do when my license expires?](../../server/security/common-errors-and-faq.mdx#what-should-i-do-when-my-license-expires) -* [Let's Encrypt certificate permission errors after renewal](../../server/security/common-errors-and-faq.mdx#lets-encrypt-certificate-permission-errors-after-renewal) -* [How do I recover from an expired server certificate?](../../server/security/common-errors-and-faq.mdx#how-do-i-recover-from-an-expired-server-certificate) +* [After installing with Let's Encrypt, can I change the DNS records?](#after-installing-with-lets-encrypt-can-i-change-the-dns-records) +* [Can I change the (private) IP address RavenDB binds to?](#can-i-change-the-private-ip-address-ravendb-binds-to) +* [The Let's Encrypt certificate is about to expire but doesn't renew automatically](#the-lets-encrypt-certificate-is-about-to-expire-but-doesnt-renew-automatically) +* [What should I do when my license expires?](#what-should-i-do-when-my-license-expires) +* [Let's Encrypt certificate permission errors after renewal](#lets-encrypt-certificate-permission-errors-after-renewal) +* [How do I recover from an expired server certificate?](#how-do-i-recover-from-an-expired-server-certificate) ### After installing with Let's Encrypt, can I change the DNS records? Yes. @@ -229,16 +229,16 @@ See [recover from an expired certificate](../../server/security/authentication/r ## Authentication Issues -* [Authentication Error Occurred using Edge](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-edge) -* [Authentication Error Occurred using Chrome](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-chrome) -* [RavenDB is running as a service in Windows and Chrome doesn't use the client certificate from the OS store](../../server/security/common-errors-and-faq.mdx#ravendb-is-running-as-a-service-in-windows-and-chrome-doesnt-use-the-client-certificate-from-the-os-store) -* [Authentication Error Occurred in Firefox](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-in-firefox) -* [Cannot Import the Client Certificate to Firefox](../../server/security/common-errors-and-faq.mdx#cannot-import-the-client-certificate-to-firefox) -* [Getting the full error using PowerShell](../../server/security/common-errors-and-faq.mdx#getting-the-full-error-using-powershell) -* [Not using TLS](../../server/security/common-errors-and-faq.mdx#not-using-tls) -* [How to regain access to a server when you have physical access but no client certificate](../../server/security/common-errors-and-faq.mdx#how-to-regain-access-to-a-server-when-you-have-physical-access-but-no-client-certificate) -* [Certificate is not recognized when setting up on Azure App Services](../../server/security/common-errors-and-faq.mdx#certificate-is-not-recognized-when-setting-up-on-azure-app-services) -* [Automatic cluster certificate renewal following migration to 4.2](../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-42) +* [Authentication Error Occurred using Edge](#authentication-error-occurred-using-edge) +* [Authentication Error Occurred using Chrome](#authentication-error-occurred-using-chrome) +* [RavenDB is running as a service in Windows and Chrome doesn't use the client certificate from the OS store](#ravendb-is-running-as-a-service-in-windows-and-chrome-doesnt-use-the-client-certificate-from-the-os-store) +* [Authentication Error Occurred in Firefox](#authentication-error-occurred-in-firefox) +* [Cannot Import the Client Certificate to Firefox](#cannot-import-the-client-certificate-to-firefox) +* [Getting the full error using PowerShell](#getting-the-full-error-using-powershell) +* [Not using TLS](#not-using-tls) +* [How to regain access to a server when you have physical access but no client certificate](#how-to-regain-access-to-a-server-when-you-have-physical-access-but-no-client-certificate) +* [Certificate is not recognized when setting up on Azure App Services](#certificate-is-not-recognized-when-setting-up-on-azure-app-services) +* [Automatic cluster certificate renewal following migration to 4.2](#automatic-cluster-certificate-renewal-following-migration-to-42) ### Authentication Error Occurred using Edge You cannot access Studio using Edge, though during @@ -340,7 +340,7 @@ looks for the certificate not at the OS root but at the Chrome root store. To solve these issues: Using a user that the service is available for, install or import the certificate PFX -[as described above](../../server/security/common-errors-and-faq.mdx#authentication-error-occurred-using-chrome). +[as described above](#authentication-error-occurred-using-chrome). ### Authentication Error Occurred in Firefox You cannot access the Studio using Firefox even though you have finished the setup wizard successfully and you also checked the box saying "Automatically register the admin client certificate in this (local) OS". diff --git a/versioned_docs/version-7.1/server/security/encryption/encryption-at-rest.mdx b/versioned_docs/version-7.1/server/security/encryption/encryption-at-rest.mdx index ce1bed05c9..0a6e04764f 100644 --- a/versioned_docs/version-7.1/server/security/encryption/encryption-at-rest.mdx +++ b/versioned_docs/version-7.1/server/security/encryption/encryption-at-rest.mdx @@ -32,7 +32,7 @@ As long as the database is idle and there are no requests to serve, everything i Once a request is made, RavenDB will start a transaction (either read or write) and decrypt just the necessary data into memory. Then it will serve the request, and when the transaction is finished, modified pages are encrypted and written back to the datafile. The data is -[locked](../../../server/security/encryption/encryption-at-rest.mdx#locking-memory) during the transaction by default, and it is zeroed when the transaction completes. +[locked](#locking-memory) during the transaction by default, and it is zeroed when the transaction completes. 1. RavenDB makes sure that **no data is written to disk as plain text**. It will always be encrypted. diff --git a/versioned_docs/version-7.1/server/security/encryption/secret-key-management.mdx b/versioned_docs/version-7.1/server/security/encryption/secret-key-management.mdx index f7343c598d..983552b425 100644 --- a/versioned_docs/version-7.1/server/security/encryption/secret-key-management.mdx +++ b/versioned_docs/version-7.1/server/security/encryption/secret-key-management.mdx @@ -20,8 +20,8 @@ If the key is to be encrypted, another key is needed, and so on. In RavenDB this can be handled in one of two ways: -1. [Providing a master key to RavenDB](../../../server/security/encryption/secret-key-management.mdx#providing-a-master-key-to-ravendb) -2. [Relying on the OS protection methods](../../../server/security/encryption/secret-key-management.mdx#relying-on-the-os-protection-methods) +1. [Providing a master key to RavenDB](#providing-a-master-key-to-ravendb) +2. [Relying on the OS protection methods](#relying-on-the-os-protection-methods) ## Providing a Master Key to RavenDB diff --git a/versioned_docs/version-7.1/server/storage/content/_documents-compression-csharp.mdx b/versioned_docs/version-7.1/server/storage/content/_documents-compression-csharp.mdx index 0d136ec0a6..b86d76fac9 100644 --- a/versioned_docs/version-7.1/server/storage/content/_documents-compression-csharp.mdx +++ b/versioned_docs/version-7.1/server/storage/content/_documents-compression-csharp.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; or by updating the database record from the Client API, see below. * In this page: - * [Overview](../../../server/storage/documents-compression.mdx#overview) - * [Compression -vs- Compaction](../../../server/storage/documents-compression.mdx#compression--vs--compaction) - * [Set compression for all collections](../../../server/storage/documents-compression.mdx#set-compression-for-all-collections) - * [Set compression for selected collections](../../../server/storage/documents-compression.mdx#set-compression-for-selected-collections) - * [Syntax](../../../server/storage/documents-compression.mdx#syntax) + * [Overview](#overview) + * [Compression -vs- Compaction](#compression--vs--compaction) + * [Set compression for all collections](#set-compression-for-all-collections) + * [Set compression for selected collections](#set-compression-for-selected-collections) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/server/storage/content/_documents-compression-nodejs.mdx b/versioned_docs/version-7.1/server/storage/content/_documents-compression-nodejs.mdx index 41d6ab887b..d8a9eac073 100644 --- a/versioned_docs/version-7.1/server/storage/content/_documents-compression-nodejs.mdx +++ b/versioned_docs/version-7.1/server/storage/content/_documents-compression-nodejs.mdx @@ -23,11 +23,11 @@ import CodeBlock from '@theme/CodeBlock'; or by updating the database record from the Client API, see below. * In this page: - * [Overview](../../../server/storage/documents-compression.mdx#overview) - * [Compression -vs- Compaction](../../../server/storage/documents-compression.mdx#compression--vs--compaction) - * [Set compression for all collections](../../../server/storage/documents-compression.mdx#set-compression-for-all-collections) - * [Set compression for selected collections](../../../server/storage/documents-compression.mdx#set-compression-for-selected-collections) - * [Syntax](../../../server/storage/documents-compression.mdx#syntax) + * [Overview](#overview) + * [Compression -vs- Compaction](#compression--vs--compaction) + * [Set compression for all collections](#set-compression-for-all-collections) + * [Set compression for selected collections](#set-compression-for-selected-collections) + * [Syntax](#syntax) ## Overview diff --git a/versioned_docs/version-7.1/server/storage/customizing-raven-data-files-locations.mdx b/versioned_docs/version-7.1/server/storage/customizing-raven-data-files-locations.mdx index 744f894d75..896b8b705d 100644 --- a/versioned_docs/version-7.1/server/storage/customizing-raven-data-files-locations.mdx +++ b/versioned_docs/version-7.1/server/storage/customizing-raven-data-files-locations.mdx @@ -21,12 +21,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A script can be used to automate the different location definitions. * In this page: - * [Why store data on different devices](../../server/storage/customizing-raven-data-files-locations.mdx#why-store-data-on-different-devices) - * [Configuring temp files location](../../server/storage/customizing-raven-data-files-locations.mdx#configuring-temp-files-location) - * [Configuring data files location](../../server/storage/customizing-raven-data-files-locations.mdx#configuring-data-files-location) - * [Automate storage definitions](../../server/storage/customizing-raven-data-files-locations.mdx#automate-storage-definitions) - * [Script example - Basic usage](../../server/storage/customizing-raven-data-files-locations.mdx#script-example---basic-usage) - * [Script example - Point Indexes to different location](../../server/storage/customizing-raven-data-files-locations.mdx#script-example---point-indexes-to-different-location) + * [Why store data on different devices](#why-store-data-on-different-devices) + * [Configuring temp files location](#configuring-temp-files-location) + * [Configuring data files location](#configuring-data-files-location) + * [Automate storage definitions](#automate-storage-definitions) + * [Script example - Basic usage](#script-example---basic-usage) + * [Script example - Point Indexes to different location](#script-example---point-indexes-to-different-location) ## Why store data on different devices diff --git a/versioned_docs/version-7.1/server/storage/directory-structure.mdx b/versioned_docs/version-7.1/server/storage/directory-structure.mdx index 53cbeb74ad..6ceb78f212 100644 --- a/versioned_docs/version-7.1/server/storage/directory-structure.mdx +++ b/versioned_docs/version-7.1/server/storage/directory-structure.mdx @@ -17,8 +17,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * RavenDB keeps all data under the location specified by the [DataDir](../../server/configuration/core-configuration.mdx#datadir) configuration value. * In this page: - * [On-disk Data Structure](../../server/storage/directory-structure.mdx#on-disk-data-structure) - * [Voron Storage Environment](../../server/storage/directory-structure.mdx#voron-storage-environment) + * [On-disk Data Structure](#on-disk-data-structure) + * [Voron Storage Environment](#voron-storage-environment) ## On-disk Data Structure diff --git a/versioned_docs/version-7.1/server/storage/storage-engine.mdx b/versioned_docs/version-7.1/server/storage/storage-engine.mdx index 31bb7fdbee..9c995eb003 100644 --- a/versioned_docs/version-7.1/server/storage/storage-engine.mdx +++ b/versioned_docs/version-7.1/server/storage/storage-engine.mdx @@ -26,11 +26,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; Fixed-Sized B+Trees. * In this page: - * [Transaction support](../../server/storage/storage-engine.mdx#transaction-support) - * [Single write model](../../server/storage/storage-engine.mdx#single-write-model) - * [Memory-mapped files](../../server/storage/storage-engine.mdx#memory-mapped-files) - * [Requirements](../../server/storage/storage-engine.mdx#requirements) - * [Limitations](../../server/storage/storage-engine.mdx#limitations) + * [Transaction support](#transaction-support) + * [Single write model](#single-write-model) + * [Memory-mapped files](#memory-mapped-files) + * [Requirements](#requirements) + * [Limitations](#limitations) ## Transaction support diff --git a/versioned_docs/version-7.1/server/tcp-compression.mdx b/versioned_docs/version-7.1/server/tcp-compression.mdx index e413c3af06..993054f875 100644 --- a/versioned_docs/version-7.1/server/tcp-compression.mdx +++ b/versioned_docs/version-7.1/server/tcp-compression.mdx @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [TCP Compression](../server/tcp-compression.mdx#tcp-compression) - * [Compression Algorithm and Ratio](../server/tcp-compression.mdx#compression-algorithm-and-ratio) - * [Enabling TCP Compression](../server/tcp-compression.mdx#enabling-tcp-compression) - * [Disabling TCP Compression](../server/tcp-compression.mdx#disabling-tcp-compression) + * [TCP Compression](#tcp-compression) + * [Compression Algorithm and Ratio](#compression-algorithm-and-ratio) + * [Enabling TCP Compression](#enabling-tcp-compression) + * [Disabling TCP Compression](#disabling-tcp-compression) ## TCP Compression diff --git a/versioned_docs/version-7.1/server/troubleshooting/collect-info.mdx b/versioned_docs/version-7.1/server/troubleshooting/collect-info.mdx index d98d1d7d4a..7589814ec5 100644 --- a/versioned_docs/version-7.1/server/troubleshooting/collect-info.mdx +++ b/versioned_docs/version-7.1/server/troubleshooting/collect-info.mdx @@ -24,12 +24,12 @@ import Panel from '@site/src/components/Panel'; * In this article: - * [Provide incident description](../../server/troubleshooting/collect-info.mdx#provide-incident-description) - * [Create debug package](../../server/troubleshooting/collect-info.mdx#create-debug-package) - * [Enable logs for ongoing issues](../../server/troubleshooting/collect-info.mdx#enable-logs-for-ongoing-issues) - * [Download logs](../../server/troubleshooting/collect-info.mdx#download-logs) - * [Reproduce scenario](../../server/troubleshooting/collect-info.mdx#reproduce-scenario) - * [Create failing test](../../server/troubleshooting/collect-info.mdx#create-failing-test) + * [Provide incident description](#provide-incident-description) + * [Create debug package](#create-debug-package) + * [Enable logs for ongoing issues](#enable-logs-for-ongoing-issues) + * [Download logs](#download-logs) + * [Reproduce scenario](#reproduce-scenario) + * [Create failing test](#create-failing-test) @@ -187,7 +187,7 @@ avoiding potential loss due to the retention configuration. * If the incident is over and you can reproduce it, then first verify logging level is set to '**Debug**'. -* See how to enable the logs in [Enable logs](../../server/troubleshooting/collect-info.mdx#enable-logs-for-ongoing-issues). +* See how to enable the logs in [Enable logs](#enable-logs-for-ongoing-issues). diff --git a/versioned_docs/version-7.1/server/troubleshooting/debug-routes.mdx b/versioned_docs/version-7.1/server/troubleshooting/debug-routes.mdx index f20e90c9c5..c85891dce6 100644 --- a/versioned_docs/version-7.1/server/troubleshooting/debug-routes.mdx +++ b/versioned_docs/version-7.1/server/troubleshooting/debug-routes.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page contains a comprehensive list of endpoints for debugging and testing. * In this page: - * [Debug Endpoints](../../server/troubleshooting/debug-routes.mdx#debug-endpoints) - * [Production Endpoints](../../server/troubleshooting/debug-routes.mdx#production-endpoints) + * [Debug Endpoints](#debug-endpoints) + * [Production Endpoints](#production-endpoints) For the endpoints that begin with `/databases/*/`, replace `*` with the name of your database. diff --git a/versioned_docs/version-7.1/server/troubleshooting/logging.mdx b/versioned_docs/version-7.1/server/troubleshooting/logging.mdx index 8194304cd2..3d219d79fa 100644 --- a/versioned_docs/version-7.1/server/troubleshooting/logging.mdx +++ b/versioned_docs/version-7.1/server/troubleshooting/logging.mdx @@ -17,7 +17,7 @@ import Panel from '@site/src/components/Panel'; * **Multiple logging levels** RavenDB provides a flexible logging system that lets you control the volume and detail of logged information - by selecting the most suitable logging level from a [scale of six](../../server/troubleshooting/logging.mdx#available-logging-levels). + by selecting the most suitable logging level from a [scale of six](#available-logging-levels). For example, the _Trace_ level captures all events, transactions, and database changes, producing logs that can be processed for auditing or detailed analysis, while _Warning_ level limits output to warnings and errors, helping keep logs focused and readable even in large or complex systems. @@ -30,21 +30,21 @@ import Panel from '@site/src/components/Panel'; Logging is asynchronous and is handled by a thread dedicated to the execution of I/O operations, minimizing its effect on server performance. * In this page: - * [Available logging destinations](../../server/troubleshooting/logging.mdx#available-logging-destinations) - * [Logging configuration](../../server/troubleshooting/logging.mdx#logging-configuration) - * [Available logging levels](../../server/troubleshooting/logging.mdx#available-logging-levels) - * [Customizing logging level after Migration](../../server/troubleshooting/logging.mdx#customizing-logging-level-after-migration) - * [Default values](../../server/troubleshooting/logging.mdx#default-values) - * [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) - * [CLI customization: immediate temporary changes](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) - * [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) - * [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#1-configure-ravendb-to-use-an-external-nlog-configuration-file) - * [Configure RavenDB to use NLog plugins for streaming log data](../../server/troubleshooting/logging.mdx#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) - * [Set your NLog configuration file](../../server/troubleshooting/logging.mdx#3-set-your-nlog-configuration-file) - * [An available template](../../server/troubleshooting/logging.mdx#an-available-template) - * [Mandatory `logger` definitions](../../server/troubleshooting/logging.mdx#mandatory-logger-definitions) - * [Your own loggers](../../server/troubleshooting/logging.mdx#your-own-loggers) - * [Studio: the Admin Logs view](../../server/troubleshooting/logging.mdx#studio-the-admin-logs-view) + * [Available logging destinations](#available-logging-destinations) + * [Logging configuration](#logging-configuration) + * [Available logging levels](#available-logging-levels) + * [Customizing logging level after Migration](#customizing-logging-level-after-migration) + * [Default values](#default-values) + * [Microsoft logs](#microsoft-logs) + * [CLI customization: immediate temporary changes](#cli-customization-immediate-temporary-changes) + * [Configuring and using NLog](#configuring-and-using-nlog) + * [Configure RavenDB to use an external NLog configuration file](#1-configure-ravendb-to-use-an-external-nlog-configuration-file) + * [Configure RavenDB to use NLog plugins for streaming log data](#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) + * [Set your NLog configuration file](#3-set-your-nlog-configuration-file) + * [An available template](#an-available-template) + * [Mandatory `logger` definitions](#mandatory-logger-definitions) + * [Your own loggers](#your-own-loggers) + * [Studio: the Admin Logs view](#studio-the-admin-logs-view) @@ -70,11 +70,11 @@ filtering and error handling tools, and a long list of applications that NLog is * Changing logging settings using an external configuration file is possible from version `7.0` on, as part of NLog's integration with RavenDB. * Once an external configuration file is applied, its settings override all the values set by internal configuration keys. - * To set an external configuration file, see [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog). + * To set an external configuration file, see [Configuring and using NLog](#configuring-and-using-nlog). * To **determine whether to use an NLog configuration file or internal configuration keys**, set the [Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logsconfigpath) configuration key with - - - a [path](../../server/troubleshooting/logging.mdx#use-external-config-file) to the configuration file you want to apply + - a [path](#use-external-config-file) to the configuration file you want to apply - or `null` to continue using internal configuration keys. @@ -82,7 +82,7 @@ filtering and error handling tools, and a long list of applications that NLog is * **Permanent changes** to the logging configuration, whether defined via configuration keys or an external configuration file, take effect only after restarting the server. * **Temporary changes** can be applied at runtime, without requiring a server restart, using: - * the [CLI](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) + * the [CLI](#cli-customization-immediate-temporary-changes) * the [Admin Logs view](../../studio/server/debug/admin-logs.mdx) in the Studio * the [`SetLogsConfigurationOperation`](../../client-api/operations/server-wide/logs/set-logs-configuration.mdx) in the Client API @@ -153,7 +153,7 @@ You **will** need to update the logging settings if you want to take advantage o - * To output log data to a destination such as a log aggragation tool using an NLog plugin, you will need to start using an [NLog configuration file](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog), + * To output log data to a destination such as a log aggragation tool using an NLog plugin, you will need to start using an [NLog configuration file](#configuring-and-using-nlog), and then configure any NLog-specific settings, including the logging level, in that file: @@ -179,7 +179,7 @@ You **will** need to update the logging settings if you want to take advantage o * **Default destination** Log entries are written by default to log files in the **Logs** folder on the server machine. To store log files in a different path, set the [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration key. - Learn how to log to additional destinations in [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog). + Learn how to log to additional destinations in [Configuring and using NLog](#configuring-and-using-nlog). * **Default time standard** The default time standard used for log entries is `UTC`. Changing this configuration is now available only using the NLog configuration file. @@ -193,7 +193,7 @@ You **will** need to update the logging settings if you want to take advantage o * **NLog configuration file defaults** - The default values provided for settings in the [NLog configuration file template](../../server/troubleshooting/logging.mdx#an-available-template) + The default values provided for settings in the [NLog configuration file template](#an-available-template) are **identical** to those used by RavenDB's internal configuration keys. See the full list in: [Logging configuration keys and their default values](../../server/configuration/logs-configuration.mdx). @@ -254,9 +254,9 @@ ravendb> log debug To use NLog you need to: -1. [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#use-external-config-file) -2. [Configure RavenDB to use NLog plugins for streaming log data](../../server/troubleshooting/logging.mdx#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) -3. [Set your NLog configuration file](../../server/troubleshooting/logging.mdx#set-nlog-config-file) +1. [Configure RavenDB to use an external NLog configuration file](#use-external-config-file) +2. [Configure RavenDB to use NLog plugins for streaming log data](#2-configure-ravendb-to-use-nlog-plugins-for-streaming-log-data) +3. [Set your NLog configuration file](#set-nlog-config-file) @@ -282,7 +282,7 @@ To use a configuration file named `NLog.config` located in the RavenDB server di * Learn how to set configuration keys [here](../../server/configuration/configuration-options.mdx). -* Learn how to create and modify an Nlog configuration file [below](../../server/troubleshooting/logging.mdx#set-nlog-config-file). +* Learn how to create and modify an Nlog configuration file [below](#set-nlog-config-file). * Note: once a configuration file is used, the logging settings defined in it will _override_ all [internal configuration keys](../../server/configuration/logs-configuration.mdx) values. diff --git a/versioned_docs/version-7.1/server/troubleshooting/traffic-watch.mdx b/versioned_docs/version-7.1/server/troubleshooting/traffic-watch.mdx index bd6e602fdb..0e93a90dd0 100644 --- a/versioned_docs/version-7.1/server/troubleshooting/traffic-watch.mdx +++ b/versioned_docs/version-7.1/server/troubleshooting/traffic-watch.mdx @@ -23,8 +23,8 @@ import Panel from '@site/src/components/Panel'; Both the live stream and log-to-file can be active at the same time. * In this page: - * [Accessing Traffic Watch](../../server/troubleshooting/traffic-watch.mdx#accessing-traffic-watch) - * [Performance impact](../../server/troubleshooting/traffic-watch.mdx#performance-impact) + * [Accessing Traffic Watch](#accessing-traffic-watch) + * [Performance impact](#performance-impact) diff --git a/versioned_docs/version-7.1/sharding/administration/anchoring-documents.mdx b/versioned_docs/version-7.1/sharding/administration/anchoring-documents.mdx index 6fbed78165..1c7c5d1c53 100644 --- a/versioned_docs/version-7.1/sharding/administration/anchoring-documents.mdx +++ b/versioned_docs/version-7.1/sharding/administration/anchoring-documents.mdx @@ -23,10 +23,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To gain control over which specific shard a document will reside in, see [sharding by prefix](../../sharding/administration/sharding-by-prefix.mdx). * In this page: - * [Overview](../../sharding/administration/anchoring-documents.mdx#overview) - * [Anchor multiple documents to the same bucket as a specific document](../../sharding/administration/anchoring-documents.mdx#anchor-multiple-documents-to-the-same-bucket-as-a-specific-document) - * [Anchor multiple documents using a common suffix](../../sharding/administration/anchoring-documents.mdx#anchor-multiple-documents-using-a-common-suffix) - * [Examples](../../sharding/administration/anchoring-documents.mdx#examples) + * [Overview](#overview) + * [Anchor multiple documents to the same bucket as a specific document](#anchor-multiple-documents-to-the-same-bucket-as-a-specific-document) + * [Anchor multiple documents using a common suffix](#anchor-multiple-documents-using-a-common-suffix) + * [Examples](#examples) ## Overview diff --git a/versioned_docs/version-7.1/sharding/administration/api-admin.mdx b/versioned_docs/version-7.1/sharding/administration/api-admin.mdx index 67b441e3eb..cd20e3de53 100644 --- a/versioned_docs/version-7.1/sharding/administration/api-admin.mdx +++ b/versioned_docs/version-7.1/sharding/administration/api-admin.mdx @@ -19,15 +19,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; a sharded database using Studio. * In this page: - * [Creating a Sharded Database](../../sharding/administration/api-admin.mdx#creating-a-sharded-database) - * [Orchestrator Administration](../../sharding/administration/api-admin.mdx#orchestrator-administration) - * [Adding an Orchestrator](../../sharding/administration/api-admin.mdx#adding-an-orchestrator) - * [Removing an Orchestrator](../../sharding/administration/api-admin.mdx#removing-an-orchestrator) - * [Shard Administration](../../sharding/administration/api-admin.mdx#shard-administration) - * [Adding a Shard](../../sharding/administration/api-admin.mdx#adding-a-shard) - * [Adding a Shard Replica](../../sharding/administration/api-admin.mdx#adding-a-shard-replica) - * [Promoting a Shard Replica](../../sharding/administration/api-admin.mdx#promoting-a-shard-replica) - * [Removing a Shard](../../sharding/administration/api-admin.mdx#removing-a-shard) + * [Creating a Sharded Database](#creating-a-sharded-database) + * [Orchestrator Administration](#orchestrator-administration) + * [Adding an Orchestrator](#adding-an-orchestrator) + * [Removing an Orchestrator](#removing-an-orchestrator) + * [Shard Administration](#shard-administration) + * [Adding a Shard](#adding-a-shard) + * [Adding a Shard Replica](#adding-a-shard-replica) + * [Promoting a Shard Replica](#promoting-a-shard-replica) + * [Removing a Shard](#removing-a-shard) ## Creating a Sharded Database diff --git a/versioned_docs/version-7.1/sharding/administration/sharding-by-prefix.mdx b/versioned_docs/version-7.1/sharding/administration/sharding-by-prefix.mdx index a7a9b70edc..d6480901b9 100644 --- a/versioned_docs/version-7.1/sharding/administration/sharding-by-prefix.mdx +++ b/versioned_docs/version-7.1/sharding/administration/sharding-by-prefix.mdx @@ -24,20 +24,20 @@ import LanguageContent from "@site/src/components/LanguageContent"; * With prefixed sharding, you only control the shard where a document is stored. You cannot control the specific bucket within that shard where the document will reside. This can be partially addressed by [anchoring documents](../../sharding/administration/anchoring-documents.mdx) to a bucket. - Learn more [below](../../sharding/administration/sharding-by-prefix.mdx#prefixed-sharding-vs-anchoring-documents). + Learn more [below](#prefixed-sharding-vs-anchoring-documents). * In this page: - * [Why use prefixed sharding](../../sharding/administration/sharding-by-prefix.mdx#why-use-prefixed-sharding) - * [Overview](../../sharding/administration/sharding-by-prefix.mdx#overview) - * [Bucket management](../../sharding/administration/sharding-by-prefix.mdx#bucket-management) - * [Adding prefixes via Studio](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-studio) - * [Adding prefixes via Client API](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-client-api) - * [Add prefixes when creating a database](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-when-creating-a-database) - * [Add prefixes after database creation](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-after-database-creation) - * [Removing prefixes](../../sharding/administration/sharding-by-prefix.mdx#removing-prefixes) - * [Updating shard configurations for prefixes](../../sharding/administration/sharding-by-prefix.mdx#updating-shard-configurations-for-prefixes) - * [Querying selected shards by prefix](../../sharding/administration/sharding-by-prefix.mdx#querying-selected-shards-by-prefix) - * [Prefixed sharding vs Anchoring documents](../../sharding/administration/sharding-by-prefix.mdx#prefixed-sharding-vs-anchoring-documents) + * [Why use prefixed sharding](#why-use-prefixed-sharding) + * [Overview](#overview) + * [Bucket management](#bucket-management) + * [Adding prefixes via Studio](#adding-prefixes-via-studio) + * [Adding prefixes via Client API](#adding-prefixes-via-client-api) + * [Add prefixes when creating a database](#add-prefixes-when-creating-a-database) + * [Add prefixes after database creation](#add-prefixes-after-database-creation) + * [Removing prefixes](#removing-prefixes) + * [Updating shard configurations for prefixes](#updating-shard-configurations-for-prefixes) + * [Querying selected shards by prefix](#querying-selected-shards-by-prefix) + * [Prefixed sharding vs Anchoring documents](#prefixed-sharding-vs-anchoring-documents) ## Why use prefixed sharding @@ -71,7 +71,7 @@ reduces network latency for region-specific operations, and enhances overall sys * To store documents on a specific shard, define the target shard for each document ID prefix that you add. Documents with IDs matching any of the defined prefixes will be routed to the corresponding shard. - Learn how to [add prefixes](../../sharding/administration/sharding-by-prefix.mdx#adding-prefixes-via-client-api) below. + Learn how to [add prefixes](#adding-prefixes-via-client-api) below. * For example, you can define that all documents with an ID starting with `users/us/` will be stored in shard **#0**. Consequently, the following sample documents will be stored in shard **#0**: @@ -392,7 +392,7 @@ await store.Maintenance.SendAsync(deletePrefixOp); * **When removing a shard from an existing prefix configuration**, you must first manually move the buckets from the removed shard to the other shards that are assigned to this prefix. -* In the below example, in addition to shard **#2** that was configured in the [previous](../../sharding/administration/sharding-by-prefix.mdx#add-prefixes-after-database-creation) example, +* In the below example, in addition to shard **#2** that was configured in the [previous](#add-prefixes-after-database-creation) example, we are adding shard **#0** as a destination for documents with prefix `users/eu/`. diff --git a/versioned_docs/version-7.1/sharding/administration/studio-admin.mdx b/versioned_docs/version-7.1/sharding/administration/studio-admin.mdx index 216a30ab7f..93c9f5ae2d 100644 --- a/versioned_docs/version-7.1/sharding/administration/studio-admin.mdx +++ b/versioned_docs/version-7.1/sharding/administration/studio-admin.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; a sharded database using API commands. * In this page: - * [Creating a sharded database](../../sharding/administration/studio-admin.mdx#creating-a-sharded-database) - * [Database View](../../sharding/administration/studio-admin.mdx#database-view) - * [Database Group](../../sharding/administration/studio-admin.mdx#database-group) + * [Creating a sharded database](#creating-a-sharded-database) + * [Database View](#database-view) + * [Database Group](#database-group) ## Creating a sharded database @@ -100,7 +100,7 @@ be available here: 6. **Backups view** Click to manage [backup tasks](../../studio/database/tasks/backup-task.mdx) and restore existing backups. 7. **Manage group** - Click to manage the database group ([see below](../../sharding/administration/studio-admin.mdx#database-group)). + Click to manage the database group ([see below](#database-group)). diff --git a/versioned_docs/version-7.1/sharding/backup-and-restore/backup.mdx b/versioned_docs/version-7.1/sharding/backup-and-restore/backup.mdx index a5088000f7..e55bdb7994 100644 --- a/versioned_docs/version-7.1/sharding/backup-and-restore/backup.mdx +++ b/versioned_docs/version-7.1/sharding/backup-and-restore/backup.mdx @@ -36,16 +36,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; backup **can** be created for a sharded database. * In this page: - * [Backup](../../sharding/backup-and-restore/backup.mdx#backup) - * [Sharded and Non-Sharded Backup Tasks](../../sharding/backup-and-restore/backup.mdx#sharded-and-non-sharded-backup-tasks) - * [Backup Storage: Local and Remote](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) - * [Backup Files Extension and Structure](../../sharding/backup-and-restore/backup.mdx#backup-files-extension-and-structure) - * [Backup Type](../../sharding/backup-and-restore/backup.mdx#backup-type) - * [Backup Scope](../../sharding/backup-and-restore/backup.mdx#backup-scope) - * [Naming Convention](../../sharding/backup-and-restore/backup.mdx#naming-convention) - * [Server-Wide Backup](../../sharding/backup-and-restore/backup.mdx#server-wide-backup) - * [Example](../../sharding/backup-and-restore/backup.mdx#example) - * [Backup Options Summary](../../sharding/backup-and-restore/backup.mdx#backup-options-summary) + * [Backup](#backup) + * [Sharded and Non-Sharded Backup Tasks](#sharded-and-non-sharded-backup-tasks) + * [Backup Storage: Local and Remote](#backup-storage-local-and-remote) + * [Backup Files Extension and Structure](#backup-files-extension-and-structure) + * [Backup Type](#backup-type) + * [Backup Scope](#backup-scope) + * [Naming Convention](#naming-convention) + * [Server-Wide Backup](#server-wide-backup) + * [Example](#example) + * [Backup Options Summary](#backup-options-summary) ## Backup @@ -98,7 +98,7 @@ manageable proportions no matter what the overall database size is. ## Backup Storage: Local and Remote Backup files can be stored locally and remotely. -Find a code example [here](../../sharding/backup-and-restore/backup.mdx#example). +Find a code example [here](#example). * **Local Backup** A shard's backup task may keep backup data locally, @@ -243,14 +243,14 @@ This type is specific to a sharded database, and casting it using a non-sharded | Option | Available on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | | Store backup files created by shards in **local shard machine storage** | **Yes** | Shards can store the backups they create locally. | -| Store backup files of sharded databases [remotely](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Shards can store the backups they create on remote S3, Azure, or Google Cloud destinations. | +| Store backup files of sharded databases [remotely](#backup-storage-local-and-remote) | **Yes** | Shards can store the backups they create on remote S3, Azure, or Google Cloud destinations. | | Create [Full](../../server/ongoing-tasks/backup-overview.mdx#full-backup) backups for sharded databases | **Yes** | | | Create [Incremental](../../server/ongoing-tasks/backup-overview.mdx#incremental-backup) backups for sharded databases | **Yes** | | | Create [Logical](../../server/ongoing-tasks/backup-overview.mdx#logical-backup) backups for sharded databases | **Yes** | | | Create [Snapshot](../../server/ongoing-tasks/backup-overview.mdx#snapshot) backups for sharded databases | **No** | Snapshot backups CANNOT be created for (nor restored to) sharded databases. | | Create **periodic backup tasks** for sharded databases | **Yes** | | | Run a manual [one-time](../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups) backup operation on a sharded database | **Yes** | | -| Include sharded databases in a [server-wide backup operation](../../sharding/backup-and-restore/backup.mdx#server-wide-backup) | **Yes (logical only)** | A server-wide **logical** backup includes all databases, including sharded ones. Sharded databases are automatically **excluded** from server-wide **snapshot** backups. | +| Include sharded databases in a [server-wide backup operation](#server-wide-backup) | **Yes (logical only)** | A server-wide **logical** backup includes all databases, including sharded ones. Sharded databases are automatically **excluded** from server-wide **snapshot** backups. | diff --git a/versioned_docs/version-7.1/sharding/backup-and-restore/restore.mdx b/versioned_docs/version-7.1/sharding/backup-and-restore/restore.mdx index 26d4d7115f..7f41c07f3d 100644 --- a/versioned_docs/version-7.1/sharding/backup-and-restore/restore.mdx +++ b/versioned_docs/version-7.1/sharding/backup-and-restore/restore.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; can retrieve and restore them. Shards must be restored in their - [original order](../../sharding/backup-and-restore/restore.mdx#restore). + [original order](#restore). The backup of shard 1, for example, must be restored as shard 1. * Backup files can be restored from local shard node storage or from @@ -40,14 +40,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; as a sharded database. * In this page: - * [Restore](../../sharding/backup-and-restore/restore.mdx#restore) - * [Set Paths to Backup Files Locations](../../sharding/backup-and-restore/restore.mdx#set-paths-to-backup-files-locations) - * [Define a Restore Configuration](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration) - * [`RestoreBackupConfigurationBase`](../../sharding/backup-and-restore/restore.mdx#section) - * [Run `RestoreBackupOperation` with the Restore Configuration](../../sharding/backup-and-restore/restore.mdx#run--with-the-restore-configuration) - * [Examples](../../sharding/backup-and-restore/restore.mdx#examples) - * [Restoring to a Selected Restore Point](../../sharding/backup-and-restore/restore.mdx#restoring-to-a-selected-restore-point) - * [Restore Options Summary](../../sharding/backup-and-restore/restore.mdx#restore-options-summary) + * [Restore](#restore) + * [Set Paths to Backup Files Locations](#set-paths-to-backup-files-locations) + * [Define a Restore Configuration](#define-a-restore-configuration) + * [`RestoreBackupConfigurationBase`](#section) + * [Run `RestoreBackupOperation` with the Restore Configuration](#run--with-the-restore-configuration) + * [Examples](#examples) + * [Restoring to a Selected Restore Point](#restoring-to-a-selected-restore-point) + * [Restore Options Summary](#restore-options-summary) ## Restore @@ -116,7 +116,7 @@ To restore the database, we pass the a **configuration object**. * The configuration object inherits properties from the `RestoreBackupConfigurationBase` class - ([discussed below](../../sharding/backup-and-restore/restore.mdx#section)) + ([discussed below](#section)) and defines additional sharding-specific settings. * We choose what configuration object to pass the restore operation, by @@ -126,10 +126,10 @@ a **configuration object**. | Configuration Object | Backup Location | Additional Properties | | -------------------- | --------------- | --------------------- | - | `RestoreBackupConfiguration` | Local shard storage | None (see [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromS3Configuration` | AWS S3 Bucket | `S3Settings` (see S3 [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromAzureConfiguration` | MS Azure Blob | `AzureSettings` (see Azure [example](../../sharding/backup-and-restore/restore.mdx#examples)) | - | `RestoreFromGoogleCloudConfiguration` | Google Cloud Bucket | `GoogleCloudSettings` (see Google Cloud [example](../../sharding/backup-and-restore/restore.mdx#examples)) | + | `RestoreBackupConfiguration` | Local shard storage | None (see [example](#examples)) | + | `RestoreFromS3Configuration` | AWS S3 Bucket | `S3Settings` (see S3 [example](#examples)) | + | `RestoreFromAzureConfiguration` | MS Azure Blob | `AzureSettings` (see Azure [example](#examples)) | + | `RestoreFromGoogleCloudConfiguration` | Google Cloud Bucket | `GoogleCloudSettings` (see Google Cloud [example](#examples)) | ### `RestoreBackupConfigurationBase` `RestoreBackupConfigurationBase` is a parent class to all the configuration types mentioned above, allowing you to set backups **encryption settings** among other options. @@ -187,7 +187,7 @@ to restore the database. * Instead of `RestoreBackupConfigurationBase`, use the configuration object - you [prepared](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration): + you [prepared](#define-a-restore-configuration): * `RestoreBackupConfiguration` for locally-stored backups * `RestoreFromS3Configuration` to restore from S3 * `RestoreFromAzureConfiguration` to restore from Azure @@ -614,7 +614,7 @@ var operation = await docStore.Maintenance.Server.SendAsync(restoreBackupOperati | Option | Supported on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | | Restore from **local shard storage** | **Yes** | | -| Restore from a [remote location](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Define a [restore configuration](../../sharding/backup-and-restore/restore.mdx#define-a-restore-configuration) with S3, Azure, or Google Cloud settings. | +| Restore from a [remote location](../../sharding/backup-and-restore/backup.mdx#backup-storage-local-and-remote) | **Yes** | Define a [restore configuration](#define-a-restore-configuration) with S3, Azure, or Google Cloud settings. | | Restore a **sharded database** backup
to a **sharded database** | **Yes** | | | Restore a **sharded database** backup
to a **non-sharded database** | **Yes** | | | Restore a **non-sharded database** backup
to a **sharded database** | **No** | A backup created for a non-sharded database CANNOT be restored to a sharded database. | diff --git a/versioned_docs/version-7.1/sharding/configuration.mdx b/versioned_docs/version-7.1/sharding/configuration.mdx index a74065efc8..9af46c56de 100644 --- a/versioned_docs/version-7.1/sharding/configuration.mdx +++ b/versioned_docs/version-7.1/sharding/configuration.mdx @@ -21,10 +21,10 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn how to apply configuration options in [Configuration Overview](../server/configuration/configuration-options.mdx). * In this article: - * [Sharding.Import.CompressionLevel](../sharding/configuration.mdx#shardingimportcompressionlevel) - * [Sharding.OrchestratorTimeoutInMin](../sharding/configuration.mdx#shardingorchestratortimeoutinmin) - * [Sharding.ShardExecutor.UseHttpCompression](../sharding/configuration.mdx#shardingshardexecutorusehttpcompression) - * [Sharding.ShardExecutor.UseHttpDecompression](../sharding/configuration.mdx#shardingshardexecutorusehttpdecompression) + * [Sharding.Import.CompressionLevel](#shardingimportcompressionlevel) + * [Sharding.OrchestratorTimeoutInMin](#shardingorchestratortimeoutinmin) + * [Sharding.ShardExecutor.UseHttpCompression](#shardingshardexecutorusehttpcompression) + * [Sharding.ShardExecutor.UseHttpDecompression](#shardingshardexecutorusehttpdecompression) diff --git a/versioned_docs/version-7.1/sharding/document-extensions.mdx b/versioned_docs/version-7.1/sharding/document-extensions.mdx index 03604a127f..42f3477647 100644 --- a/versioned_docs/version-7.1/sharding/document-extensions.mdx +++ b/versioned_docs/version-7.1/sharding/document-extensions.mdx @@ -33,10 +33,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; along with it to the new shard. * In this page: - * [Document Extensions and Resharding](../sharding/document-extensions.mdx#document-extensions-and-resharding) - * [Precautions and Recommendations](../sharding/document-extensions.mdx#precautions-and-recommendations) - * [Precautions](../sharding/document-extensions.mdx#precautions) - * [Recommendations](../sharding/document-extensions.mdx#recommendations) + * [Document Extensions and Resharding](#document-extensions-and-resharding) + * [Precautions and Recommendations](#precautions-and-recommendations) + * [Precautions](#precautions) + * [Recommendations](#recommendations) ## Document Extensions and Resharding diff --git a/versioned_docs/version-7.1/sharding/etl.mdx b/versioned_docs/version-7.1/sharding/etl.mdx index 6d4c7fa819..a8b252e45d 100644 --- a/versioned_docs/version-7.1/sharding/etl.mdx +++ b/versioned_docs/version-7.1/sharding/etl.mdx @@ -24,17 +24,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; its own local ETL task, based on the user's settings. * Resharding may result in the transfer of some documents more than once to the ETL destination. It is the user's responsibility to - [detect and handle](../sharding/etl.mdx#etl-and-resharding) such duplicates. -* ETL tasks information is available [per database and per shard](../sharding/etl.mdx#retrieving-shard-specific-etl-task-info). + [detect and handle](#etl-and-resharding) such duplicates. +* ETL tasks information is available [per database and per shard](#retrieving-shard-specific-etl-task-info). * In this page: - * [ETL](../sharding/etl.mdx#etl) - * [Sharded and Non-Sharded ETL Tasks](../sharding/etl.mdx#sharded-and-non-sharded-etl-tasks) - * [Non-Sharded Database ETL Tasks](../sharding/etl.mdx#non-sharded-database-etl-tasks) - * [Sharded Database ETL Tasks](../sharding/etl.mdx#sharded-database-etl-tasks) - * [ETL and Resharding](../sharding/etl.mdx#etl-and-resharding) - * [ETL Queries](../sharding/etl.mdx#etl-queries) - * [Retrieving Shard-Specific ETL Task Info](../sharding/etl.mdx#retrieving-shard-specific-etl-task-info) + * [ETL](#etl) + * [Sharded and Non-Sharded ETL Tasks](#sharded-and-non-sharded-etl-tasks) + * [Non-Sharded Database ETL Tasks](#non-sharded-database-etl-tasks) + * [Sharded Database ETL Tasks](#sharded-database-etl-tasks) + * [ETL and Resharding](#etl-and-resharding) + * [ETL Queries](#etl-queries) + * [Retrieving Shard-Specific ETL Task Info](#retrieving-shard-specific-etl-task-info) ## ETL diff --git a/versioned_docs/version-7.1/sharding/external-replication.mdx b/versioned_docs/version-7.1/sharding/external-replication.mdx index 90e8c80962..4263b99870 100644 --- a/versioned_docs/version-7.1/sharding/external-replication.mdx +++ b/versioned_docs/version-7.1/sharding/external-replication.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; their version is at least 6.0. * In this page: - * [Supported Versions](../sharding/external-replication.mdx#supported-versions) - * [External Replication Types](../sharding/external-replication.mdx#external-replication-types) - * [Non-Sharded Database to Sharded Database](../sharding/external-replication.mdx#non-sharded-database-to-sharded-database) - * [Sharded Database to Sharded Database](../sharding/external-replication.mdx#sharded-database-to-sharded-database) - * [Performance Considerations](../sharding/external-replication.mdx#performance-considerations) + * [Supported Versions](#supported-versions) + * [External Replication Types](#external-replication-types) + * [Non-Sharded Database to Sharded Database](#non-sharded-database-to-sharded-database) + * [Sharded Database to Sharded Database](#sharded-database-to-sharded-database) + * [Performance Considerations](#performance-considerations) ## Supported Versions diff --git a/versioned_docs/version-7.1/sharding/import-and-export.mdx b/versioned_docs/version-7.1/sharding/import-and-export.mdx index 07d9b1faa2..467705103f 100644 --- a/versioned_docs/version-7.1/sharding/import-and-export.mdx +++ b/versioned_docs/version-7.1/sharding/import-and-export.mdx @@ -34,9 +34,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Behind the scenes, Studio uses Smuggler to perform these operations. * In this page: - * [Export](../sharding/import-and-export.mdx#export) - * [Import](../sharding/import-and-export.mdx#import) - * [Export and Import Options Summary](../sharding/import-and-export.mdx#export-and-import-options-summary) + * [Export](#export) + * [Import](#import) + * [Export and Import Options Summary](#export-and-import-options-summary) ## Export @@ -67,7 +67,7 @@ and casting it using a non-sharded type [will fail](../migration/client-api/clie ## Import Smuggler can be used to [import](../client-api/smuggler/what-is-smuggler.mdx#import) -data into a database from either a [.ravendbdump](../sharding/import-and-export.mdx#export) +data into a database from either a [.ravendbdump](#export) file or from backup files (full or incremental). When data is imported into a sharded database one of the shard nodes @@ -133,7 +133,7 @@ Import the full backup first, and then the incremental backups that complement i | Option | Available on a Sharded Database | Comment | | -------------------- | --------------- | --------------------- | -| Export and Import [.ravendbdump](../sharding/import-and-export.mdx#export) files using [Smuggler](../client-api/smuggler/what-is-smuggler.mdx) | **Yes** | Smuggler behaves just like it does on non-sharded databases. | +| Export and Import [.ravendbdump](#export) files using [Smuggler](../client-api/smuggler/what-is-smuggler.mdx) | **Yes** | Smuggler behaves just like it does on non-sharded databases. | | [Export](../studio/database/tasks/export-database.mdx) and [import](../studio/database/tasks/import-data/import-data-file.mdx) sharded database data using Studio | **Yes** | Behind the scenes, Studio uses Smuggler. | | Export to **client machine** | **Yes** | | | Export to **local shard node storage** | **No** | | diff --git a/versioned_docs/version-7.1/sharding/indexing.mdx b/versioned_docs/version-7.1/sharding/indexing.mdx index 679365dc1a..12fa83f8f6 100644 --- a/versioned_docs/version-7.1/sharding/indexing.mdx +++ b/versioned_docs/version-7.1/sharding/indexing.mdx @@ -22,9 +22,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; Unsupported features are listed below. * In this article: - * [Indexing in a sharded database](../sharding/indexing.mdx#indexing-in-a-sharded-database) - * [Map-Reduce indexes in a sharded database](../sharding/indexing.mdx#map-reduce-indexes-in-a-sharded-database) - * [Unsupported indexing features](../sharding/indexing.mdx#unsupported-indexing-features) + * [Indexing in a sharded database](#indexing-in-a-sharded-database) + * [Map-Reduce indexes in a sharded database](#map-reduce-indexes-in-a-sharded-database) + * [Unsupported indexing features](#unsupported-indexing-features) diff --git a/versioned_docs/version-7.1/sharding/migration.mdx b/versioned_docs/version-7.1/sharding/migration.mdx index 9f25b5d210..e7a0a622dc 100644 --- a/versioned_docs/version-7.1/sharding/migration.mdx +++ b/versioned_docs/version-7.1/sharding/migration.mdx @@ -31,9 +31,9 @@ database to the new one in several ways. of the replica. * In this page: - * [Export & Import](../sharding/migration.mdx#export--import) - * [Backup](../sharding/migration.mdx#backup) - * [External Replication](../sharding/migration.mdx#external-replication) + * [Export & Import](#export--import) + * [Backup](#backup) + * [External Replication](#external-replication) ## Export & Import diff --git a/versioned_docs/version-7.1/sharding/overview.mdx b/versioned_docs/version-7.1/sharding/overview.mdx index 7b95f92ad2..dfe5381ac1 100644 --- a/versioned_docs/version-7.1/sharding/overview.mdx +++ b/versioned_docs/version-7.1/sharding/overview.mdx @@ -24,21 +24,21 @@ import LanguageContent from "@site/src/components/LanguageContent"; (e.g., a 10-terabyte DB). * In this page: - * [Sharding](../sharding/overview.mdx#sharding) - * [Licensing](../sharding/overview.mdx#licensing) - * [Client compatibility](../sharding/overview.mdx#client-compatibility) - * [Client-Server communication](../sharding/overview.mdx#client-server-communication) - * [When should sharding be used?](../sharding/overview.mdx#when-should-sharding-be-used) - * [Shards](../sharding/overview.mdx#shards) - * [Shard replication](../sharding/overview.mdx#shard-replication) - * [How documents are distributed among shards](../sharding/overview.mdx#how-documents-are-distributed-among-shards) - * [Buckets allocation](../sharding/overview.mdx#buckets-allocation) - * [Buckets population](../sharding/overview.mdx#buckets-population) - * [Document extensions storage](../sharding/overview.mdx#document-extensions-storage) - * [Resharding](../sharding/overview.mdx#resharding) - * [Paging](../sharding/overview.mdx#paging) - * [Using local IP addresses](../sharding/overview.mdx#using-local-ip-addresses) - * [Creating a sharded database](../sharding/overview.mdx#creating-a-sharded-database) + * [Sharding](#sharding) + * [Licensing](#licensing) + * [Client compatibility](#client-compatibility) + * [Client-Server communication](#client-server-communication) + * [When should sharding be used?](#when-should-sharding-be-used) + * [Shards](#shards) + * [Shard replication](#shard-replication) + * [How documents are distributed among shards](#how-documents-are-distributed-among-shards) + * [Buckets allocation](#buckets-allocation) + * [Buckets population](#buckets-population) + * [Document extensions storage](#document-extensions-storage) + * [Resharding](#resharding) + * [Paging](#paging) + * [Using local IP addresses](#using-local-ip-addresses) + * [Creating a sharded database](#creating-a-sharded-database) ## Sharding @@ -47,7 +47,7 @@ As a database grows [very large](https://en.wikipedia.org/wiki/Very_large_databa System performance may suffer as resources like RAM, CPU, and storage are exhausted, routine chores like indexing and backup become massive tasks, responsiveness to client requests and queries slows down, and the system's throughput spreads thin serving an ever-growing number of clients. -With sharding, as the volume of stored data grows, the database can be scaled out by splitting it into [shards](../sharding/overview.mdx#shards). +With sharding, as the volume of stored data grows, the database can be scaled out by splitting it into [shards](#shards). This allows the database to be managed by multiple nodes and effectively removes most limits on its growth. In this manner, the size of the overall database, comprised of all shards, can reach dozens of terabytes and more, while keeping the resources of each shard in check and maintaining high performance and throughput. @@ -121,7 +121,7 @@ Take a 3-shard database, in which shard **1** is populated with documents `Users shard **2** contains documents `Users/2001`..`Users/4000`, and shard **3** contains `Users/4001`..`Users/6000`. A client that connects to this database to retrieve `Users/3000` and `Users/5000` would be served by an -automatically-appointed [orchestrator node](../sharding/overview.mdx#client-server-communication) +automatically-appointed [orchestrator node](#client-server-communication) that would seamlessly retrieve `Users/3000` from shard **2** and `Users/5000` from shard **3** and hand them to the client. diff --git a/versioned_docs/version-7.1/sharding/querying.mdx b/versioned_docs/version-7.1/sharding/querying.mdx index ca59ca872e..ccdc4ebbb0 100644 --- a/versioned_docs/version-7.1/sharding/querying.mdx +++ b/versioned_docs/version-7.1/sharding/querying.mdx @@ -19,23 +19,23 @@ import ContentFrame from "@site/src/components/ContentFrame"; so queries written for a non-sharded database can usually be used without modification. * Some querying features are not yet implemented. - Others, such as [filter](../sharding/querying.mdx#filter), behave a little differently in a sharded database. + Others, such as [filter](#filter), behave a little differently in a sharded database. These cases are described below. * In this article: - * [Querying a sharded database](../sharding/querying.mdx#querying-a-sharded-database) - * [Querying selected shards](../sharding/querying.mdx#querying-selected-shards) - * [Including items in a query](../sharding/querying.mdx#including-items-in-a-query) - * [Paging query results](../sharding/querying.mdx#paging-query-results) - * [Streaming query results](../sharding/querying.mdx#streaming-query-results) - * [Filtering query results](../sharding/querying.mdx#filtering-query-results) - * [`where`](../sharding/querying.mdx#where) - * [`filter`](../sharding/querying.mdx#filter) - * [`where` vs `filter` recommendations](../sharding/querying.mdx#wherevsfilterrecommendations) - * [Loading a document within a projection](../sharding/querying.mdx#loading-a-document-within-a-projection) - * [`order by` and `limit` in a Map-Reduce query](../sharding/querying.mdx#order-by-and-limit-in-a-map-reduce-query) - * [Timing queries](../sharding/querying.mdx#timing-queries) - * [Unsupported querying features](../sharding/querying.mdx#unsupported-querying-features) + * [Querying a sharded database](#querying-a-sharded-database) + * [Querying selected shards](#querying-selected-shards) + * [Including items in a query](#including-items-in-a-query) + * [Paging query results](#paging-query-results) + * [Streaming query results](#streaming-query-results) + * [Filtering query results](#filtering-query-results) + * [`where`](#where) + * [`filter`](#filter) + * [`where` vs `filter` recommendations](#wherevsfilterrecommendations) + * [Loading a document within a projection](#loading-a-document-within-a-projection) + * [`order by` and `limit` in a Map-Reduce query](#order-by-and-limit-in-a-map-reduce-query) + * [Timing queries](#timing-queries) + * [Unsupported querying features](#unsupported-querying-features) @@ -277,7 +277,7 @@ where Name == "Joe" * Although includes are supported in regular sharded queries, they are **not** supported when query results are **streamed**. - Learn more in [Streaming query results](../sharding/querying.mdx#streaming-query-results). + Learn more in [Streaming query results](#streaming-query-results). @@ -519,7 +519,7 @@ Both static index queries and dynamic queries (auto-indexes) are supported. -Data can be filtered using the [where](../sharding/querying.mdx#where) and [filter](../sharding/querying.mdx#filter) keywords on both non-sharded and sharded databases. +Data can be filtered using the [where](#where) and [filter](#filter) keywords on both non-sharded and sharded databases. However, in a sharded database, **when filtering results from a Map-Reduce index query or a dynamic aggregation query**, these commands behave differently. @@ -556,11 +556,11 @@ The server uses it to retrieve only items that match the specified conditions. * Each shard evaluates the `where` condition using only the data stored on that shard. * If a product was sold 4000 times on each shard, the query shown above will filter it out on every shard — even though its total sales across the database far exceed 5000. - * To address this, use the [filter](../sharding/querying.mdx#filter) keyword instead, + * To address this, use the [filter](#filter) keyword instead, whose behavior on sharded databases is designed for exactly this case. * Note: using `where` does **not** cause this problem when filtering on a `GroupBy` field (the reduce-key), and is actually the recommended approach in that case. - Learn more in [`where` vs `filter` recommendations](../sharding/querying.mdx#wherevsfilterrecommendations) below. + Learn more in [`where` vs `filter` recommendations](#wherevsfilterrecommendations) below. @@ -949,13 +949,13 @@ Querying features that are not supported or not yet implemented in sharded datab will throw a `NotSupportedInShardingException`. * **Loading a document within a Map-Reduce projection** - Read more about this topic in [Loading a document within a projection](../sharding/querying.mdx#loading-a-document-within-a-projection) above. + Read more about this topic in [Loading a document within a projection](#loading-a-document-within-a-projection) above. * **Ordering streamed Map-Reduce results by _non-reduce-key_ fields** - Read more about this topic in [Streaming query results](../sharding/querying.mdx#streaming-query-results) above. + Read more about this topic in [Streaming query results](#streaming-query-results) above. * **_Includes_ and _loads_ are not supported in sharded streaming queries** - Read more about this topic in [Streaming query results](../sharding/querying.mdx#streaming-query-results) above. + Read more about this topic in [Streaming query results](#streaming-query-results) above. * **Querying for similar documents with _MoreLikeThis_** [MoreLikeThis](../client-api/session/querying/how-to-use-morelikethis.mdx) is not supported in a sharded database. diff --git a/versioned_docs/version-7.1/sharding/resharding.mdx b/versioned_docs/version-7.1/sharding/resharding.mdx index b36e96b18e..ec7a25e8d8 100644 --- a/versioned_docs/version-7.1/sharding/resharding.mdx +++ b/versioned_docs/version-7.1/sharding/resharding.mdx @@ -29,14 +29,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; at a time, to avoid resource overuse. * In this page: - * [Resharding](../sharding/resharding.mdx#resharding) - * [The Resharding Process](../sharding/resharding.mdx#the-resharding-process) - * [Following Resharding Progress](../sharding/resharding.mdx#following-resharding-progress) - * [Racing](../sharding/resharding.mdx#racing) - * [Change Vector on a Sharded Database](../sharding/resharding.mdx#change-vector-on-a-sharded-database) - * [Resharding and Other Features](../sharding/resharding.mdx#resharding-and-other-features) - * [Executing Resharding](../sharding/resharding.mdx#executing-resharding) - * [Bucket Ownership](../sharding/resharding.mdx#bucket-ownership) + * [Resharding](#resharding) + * [The Resharding Process](#the-resharding-process) + * [Following Resharding Progress](#following-resharding-progress) + * [Racing](#racing) + * [Change Vector on a Sharded Database](#change-vector-on-a-sharded-database) + * [Resharding and Other Features](#resharding-and-other-features) + * [Executing Resharding](#executing-resharding) + * [Bucket Ownership](#bucket-ownership) ## Resharding @@ -82,7 +82,7 @@ using a database like the one shown below: You can follow the progress of the resharding progress using - * **Studio Popup Messages** - When [Studio is used for resharding](../sharding/resharding.mdx#executing-resharding) + When [Studio is used for resharding](#executing-resharding) the user interface produces popup messages to keep users informed of its progress. @@ -177,7 +177,7 @@ related to them, including revisions, time series, attachments, and so on, resharding a large document's bucket may take a considerable amount of time. During this time, checking which shard the bucket belongs to -[may show](../sharding/resharding.mdx#bucket-ownership) +[may show](#bucket-ownership) both the bucket's source and destination shards. However, if documents stored in this bucket are [queried](../sharding/querying.mdx) during this time, RavenDB will add them to the retrieved dataset diff --git a/versioned_docs/version-7.1/sharding/subscriptions.mdx b/versioned_docs/version-7.1/sharding/subscriptions.mdx index 748f072786..1e0d4cc6b8 100644 --- a/versioned_docs/version-7.1/sharding/subscriptions.mdx +++ b/versioned_docs/version-7.1/sharding/subscriptions.mdx @@ -27,8 +27,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; that serve the workers, and shards that serve the orchestrators. * In this page: - * [Data Subscriptions in a Sharded Database](../sharding/subscriptions.mdx#data-subscriptions-in-a-sharded-database) - * [Unsupported Features](../sharding/subscriptions.mdx#unsupported-features) + * [Data Subscriptions in a Sharded Database](#data-subscriptions-in-a-sharded-database) + * [Unsupported Features](#unsupported-features) ## Data Subscriptions in a Sharded Database diff --git a/versioned_docs/version-7.1/sharding/unsupported.mdx b/versioned_docs/version-7.1/sharding/unsupported.mdx index c26023c436..48ab2dc1f4 100644 --- a/versioned_docs/version-7.1/sharding/unsupported.mdx +++ b/versioned_docs/version-7.1/sharding/unsupported.mdx @@ -20,16 +20,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; The list below details these unsupported features. * In this article: - * [Unsupported Indexing Features](../sharding/unsupported.mdx#unsupported-indexing-features) - * [Unsupported Querying Features](../sharding/unsupported.mdx#unsupported-querying-features) - * [Unsupported Document Extensions Features](../sharding/unsupported.mdx#unsupported-document-extensions-features) - * [Unsupported Backup Features](../sharding/unsupported.mdx#unsupported-backup-features) - * [Unsupported Import & Export Features](../sharding/unsupported.mdx#unsupported-import--export-features) - * [Unsupported Migration Features](../sharding/unsupported.mdx#unsupported-migration-features) - * [Unsupported Data Subscription Features](../sharding/unsupported.mdx#unsupported-data-subscription-features) - * [Unsupported Integrations Features](../sharding/unsupported.mdx#unsupported-integrations-features) - * [Unsupported Patching Features](../sharding/unsupported.mdx#unsupported-patching-features) - * [Unsupported Replication Features](../sharding/unsupported.mdx#unsupported-replication-features) + * [Unsupported Indexing Features](#unsupported-indexing-features) + * [Unsupported Querying Features](#unsupported-querying-features) + * [Unsupported Document Extensions Features](#unsupported-document-extensions-features) + * [Unsupported Backup Features](#unsupported-backup-features) + * [Unsupported Import & Export Features](#unsupported-import--export-features) + * [Unsupported Migration Features](#unsupported-migration-features) + * [Unsupported Data Subscription Features](#unsupported-data-subscription-features) + * [Unsupported Integrations Features](#unsupported-integrations-features) + * [Unsupported Patching Features](#unsupported-patching-features) + * [Unsupported Replication Features](#unsupported-replication-features) diff --git a/versioned_docs/version-7.1/start/containers/general-guide.mdx b/versioned_docs/version-7.1/start/containers/general-guide.mdx index 19eb8e4da4..1612aa54cb 100644 --- a/versioned_docs/version-7.1/start/containers/general-guide.mdx +++ b/versioned_docs/version-7.1/start/containers/general-guide.mdx @@ -21,10 +21,10 @@ This guide provides a comprehensive overview of running RavenDB in containers. I ## Contents -1. [Core Concepts & Difficulties](../../start/containers/general-guide.mdx#core-concepts) -2. [What We Offer](../../start/containers/general-guide.mdx#what-we-offer) -3. [What We Require](../../start/containers/general-guide.mdx#what-we-require) -4. [Benefits](../../start/containers/general-guide.mdx#benefits) +1. [Core Concepts & Difficulties](#core-concepts) +2. [What We Offer](#what-we-offer) +3. [What We Require](#what-we-require) +4. [Benefits](#benefits) ## 1. Core concepts #### Containers diff --git a/versioned_docs/version-7.1/start/content/_test-driver-csharp.mdx b/versioned_docs/version-7.1/start/content/_test-driver-csharp.mdx index f91dfdaea4..05bc9c2a55 100644 --- a/versioned_docs/version-7.1/start/content/_test-driver-csharp.mdx +++ b/versioned_docs/version-7.1/start/content/_test-driver-csharp.mdx @@ -14,20 +14,20 @@ import ContentFrame from "@site/src/components/ContentFrame"; [prerequisites](../../server/embedded.mdx#prerequisite) as embedded servers to run the tests. * In this page: - - [`RavenTestDriver`](../../start/test-driver.mdx#raventestdriver) - - [Pre-initializing the store: `PreInitialize`](../../start/test-driver.mdx#pre-initializing-the-store-preinitialize) - - [Configure the server: `ConfigureServer`](../../start/test-driver.mdx#configure-the-server-configureserver) - - [Unit test](../../start/test-driver.mdx#unit-test) - - [Complete example](../../start/test-driver.mdx#complete-example) - - [Continuous Integration (CI) Servers](../../start/test-driver.mdx#continuous-integration-ci-servers) - - [Licensing](../../start/test-driver.mdx#licensing) + - [`RavenTestDriver`](#raventestdriver) + - [Pre-initializing the store: `PreInitialize`](#pre-initializing-the-store-preinitialize) + - [Configure the server: `ConfigureServer`](#configure-the-server-configureserver) + - [Unit test](#unit-test) + - [Complete example](#complete-example) + - [Continuous Integration (CI) Servers](#continuous-integration-ci-servers) + - [Licensing](#licensing) Start by creating a class that derives from `RavenTestDriver`. -Find below a list of test driver methods, followed by [samples](../../start/test-driver.mdx#complete-example). +Find below a list of test driver methods, followed by [samples](#complete-example). ### TestDriver Methods @@ -204,7 +204,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b * `ConfigureServer` can only be set once per test run. It needs to be set before `GetDocumentStore` is called. - See an [example](../../start/test-driver.mdx#complete-example) below. + See an [example](#complete-example) below. * If it is called twice, or within the `DocumentStore` scope, you will get the following error message: `System.InvalidOperationException : Cannot configure server after it was started. Please call 'ConfigureServer' method before any 'GetDocumentStore' is called.` @@ -212,7 +212,7 @@ You can use it with `TestServerOptions` to change the path to the Raven server b Defining TestServerOptions allows you to be more in control of -how the embedded server is going to run with just a minor [definition change](../../start/test-driver.mdx#example-2). +how the embedded server is going to run with just a minor [definition change](#example-2). * To see the complete list of `TestServerOptions`, which inherits from embedded servers, go to embedded [ServerOptions](../../server/embedded.mdx#serveroptions). * It's important to be sure that the correct [.NET FrameworkVersion](../../server/embedded.mdx#net-frameworkversion) is set. @@ -252,7 +252,7 @@ We use [xunit](https://www.nuget.org/packages/xunit/) for the test framework in Note that the test itself is meant to show different capabilities of the test driver and is not meant to be the most efficient. -The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](../../start/test-driver.mdx#complete-example) +The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](#complete-example) #### Example diff --git a/versioned_docs/version-7.1/start/content/_test-driver-java.mdx b/versioned_docs/version-7.1/start/content/_test-driver-java.mdx index 219f3b636b..482e18c114 100644 --- a/versioned_docs/version-7.1/start/content/_test-driver-java.mdx +++ b/versioned_docs/version-7.1/start/content/_test-driver-java.mdx @@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock'; [prerequisites](../../server/embedded.mdx#prerequisites) as embedded servers to run the tests. * In this page: - - [RavenTestDriver](../../start/test-driver.mdx#raventestdriver) - - [Pre-initializing the store](../../start/test-driver.mdx#preinitialize) - - [ConfigureServer](../../start/test-driver.mdx#configureserver) - - [Unit test](../../start/test-driver.mdx#unittest) - - [Complete example](../../start/test-driver.mdx#complete-example) + - [RavenTestDriver](#raventestdriver) + - [Pre-initializing the store](#preinitialize) + - [ConfigureServer](#configureserver) + - [Unit test](#unittest) + - [Complete example](#complete-example) @@ -36,7 +36,7 @@ First, please make sure that the Raven TestDriver is added to your project depen Then, define a class that derives from the Raven TestDriver. We can start by reviewing TestDriver methods, and then get into implementation -(find a complete Raven TestDriver code sample [below](../../start/test-driver.mdx#complete-example)). +(find a complete Raven TestDriver code sample [below](#complete-example)). ### Methods | Signature | Description | @@ -83,7 +83,7 @@ protected void preInitialize(IDocumentStore documentStore) \{ We'll be using [JUnit](https://junit.org/) for my test framework in the below example. Note that the test itself is meant to show different capabilities of the test driver and is not meant to be the most efficient. -The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](../../start/test-driver.mdx#complete-example) +The example below depends on the `TestDocumentByName` index and `TestDocument` class that can be seen in the [full example](#complete-example) ### Example diff --git a/versioned_docs/version-7.1/start/getting-started.mdx b/versioned_docs/version-7.1/start/getting-started.mdx index c817ed298a..01882866a5 100644 --- a/versioned_docs/version-7.1/start/getting-started.mdx +++ b/versioned_docs/version-7.1/start/getting-started.mdx @@ -19,17 +19,17 @@ Welcome to RavenDB! * This article will get you started with RavenDB, covering the essentials for a simple setup and basic usage. -* The [Server section](../start/getting-started.mdx#server) covers installation, setup, and configuration of the RavenDB server: - * [Prerequisites](../start/getting-started.mdx#prerequisites) - * [Installation & Setup](../start/getting-started.mdx#installation--setup) - * [Configuration](../start/getting-started.mdx#configuration) - * [Studio](../start/getting-started.mdx#studio) - * [Security Concerns](../start/getting-started.mdx#security-concerns) - -* The [Client section](../start/getting-started.mdx#client) shows how to connect your application to the RavenDB server +* The [Server section](#server) covers installation, setup, and configuration of the RavenDB server: + * [Prerequisites](#prerequisites) + * [Installation & Setup](#installation--setup) + * [Configuration](#configuration) + * [Studio](#studio) + * [Security Concerns](#security-concerns) + +* The [Client section](#client) shows how to connect your application to the RavenDB server and begin working with documents using a client library: - * [DocumentStore](../start/getting-started.mdx#documentstore) - * [Session](../start/getting-started.mdx#session) + * [DocumentStore](#documentstore) + * [Session](#session) @@ -219,7 +219,7 @@ Whenever you run the server folder script `run.ps1` the Studio opens automatical ### Security Concerns **We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start** to prevent potential future vulnerability. -[The process](../start/getting-started.mdx#installation--setup) in RavenDB only takes a few minutes and is free. +[The process](#installation--setup) in RavenDB only takes a few minutes and is free. To let a developer start coding an application quickly, RavenDB will run with the following default security mode: diff --git a/versioned_docs/version-7.1/start/guides/aws-lambda/overview.mdx b/versioned_docs/version-7.1/start/guides/aws-lambda/overview.mdx index c3e16b8ffb..d5a067bb96 100644 --- a/versioned_docs/version-7.1/start/guides/aws-lambda/overview.mdx +++ b/versioned_docs/version-7.1/start/guides/aws-lambda/overview.mdx @@ -21,19 +21,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this guide, you will learn how to deploy a .NET C# Lambda Handler Function using the [RavenDB AWS Lambda C# template][template] that is connected to your RavenDB database. -* Watch our tutorial video [below](../../../start/guides/aws-lambda/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=T2r9sqrTrYE). * In this page: - * [Before We Get Started](../../../start/guides/aws-lambda/overview.mdx#before-we-get-started) - * [Create a Local Lambda Function](../../../start/guides/aws-lambda/overview.mdx#create-a-local-lambda-function) - * [Configuring Local Connection to RavenDB](../../../start/guides/aws-lambda/overview.mdx#configuring-local-connection-to-ravendb) - * [Deploying to AWS](../../../start/guides/aws-lambda/overview.mdx#deploying-to-aws) - * [Configuring Production Connection to RavenDB](../../../start/guides/aws-lambda/overview.mdx#configuring-production-connection-to-ravendb) - * [Verify the Connection Works](../../../start/guides/aws-lambda/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Lambda Function](../../../start/guides/aws-lambda/overview.mdx#using-ravendb-in-the-lambda-function) - * [Next Steps](../../../start/guides/aws-lambda/overview.mdx#next-steps) - * [Tutorial Video](../../../start/guides/aws-lambda/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Lambda Function](#create-a-local-lambda-function) + * [Configuring Local Connection to RavenDB](#configuring-local-connection-to-ravendb) + * [Deploying to AWS](#deploying-to-aws) + * [Configuring Production Connection to RavenDB](#configuring-production-connection-to-ravendb) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Lambda Function](#using-ravendb-in-the-lambda-function) + * [Next Steps](#next-steps) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-csharp.mdx b/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-csharp.mdx index 2260de98e4..3d4e13e915 100644 --- a/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-csharp.mdx +++ b/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-csharp.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; We assume you are familiar with .NET development techniques and the basics of Azure Function apps. * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../../start/guides/azure-functions/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../../start/guides/azure-functions/existing-project.mdx#initializing-the-document-store) - * [Adding Support for App Settings](../../../../start/guides/azure-functions/existing-project.mdx#adding-support-for-app-settings) - * [Configuring Support for Certificates](../../../../start/guides/azure-functions/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Azure](../../../../start/guides/azure-functions/existing-project.mdx#configuring-azure) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Adding Support for App Settings](#adding-support-for-app-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Azure](#configuring-azure) diff --git a/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-nodejs.mdx b/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-nodejs.mdx index 179a73d64c..de8072c188 100644 --- a/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-nodejs.mdx +++ b/versioned_docs/version-7.1/start/guides/azure-functions/content/_existing-project-nodejs.mdx @@ -15,12 +15,12 @@ import CodeBlock from '@theme/CodeBlock'; We assume you are familiar with Node.js development techniques and the basics of Azure Function apps. * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../../start/guides/azure-functions/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../../start/guides/azure-functions/existing-project.mdx#initializing-the-document-store) - * [Adding Support for App Settings](../../../../start/guides/azure-functions/existing-project.mdx#adding-support-for-app-settings) - * [Configuring Support for Certificates](../../../../start/guides/azure-functions/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Azure](../../../../start/guides/azure-functions/existing-project.mdx#configuring-azure) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Adding Support for App Settings](#adding-support-for-app-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Azure](#configuring-azure) diff --git a/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-csharp.mdx b/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-csharp.mdx index 683be2d6d8..5b01b1f7eb 100644 --- a/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-csharp.mdx +++ b/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-csharp.mdx @@ -18,18 +18,18 @@ import CodeBlock from '@theme/CodeBlock'; basics of Azure Function apps. -* Watch our tutorial video [below](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=1vnpfsD3bSE&). * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/overview.mdx#before-we-get-started) - * [Create a Local Azure Function App](../../../../start/guides/azure-functions/overview.mdx#create-a-local-azure-function-app) - * [Configuring Local Connection to RavenDB](../../../../start/guides/azure-functions/overview.mdx#configuring-local-connection-to-ravendb) - * [Creating Function App Resources in Azure](../../../../start/guides/azure-functions/overview.mdx#creating-function-app-resources-in-azure) - * [Deploying to Azure](../../../../start/guides/azure-functions/overview.mdx#deploying-to-azure) - * [Verify the Connection Works](../../../../start/guides/azure-functions/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Azure Functions App](../../../../start/guides/azure-functions/overview.mdx#using-ravendb-in-the-azure-functions-app) - * [Tutorial Video](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Azure Function App](#create-a-local-azure-function-app) + * [Configuring Local Connection to RavenDB](#configuring-local-connection-to-ravendb) + * [Creating Function App Resources in Azure](#creating-function-app-resources-in-azure) + * [Deploying to Azure](#deploying-to-azure) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Azure Functions App](#using-ravendb-in-the-azure-functions-app) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-nodejs.mdx b/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-nodejs.mdx index c1604d5040..63c2222eaa 100644 --- a/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-nodejs.mdx +++ b/versioned_docs/version-7.1/start/guides/azure-functions/content/_overview-nodejs.mdx @@ -18,18 +18,18 @@ import CodeBlock from '@theme/CodeBlock'; and the basics of Azure Function apps. -* Watch our tutorial video [below](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=TJdJ3TJK-Sg). * In this page: - * [Before We Get Started](../../../../start/guides/azure-functions/overview.mdx#before-we-get-started) - * [Create a Local Azure Function App](../../../../start/guides/azure-functions/overview.mdx#create-a-local-azure-function-app) - * [Connecting to RavenDB](../../../../start/guides/azure-functions/overview.mdx#connecting-to-ravendb) - * [Creating a Function App in Azure](../../../../start/guides/azure-functions/overview.mdx#creating-a-function-app-in-azure) - * [Deploying to Azure](../../../../start/guides/azure-functions/overview.mdx#deploying-to-azure) - * [Verify the Connection Works](../../../../start/guides/azure-functions/overview.mdx#verify-the-connection-works) - * [Using RavenDB in the Azure Functions App](../../../../start/guides/azure-functions/overview.mdx#using-ravendb-in-the-azure-functions-app) - * [Tutorial Video](../../../../start/guides/azure-functions/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Local Azure Function App](#create-a-local-azure-function-app) + * [Connecting to RavenDB](#connecting-to-ravendb) + * [Creating a Function App in Azure](#creating-a-function-app-in-azure) + * [Deploying to Azure](#deploying-to-azure) + * [Verify the Connection Works](#verify-the-connection-works) + * [Using RavenDB in the Azure Functions App](#using-ravendb-in-the-azure-functions-app) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-7.1/start/guides/azure-functions/deployment.mdx b/versioned_docs/version-7.1/start/guides/azure-functions/deployment.mdx index 4097d8b2ad..0ad8660675 100644 --- a/versioned_docs/version-7.1/start/guides/azure-functions/deployment.mdx +++ b/versioned_docs/version-7.1/start/guides/azure-functions/deployment.mdx @@ -19,7 +19,7 @@ serverless workloads to Microsoft Azure Functions platform. * In this page: * [Linux or Windows?](../../../start/guides/azure-functions/deployment.mdx#linux-or-windows?) - * [Document Store Lifetime and Cold Starts](../../../start/guides/azure-functions/deployment.mdx#document-store-lifetime-and-cold-starts) + * [Document Store Lifetime and Cold Starts](#document-store-lifetime-and-cold-starts) diff --git a/versioned_docs/version-7.1/start/guides/cloudflare-workers/existing-project.mdx b/versioned_docs/version-7.1/start/guides/cloudflare-workers/existing-project.mdx index 8cbef535d8..059eafd118 100644 --- a/versioned_docs/version-7.1/start/guides/cloudflare-workers/existing-project.mdx +++ b/versioned_docs/version-7.1/start/guides/cloudflare-workers/existing-project.mdx @@ -27,12 +27,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; We assume you are familiar with Node.js development techniques and the basics of Cloudflare Workers. * In this page: - * [Before We Get Started](../../../start/guides/cloudflare-workers/existing-project.mdx#before-we-get-started) - * [Installing the RavenDB Client SDK](../../../start/guides/cloudflare-workers/existing-project.mdx#installing-the-ravendb-client-sdk) - * [Initializing the Document Store](../../../start/guides/cloudflare-workers/existing-project.mdx#initializing-the-document-store) - * [Updating Database Connection Settings](../../../start/guides/cloudflare-workers/existing-project.mdx#updating-database-connection-settings) - * [Configuring Support for Certificates](../../../start/guides/cloudflare-workers/existing-project.mdx#configuring-support-for-certificates) - * [Configuring Cloudflare](../../../start/guides/cloudflare-workers/existing-project.mdx#configuring-cloudflare) + * [Before We Get Started](#before-we-get-started) + * [Installing the RavenDB Client SDK](#installing-the-ravendb-client-sdk) + * [Initializing the Document Store](#initializing-the-document-store) + * [Updating Database Connection Settings](#updating-database-connection-settings) + * [Configuring Support for Certificates](#configuring-support-for-certificates) + * [Configuring Cloudflare](#configuring-cloudflare) diff --git a/versioned_docs/version-7.1/start/guides/cloudflare-workers/overview.mdx b/versioned_docs/version-7.1/start/guides/cloudflare-workers/overview.mdx index 2f991a7b75..d92958b60f 100644 --- a/versioned_docs/version-7.1/start/guides/cloudflare-workers/overview.mdx +++ b/versioned_docs/version-7.1/start/guides/cloudflare-workers/overview.mdx @@ -25,17 +25,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; This guide assumes you are familiar with Node.js development techniques and the basics of Cloudflare Workers. -* Watch our tutorial video [below](../../../start/guides/cloudflare-workers/overview.mdx#tutorial-video) +* Watch our tutorial video [below](#tutorial-video) or [on YouTube](https://www.youtube.com/watch?v=qMJfgQicjwk&t=1s). * In this page: - * [Before We Get Started](../../../start/guides/cloudflare-workers/overview.mdx#before-we-get-started) - * [Create a Cloudflare RavenDB Worker project](../../../start/guides/cloudflare-workers/overview.mdx#create-a-cloudflare-ravendb-worker-project) - * [Updating Database Connection Settings](../../../start/guides/cloudflare-workers/overview.mdx#updating-database-connection-settings) - * [Connecting to an Authenticated RavenDB Cluster](../../../start/guides/cloudflare-workers/overview.mdx#connecting-to-an-authenticated-ravendb-cluster) - * [Deploying to Production](../../../start/guides/cloudflare-workers/overview.mdx#deploying-to-production) - * [Using RavenDB in the Worker](../../../start/guides/cloudflare-workers/overview.mdx#using-ravendb-in-the-worker) - * [Tutorial Video](../../../start/guides/cloudflare-workers/overview.mdx#tutorial-video) + * [Before We Get Started](#before-we-get-started) + * [Create a Cloudflare RavenDB Worker project](#create-a-cloudflare-ravendb-worker-project) + * [Updating Database Connection Settings](#updating-database-connection-settings) + * [Connecting to an Authenticated RavenDB Cluster](#connecting-to-an-authenticated-ravendb-cluster) + * [Deploying to Production](#deploying-to-production) + * [Using RavenDB in the Worker](#using-ravendb-in-the-worker) + * [Tutorial Video](#tutorial-video) diff --git a/versioned_docs/version-7.1/start/installation/deployment-considerations.mdx b/versioned_docs/version-7.1/start/installation/deployment-considerations.mdx index f2e956e459..fc04048986 100644 --- a/versioned_docs/version-7.1/start/installation/deployment-considerations.mdx +++ b/versioned_docs/version-7.1/start/installation/deployment-considerations.mdx @@ -15,12 +15,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Deployment Considerations](../../start/installation/deployment-considerations.mdx#deployment-considerations) - * [Performance Considerations](../../start/installation/deployment-considerations.mdx#performance-considerations) - * [Storage Considerations](../../start/installation/deployment-considerations.mdx#storage-considerations) - * [Network Considerations](../../start/installation/deployment-considerations.mdx#network-considerations) - * [Running RavenDB](../../start/installation/deployment-considerations.mdx#running-ravendb) - * [When the Database Grows Bigger](../../start/installation/deployment-considerations.mdx#when-the-database-grows-bigger) + * [Deployment Considerations](#deployment-considerations) + * [Performance Considerations](#performance-considerations) + * [Storage Considerations](#storage-considerations) + * [Network Considerations](#network-considerations) + * [Running RavenDB](#running-ravendb) + * [When the Database Grows Bigger](#when-the-database-grows-bigger) diff --git a/versioned_docs/version-7.1/start/installation/gnu-linux/deb.mdx b/versioned_docs/version-7.1/start/installation/gnu-linux/deb.mdx index cdabbefd92..d96d2a43cd 100644 --- a/versioned_docs/version-7.1/start/installation/gnu-linux/deb.mdx +++ b/versioned_docs/version-7.1/start/installation/gnu-linux/deb.mdx @@ -24,18 +24,18 @@ import LanguageContent from "@site/src/components/LanguageContent"; a browser and complete the setup process using our setup wizard. * In this page: - * [Downloading and Installing RavenDB](../../../start/installation/gnu-linux/deb.mdx#downloading-and-installing-ravendb) - * [1. Download DEB Package](../../../start/installation/gnu-linux/deb.mdx#download-deb-package) - * [2. Install RavenDB](../../../start/installation/gnu-linux/deb.mdx#install-ravendb) - * [3. Complete the setup](../../../start/installation/gnu-linux/deb.mdx#complete-the-setup) - * [4. Entering RavenDB Studio When Setup is Complete](../../../start/installation/gnu-linux/deb.mdx#entering-ravendb-studio-when-setup-is-complete) - * [Upgrading RavenDB](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb) - * [Removing RavenDB](../../../start/installation/gnu-linux/deb.mdx#removing-ravendb) - * [Remove RavenDB and Leave its Data and Settings Intact](../../../start/installation/gnu-linux/deb.mdx#remove-ravendb-and-leave-its-data-and-settings-intact) - * [Remove RavenDB Completely](../../../start/installation/gnu-linux/deb.mdx#remove-ravendb-completely) - * [File System Locations](../../../start/installation/gnu-linux/deb.mdx#file-system-locations) - * [Default Settings](../../../start/installation/gnu-linux/deb.mdx#default-settings) - * [RavenDB Service Definitions](../../../start/installation/gnu-linux/deb.mdx#ravendb-service-definitions) + * [Downloading and Installing RavenDB](#downloading-and-installing-ravendb) + * [1. Download DEB Package](#download-deb-package) + * [2. Install RavenDB](#install-ravendb) + * [3. Complete the setup](#complete-the-setup) + * [4. Entering RavenDB Studio When Setup is Complete](#entering-ravendb-studio-when-setup-is-complete) + * [Upgrading RavenDB](#upgrading-ravendb) + * [Removing RavenDB](#removing-ravendb) + * [Remove RavenDB and Leave its Data and Settings Intact](#remove-ravendb-and-leave-its-data-and-settings-intact) + * [Remove RavenDB Completely](#remove-ravendb-completely) + * [File System Locations](#file-system-locations) + * [Default Settings](#default-settings) + * [RavenDB Service Definitions](#ravendb-service-definitions) ## Downloading and Installing RavenDB @@ -59,7 +59,7 @@ Find it here: [https://ravendb.net/download](https://ravendb.net/download) The same command, `sudo apt install `, is also used to - [Upgrade RavenDB](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb). + [Upgrade RavenDB](#upgrading-ravendb). * The RavenDB service will be created and activated automatically. @@ -165,7 +165,7 @@ To remove RavenDB and **leave its settings and data intact**, use: `sudo apt-get !["Leave Data and Settings Intact"](./assets/sudo_apt-get_remove_ravendb.png) -[Reinstalling](../../../start/installation/gnu-linux/deb.mdx#upgrading-ravendb) +[Reinstalling](#upgrading-ravendb) RavenDB after removing it this way will **restore** its data and settings. ### Remove RavenDB Completely diff --git a/versioned_docs/version-7.1/start/installation/manual.mdx b/versioned_docs/version-7.1/start/installation/manual.mdx index 02ce4bce90..3cc5e01aa7 100644 --- a/versioned_docs/version-7.1/start/installation/manual.mdx +++ b/versioned_docs/version-7.1/start/installation/manual.mdx @@ -24,11 +24,11 @@ If you choose manual setup and/or to provide your own certificate, **you are res In this page: -* [Downloading Server and Setting Up Node Folders](../../start/installation/manual.mdx#downloading-server-and-setting-up-node-folders) -* [Disabling 'Setup Wizard'](../../start/installation/manual.mdx#disabling-setup-wizard) -* [Server Url and Port](../../start/installation/manual.mdx#server-url-and-port) -* [Security](../../start/installation/manual.mdx#security) -* [Configuration](../../start/installation/manual.mdx#configuration) +* [Downloading Server and Setting Up Node Folders](#downloading-server-and-setting-up-node-folders) +* [Disabling 'Setup Wizard'](#disabling-setup-wizard) +* [Server Url and Port](#server-url-and-port) +* [Security](#security) +* [Configuration](#configuration) ## Downloading Server and Setting Up Node Folders Download the [RavenDB server package](https://ravendb.net/download) and extract it into permanent server folders on each machine. diff --git a/versioned_docs/version-7.1/start/installation/running-as-service.mdx b/versioned_docs/version-7.1/start/installation/running-as-service.mdx index 4f4364de7b..47b34323f5 100644 --- a/versioned_docs/version-7.1/start/installation/running-as-service.mdx +++ b/versioned_docs/version-7.1/start/installation/running-as-service.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Windows](../../start/installation/running-as-service.mdx#windows) - * [Registering](../../start/installation/running-as-service.mdx#registering) - * [Unregistering](../../start/installation/running-as-service.mdx#unregistering) - * [Starting and Stopping](../../start/installation/running-as-service.mdx#starting-and-stopping) -* [Linux - Ubuntu](../../start/installation/running-as-service.mdx#linux---ubuntu) +* [Windows](#windows) + * [Registering](#registering) + * [Unregistering](#unregistering) + * [Starting and Stopping](#starting-and-stopping) +* [Linux - Ubuntu](#linux---ubuntu) diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/additional-settings.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/additional-settings.mdx index 7b2a854487..cdb3441bad 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/additional-settings.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/additional-settings.mdx @@ -19,8 +19,8 @@ import Panel from '@site/src/components/Panel'; the next step is to **customize optional settings**. * In this article: - * [Additional settings](../../../start/installation/setup-wizard/additional-settings.mdx#additional-settings) - * [Configure advanced options](../../../start/installation/setup-wizard/additional-settings.mdx#configure-advanced-options) + * [Additional settings](#additional-settings) + * [Configure advanced options](#configure-advanced-options) @@ -61,7 +61,7 @@ import Panel from '@site/src/components/Panel'; 4. **Configure advanced options**: Toggle this option on to expand the section. - Learn more below in [Configure advanced options](../../../start/installation/setup-wizard/additional-settings.mdx#configure-advanced-options). + Learn more below in [Configure advanced options](#configure-advanced-options). 5. Click **"Continue"** to proceed to the next step: [Review setup](../../../start/installation/setup-wizard/review-setup.mdx). diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/choose-security-option.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/choose-security-option.mdx index a163f6e447..a3f16fc9aa 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/choose-security-option.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/choose-security-option.mdx @@ -34,10 +34,10 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Choose a security method](../../../start/installation/setup-wizard/choose-security-option.mdx#choose-a-security-method) - * [Generate Let's Encrypt certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#generate-let-s-encrypt-certificate) - * [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate) - * [Don't use certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#don-t-use-certificate) + * [Choose a security method](#choose-a-security-method) + * [Generate Let's Encrypt certificate](#generate-let-s-encrypt-certificate) + * [Provide your own certificate](#provide-your-own-certificate) + * [Don't use certificate](#don-t-use-certificate) @@ -47,9 +47,9 @@ In this step, choose one of three security options: ![Select how to secure](./assets/security-1.png) -1. [Generate Let's Encrypt certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#generate-let-s-encrypt-certificate) -2. [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate) -3. [Don't use certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#don-t-use-certificate) +1. [Generate Let's Encrypt certificate](#generate-let-s-encrypt-certificate) +2. [Provide your own certificate](#provide-your-own-certificate) +3. [Don't use certificate](#don-t-use-certificate) 4. After selecting a security method, click **"Continue"** to proceed with its setup steps. 5. Click **"Back"** to return to the previous step - [Provide license key](../../../start/installation/setup-wizard/provide-license-key.mdx). @@ -61,7 +61,7 @@ Use this option to secure your server with a [Let's Encrypt certificate](../../. Let’s Encrypt is a free, automated certificate authority that provides trusted SSL/TLS certificates for HTTPS communication. To make this process as seamless as possible, **RavenDB provides a free domain name** for your cluster. -RavenDB will automatically issue and renew a trusted HTTPS certificate for the [domain you define in the next step](../../../start/installation/setup-wizard/choose-security-option.mdx#enter-a-domain-name), +RavenDB will automatically issue and renew a trusted HTTPS certificate for the [domain you define in the next step](#enter-a-domain-name), fully managing the certificate lifecycle so you don't need to provide or maintain your own. **When to use this option**: @@ -144,7 +144,7 @@ we recommend using your own certificates and domains, avoiding reliance on a thi * **Using your own domain** The free subdomain is provided only for the purpose of proving ownership to Let's Encrypt. If you prefer to use your own domain, you are welcome to acquire your own certificate and use it instead. - See [Provide your own certificate](../../../start/installation/setup-wizard/choose-security-option.mdx#provide-your-own-certificate). + See [Provide your own certificate](#provide-your-own-certificate). diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/choose-setup-method.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/choose-setup-method.mdx index 45f4fbde18..2afe3b8b3c 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/choose-setup-method.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/choose-setup-method.mdx @@ -19,10 +19,10 @@ import Panel from '@site/src/components/Panel'; the next step is to choose the **setup method** you want to proceed with. * In this article: - * [Available setup methods](../../../start/installation/setup-wizard/choose-setup-method.mdx#available-setup-methods) - * [Set up a new cluster](../../../start/installation/setup-wizard/choose-setup-method.mdx#set-up-a-new-cluster) - * [Create a package for external setup](../../../start/installation/setup-wizard/choose-setup-method.mdx#create-a-package-for-external-setup) - * [Use an existing setup package](../../../start/installation/setup-wizard/choose-setup-method.mdx#use-an-existing-setup-package) + * [Available setup methods](#available-setup-methods) + * [Set up a new cluster](#set-up-a-new-cluster) + * [Create a package for external setup](#create-a-package-for-external-setup) + * [Use an existing setup package](#use-an-existing-setup-package) @@ -35,15 +35,15 @@ The following setup methods are available: 1. **Set up a new cluster** Configure a new cluster (single-node or multi-node) and start the **first RavenDB instance** on the machine where the Setup Wizard is running. - Learn more below in [Set up a new cluster](../../../start/installation/setup-wizard/choose-setup-method.mdx#set-up-a-new-cluster). + Learn more below in [Set up a new cluster](#set-up-a-new-cluster). 2. **Create a package for external setup** Prepare a configuration package without starting a server locally. - Learn more below in [Create a package for external setup](../../../start/installation/setup-wizard/choose-setup-method.mdx#create-a-package-for-external-setup). + Learn more below in [Create a package for external setup](#create-a-package-for-external-setup). 3. **Use an existing setup package** Apply a previously generated setup package to join a node to a cluster. - Learn more below in [Use an existing setup package](../../../start/installation/setup-wizard/choose-setup-method.mdx#use-an-existing-setup-package). + Learn more below in [Use an existing setup package](#use-an-existing-setup-package). 4. Click **"Continue"** to proceed to the next step in the wizard, which is [Providing the license key](../../../start/installation/setup-wizard/provide-license-key.mdx). diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/configure-node-addresses.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/configure-node-addresses.mdx index 494521db36..653d86867c 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/configure-node-addresses.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/configure-node-addresses.mdx @@ -30,13 +30,13 @@ import Panel from '@site/src/components/Panel'; --- * In this article: - * [Set up node addresses for a SECURE cluster](../../../start/installation/setup-wizard/configure-node-addresses.mdx#set-up-node-addresses-for-a-secure-cluster) + * [Set up node addresses for a SECURE cluster](#set-up-node-addresses-for-a-secure-cluster) * [Behind a firewall or load balancer](../../../start/installation/setup-wizard/configure-node-addresses#behind-a-firewall-or-load-balancer) * [In a Docker container](../../../start/installation/setup-wizard/configure-node-addresses#in-a-docker-container) - * [Set up node addresses for an UNSECURED cluster](../../../start/installation/setup-wizard/configure-node-addresses.mdx#set-up-node-addresses-for-an-unsecured-cluster) - * [Cluster topology](../../../start/installation/setup-wizard/configure-node-addresses.mdx#cluster-topology) - * [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes) - * [Node layout](../../..//start/installation/setup-wizard/configure-node-addresses.mdx#node-layout) + * [Set up node addresses for an UNSECURED cluster](#set-up-node-addresses-for-an-unsecured-cluster) + * [Cluster topology](#cluster-topology) + * [Number of nodes](#number-of-nodes) + * [Node layout](#node-layout) @@ -103,7 +103,7 @@ import Panel from '@site/src/components/Panel'; Nodes can use the same HTTPS/TCP ports as long as they listen on different IP addresses or hostnames. You can add nodes up to the limit allowed by your license. For production, it is recommended to start with at least 3 nodes. - Learn more in [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes). + Learn more in [Number of nodes](#number-of-nodes). 11. **Save**: When you finish configuring this node, click this button to save its settings. @@ -203,7 +203,7 @@ The following example shows a configuration of a 3-node cluster: Nodes can use the same HTTP/TCP ports as long as they listen on different IP addresses or hostnames. You can add nodes up to the limit allowed by your license. For production, it is recommended to start with at least 3 nodes. - Learn more in [Number of nodes](../../../start/installation/setup-wizard/configure-node-addresses.mdx#number-of-nodes). + Learn more in [Number of nodes](#number-of-nodes). 8. Click **"Continue"** to proceed to the next step - [Additional settings](../../../start/installation/setup-wizard/additional-settings.mdx). The "Continue" button is enabled after you click "Save". 9. Click **"Back"** to return to the previous step - [Choosing a security option](../../../start/installation/setup-wizard/choose-security-option.mdx). diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/finish-setup.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/finish-setup.mdx index 02833ac493..42be886526 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/finish-setup.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/finish-setup.mdx @@ -19,11 +19,11 @@ import Panel from '@site/src/components/Panel'; the wizard applies your configuration and either prepares the server for its first run or generates a setup package, depending on the flow you chose in earlier steps. * In this article: - * [Configuration in process](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-in-process) - * [Configuration is done](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-is-done) - * [The downloaded ZIP file](../../../start/installation/setup-wizard/finish-setup.mdx#the-downloaded-zip-file) - * [The "All Set!" screen](../../../start/installation/setup-wizard/finish-setup.mdx#the-all-set-screen) - * [Restarting the server](../../../start/installation/setup-wizard/finish-setup.mdx#restarting-the-server) + * [Configuration in process](#configuration-in-process) + * [Configuration is done](#configuration-is-done) + * [The downloaded ZIP file](#the-downloaded-zip-file) + * [The "All Set!" screen](#the-all-set-screen) + * [Restarting the server](#restarting-the-server) @@ -88,7 +88,7 @@ and [Chosen security method](../../../start/installation/setup-wizard/choose-sec **What happens next?** If all operations complete successfully, the wizard will automatically update the screen. -See the [Configuration is done](../../../start/installation/setup-wizard/finish-setup.mdx#configuration-is-done) section below. +See the [Configuration is done](#configuration-is-done) section below. If an error occurs, the process will halt. The detailed configuration log will help you identify what went wrong. @@ -175,7 +175,7 @@ For example, when configuring a **multi-node secure cluster**, you will see the 3. **Restart server**: This button is now enabled. Click to apply the settings and restart the server on Node A. Once restarted, your browser will automatically open RavenDB Studio for this node. - Learn more in [Restarting the server](../../../start/installation/setup-wizard/finish-setup.mdx#restarting-the-server) below. + Learn more in [Restarting the server](#restarting-the-server) below. diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/overview.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/overview.mdx index 9b737d2628..8f3f770a7d 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/overview.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/overview.mdx @@ -21,10 +21,10 @@ import Panel from '@site/src/components/Panel'; * If you prefer to configure RavenDB manually, see: [Manual setup](../../../start/installation/manual.mdx). * In this article: - * [How to run the Setup Wizard](../../../start/installation/setup-wizard/overview.mdx#how-to-run-the-setup-wizard) - * [License agreement (EULA)](../../../start/installation/setup-wizard/overview.mdx#license-agreement-eula) - * [Guided setup flow](../../../start/installation/setup-wizard/overview.mdx#guided-setup-flow) - * [RavenDB settings files](../../../start/installation/setup-wizard/overview.mdx#ravendb-settings-files) + * [How to run the Setup Wizard](#how-to-run-the-setup-wizard) + * [License agreement (EULA)](#license-agreement-eula) + * [Guided setup flow](#guided-setup-flow) + * [RavenDB settings files](#ravendb-settings-files) diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/provide-license-key.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/provide-license-key.mdx index 44903bc809..2c788282a7 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/provide-license-key.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/provide-license-key.mdx @@ -27,8 +27,8 @@ import Panel from '@site/src/components/Panel'; Learn more about licensing in [Licensing overview](../../../start/licensing/licensing-overview.mdx). * In this article: - * [Enter license key](../../../start/installation/setup-wizard/provide-license-key.mdx#enter-license-key) - * [Get a free license](../../../start/installation/setup-wizard/provide-license-key.mdx#get-a-free-license) + * [Enter license key](#enter-license-key) + * [Get a free license](#get-a-free-license) * [Running RavenDB without a license](../../../start/installation/setup-wizard/provide-license-key#running-ravendb-without-a-license) @@ -40,7 +40,7 @@ import Panel from '@site/src/components/Panel'; 1. Enter your license key, which was sent to the email address you provided when obtaining it. 2. If you do not have a license, select this option to obtain a free Developer or Community license. - Learn more below in [Get your free license](../../../start/installation/setup-wizard/provide-license-key.mdx#get-your-free-license). + Learn more below in [Get your free license](#get-your-free-license). 3. Click **"Continue"** to proceed to the next step in the wizard - [Choosing a security option](../../../start/installation/setup-wizard/choose-security-option.mdx). diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/review-setup.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/review-setup.mdx index fa067e6442..0ee102b20d 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/review-setup.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/review-setup.mdx @@ -19,7 +19,7 @@ import Panel from '@site/src/components/Panel'; the next step is to **review all your settings before proceeding**. * In this article: - * [Review setup](../../../start/installation/setup-wizard/review-setup.mdx#review-setup) + * [Review setup](#review-setup) diff --git a/versioned_docs/version-7.1/start/installation/setup-wizard/use-setup-package.mdx b/versioned_docs/version-7.1/start/installation/setup-wizard/use-setup-package.mdx index e0a42b7acf..32216463e6 100644 --- a/versioned_docs/version-7.1/start/installation/setup-wizard/use-setup-package.mdx +++ b/versioned_docs/version-7.1/start/installation/setup-wizard/use-setup-package.mdx @@ -19,8 +19,8 @@ import Panel from '@site/src/components/Panel'; It allows you to initialize a RavenDB instance using a configuration ZIP file generated in a previous session. * In this article: - * [When to use](../../../start/installation/setup-wizard/use-setup-package.mdx#when-to-use) - * [Using an existing setup package](../../../start/installation/setup-wizard/use-setup-package.mdx#using-an-existing-setup-package) + * [When to use](#when-to-use) + * [Using an existing setup package](#using-an-existing-setup-package) diff --git a/versioned_docs/version-7.1/start/licensing/activate-license.mdx b/versioned_docs/version-7.1/start/licensing/activate-license.mdx index adbf87b1f7..5f722d2244 100644 --- a/versioned_docs/version-7.1/start/licensing/activate-license.mdx +++ b/versioned_docs/version-7.1/start/licensing/activate-license.mdx @@ -21,8 +21,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: - * [Activate license with configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys) - * [Activate license from the Studio](../../start/licensing/activate-license.mdx#activate-license-from-the-studio) + * [Activate license with configuration keys](#activate-license-with-configuration-keys) + * [Activate license from the Studio](#activate-license-from-the-studio) ## Activate license with configuration keys diff --git a/versioned_docs/version-7.1/start/licensing/force-update.mdx b/versioned_docs/version-7.1/start/licensing/force-update.mdx index 555c0df5ed..52f2bfb198 100644 --- a/versioned_docs/version-7.1/start/licensing/force-update.mdx +++ b/versioned_docs/version-7.1/start/licensing/force-update.mdx @@ -27,7 +27,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; This action also requires an active connection to the [License Server](../../start/licensing/licensing-overview.mdx#license-server). * In this page: - * [Force license update from Studio](../../start/licensing/force-update.mdx#force-license-update-from-studio) + * [Force license update from Studio](#force-license-update-from-studio) ## Force license update from Studio diff --git a/versioned_docs/version-7.1/start/licensing/license-under-docker.mdx b/versioned_docs/version-7.1/start/licensing/license-under-docker.mdx index 244d27be2e..d05a534631 100644 --- a/versioned_docs/version-7.1/start/licensing/license-under-docker.mdx +++ b/versioned_docs/version-7.1/start/licensing/license-under-docker.mdx @@ -23,12 +23,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A `RAVEN_License` environment variable can be set. * In this page: - * [Prerequisites](../../start/licensing/license-under-docker.mdx#prerequisites) - * [Licensing a RavenDB docker image](../../start/licensing/license-under-docker.mdx#licensing-a-ravendb-docker-image) - * [Passing a Path to the License File via CLI](../../start/licensing/license-under-docker.mdx#passing-a-path-to-the-license-file-via-cli) - * [Providing a License in `settings.json`](../../start/licensing/license-under-docker.mdx#providing-a-license-in-) - * [Setting a `RAVEN_License` Environment Variable](../../start/licensing/license-under-docker.mdx#setting-a--environment-variable) - * [Licensing RavenDB under Linux](../../start/licensing/license-under-docker.mdx#licensing-ravendb-under-linux) + * [Prerequisites](#prerequisites) + * [Licensing a RavenDB docker image](#licensing-a-ravendb-docker-image) + * [Passing a Path to the License File via CLI](#passing-a-path-to-the-license-file-via-cli) + * [Providing a License in `settings.json`](#providing-a-license-in-) + * [Setting a `RAVEN_License` Environment Variable](#setting-a--environment-variable) + * [Licensing RavenDB under Linux](#licensing-ravendb-under-linux) ## Prerequisites @@ -85,7 +85,7 @@ Provide the license as a property of the `settings.json` configuration file in o * Add `settings.json` the **full license string** as the value of the "License" key [as explained here](../../server/configuration/license-configuration.mdx). - Mount `settings.json` as [explained above](../../start/licensing/license-under-docker.mdx#passing-a-path-to-the-license-file-via-cli), + Mount `settings.json` as [explained above](#passing-a-path-to-the-license-file-via-cli), using the location of `settings.json` instead of the location of a license file. * Alternatively, add `settings.json` the **license path** as the value of the “License.Path” key and mount the license directory. diff --git a/versioned_docs/version-7.1/start/licensing/licensing-faq.mdx b/versioned_docs/version-7.1/start/licensing/licensing-faq.mdx index aa05a8b290..b0746d874f 100644 --- a/versioned_docs/version-7.1/start/licensing/licensing-faq.mdx +++ b/versioned_docs/version-7.1/start/licensing/licensing-faq.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Below are answers to frequently asked questions about RavenDB licensing. * On this page: - * [My RavenDB 5.x license doesn't work with RavenDB 6.x](../../start/licensing/licensing-faq.mdx#my-ravendb-5x-license-doesnt-work-with-ravendb-6x) - * [My license is about to expire, what will happen if it does?](../../start/licensing/licensing-faq.mdx#my-license-is-about-to-expire-what-will-happen-if-it-does) - * [My Community license forces me to upgrade RavenDB when I open Studio](../../start/licensing/licensing-faq.mdx#my-community-license-forces-me-to-upgrade-ravendb-when-i-open-studio) - * [When I try to activate my license I get LicenseExpiredException](../../start/licensing/licensing-faq.mdx#when-i-try-to-activate-my-license-i-get-licenseexpiredexception) - * [Validating my license on an RHEL 9 machine fails with InvalidDataException](../../start/licensing/licensing-faq.mdx#validating-my-license-on-an-rhel-9-machine-fails-with-invaliddataexception) - * [ISV License Cannot Be upgraded via Online Tool](../../start/licensing/licensing-faq.mdx#isv-license-cannot-be-upgraded-via-online-tool) - * [Developer license fails activation with a certificate for more than 4 months](../../start/licensing/licensing-faq.mdx#developer-license-fails-activation-with-a-certificate-for-more-than-4-months) + * [My RavenDB 5.x license doesn't work with RavenDB 6.x](#my-ravendb-5x-license-doesnt-work-with-ravendb-6x) + * [My license is about to expire, what will happen if it does?](#my-license-is-about-to-expire-what-will-happen-if-it-does) + * [My Community license forces me to upgrade RavenDB when I open Studio](#my-community-license-forces-me-to-upgrade-ravendb-when-i-open-studio) + * [When I try to activate my license I get LicenseExpiredException](#when-i-try-to-activate-my-license-i-get-licenseexpiredexception) + * [Validating my license on an RHEL 9 machine fails with InvalidDataException](#validating-my-license-on-an-rhel-9-machine-fails-with-invaliddataexception) + * [ISV License Cannot Be upgraded via Online Tool](#isv-license-cannot-be-upgraded-via-online-tool) + * [Developer license fails activation with a certificate for more than 4 months](#developer-license-fails-activation-with-a-certificate-for-more-than-4-months) diff --git a/versioned_docs/version-7.1/start/licensing/licensing-overview.mdx b/versioned_docs/version-7.1/start/licensing/licensing-overview.mdx index 30cf7fc1d3..9aa0a03ab9 100644 --- a/versioned_docs/version-7.1/start/licensing/licensing-overview.mdx +++ b/versioned_docs/version-7.1/start/licensing/licensing-overview.mdx @@ -27,14 +27,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; To renew your license see [renew license](../../start/licensing/renew-license.mdx). * In this page: - * [License types](../../start/licensing/licensing-overview.mdx#license-types) - * [Developer](../../start/licensing/licensing-overview.mdx#developer) - * [Community](../../start/licensing/licensing-overview.mdx#community) - * [Professional](../../start/licensing/licensing-overview.mdx#professional) - * [Enterprise](../../start/licensing/licensing-overview.mdx#enterprise) - * [ISV Licenses](../../start/licensing/licensing-overview.mdx#isv-licenses) - * [ISV Bank-of-Cores License](../../start/licensing/licensing-overview.mdx#isv-bank-of-cores-license) - * [Manage license view](../../start/licensing/licensing-overview.mdx#manage-license-view) + * [License types](#license-types) + * [Developer](#developer) + * [Community](#community) + * [Professional](#professional) + * [Enterprise](#enterprise) + * [ISV Licenses](#isv-licenses) + * [ISV Bank-of-Cores License](#isv-bank-of-cores-license) + * [Manage license view](#manage-license-view) ## License types diff --git a/versioned_docs/version-7.1/start/licensing/renew-license.mdx b/versioned_docs/version-7.1/start/licensing/renew-license.mdx index 829c2c94b8..6c69ed4c1b 100644 --- a/versioned_docs/version-7.1/start/licensing/renew-license.mdx +++ b/versioned_docs/version-7.1/start/licensing/renew-license.mdx @@ -22,8 +22,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Renew your license** as described below. * In this page: - * [Renew commercial licenses](../../start/licensing/renew-license.mdx#renew-commercial-licenses) - * [Renew Developer & Community licenses](../../start/licensing/renew-license.mdx#renew-developer--community-licenses) + * [Renew commercial licenses](#renew-commercial-licenses) + * [Renew Developer & Community licenses](#renew-developer--community-licenses) ## Renew commercial licenses diff --git a/versioned_docs/version-7.1/start/licensing/replace-license.mdx b/versioned_docs/version-7.1/start/licensing/replace-license.mdx index 5e4e6f4a32..672fe477b5 100644 --- a/versioned_docs/version-7.1/start/licensing/replace-license.mdx +++ b/versioned_docs/version-7.1/start/licensing/replace-license.mdx @@ -21,12 +21,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * If you upgrade to RavenDB 6.0, you need to upgrade your current license key before applying it to the new version. Use our online license upgrade tool - as explained [below](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) + as explained [below](#upgrade-a-license-key-for-ravendb-6x) to upgrade your key. * In this page: - * [Replace license from Studio](../../start/licensing/replace-license.mdx#replace-license-from-studio) - * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) + * [Replace license from Studio](#replace-license-from-studio) + * [Upgrade a License Key For RavenDB 6.x](#upgrade-a-license-key-for-ravendb-6x) ## Replace license from Studio @@ -54,7 +54,7 @@ using our online [License upgrade tool](https://ravendb.net/l/8O2YU1). ![Replace License Tool](./assets/replace-license_replace-license-tool.png) A new key will be sent to the email address you registered your current license with. -[Replace](../../start/licensing/replace-license.mdx#replace-license-from-studio) your current key with the new one. +[Replace](#replace-license-from-studio) your current key with the new one. diff --git a/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx b/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx index ccae758f2d..e1b4757376 100644 --- a/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx +++ b/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx @@ -22,10 +22,10 @@ Customize the cluster dashboard according to your needs by: * **Repositioning** widgets * In this page: - * [Remove Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#remove-widget) - * [Add Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#add-widget) - * [Resize Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#resize-widget) - * [Reposition Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#reposition-widget) + * [Remove Widget](#remove-widget) + * [Add Widget](#add-widget) + * [Resize Widget](#resize-widget) + * [Reposition Widget](#reposition-widget) ## Remove Widget @@ -38,7 +38,7 @@ To remove a widget from the cluster dashboard - Removing a widget is **reversible**. - To return a widget that's been removed, [Add it](../../../studio/cluster/cluster-dashboard/cluster-dashboard-customize.mdx#add-widget) + To return a widget that's been removed, [Add it](#add-widget) to the cluster dashboard. diff --git a/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx b/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx index 8b91d491ef..8ca0f63cb8 100644 --- a/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx +++ b/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx @@ -19,9 +19,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The cluster dashboard can be freely rearranged by adding, removing, relocating, and resizing widgets. * In this page: - * [Initial Display](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#cluster-dashboard-initial-display) - * [Widgets Display](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#cluster-dashboard-widgets-display) - * [Setup changes](../../../studio/cluster/cluster-dashboard/cluster-dashboard-overview.mdx#setup-changes) + * [Initial Display](#cluster-dashboard-initial-display) + * [Widgets Display](#cluster-dashboard-widgets-display) + * [Setup changes](#setup-changes) ## Cluster Dashboard Initial Display diff --git a/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx b/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx index abca1b680a..67c3d0dd3b 100644 --- a/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx +++ b/versioned_docs/version-7.1/studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx @@ -18,16 +18,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Information is displayed for all cluster nodes. * Available Widgets: - * [Let's Get Started Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#let) - * [CPU Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#cpu-widget) - * [Memory Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#memory-widget) - * [Traffic Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#traffic-widget) - * [Traffic Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#traffic-per-database-widget) - * [Indexing Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#indexing-widget) - * [Indexing Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#indexing-per-database-widget) - * [Storage Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#storage-widget) - * [Storage Per Database Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#storage-per-database-widget) - * [License Widget](../../../studio/cluster/cluster-dashboard/cluster-dashboard-widgets.mdx#license-widget) + * [Let's Get Started Widget](#let) + * [CPU Widget](#cpu-widget) + * [Memory Widget](#memory-widget) + * [Traffic Widget](#traffic-widget) + * [Traffic Per Database Widget](#traffic-per-database-widget) + * [Indexing Widget](#indexing-widget) + * [Indexing Per Database Widget](#indexing-per-database-widget) + * [Storage Widget](#storage-widget) + * [Storage Per Database Widget](#storage-per-database-widget) + * [License Widget](#license-widget) ## Let's Get Started Widget diff --git a/versioned_docs/version-7.1/studio/cluster/cluster-view.mdx b/versioned_docs/version-7.1/studio/cluster/cluster-view.mdx index 15403c21c2..2567e9cb2b 100644 --- a/versioned_docs/version-7.1/studio/cluster/cluster-view.mdx +++ b/versioned_docs/version-7.1/studio/cluster/cluster-view.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; working to achieve the same goal. * Using the Raft consensus protocol, the cluster distributes work among the various nodes, handles failures, recovery, and more. - The cluster Member nodes elect a [Leader](../../studio/cluster/cluster-view.mdx#cluster-nodes-types) - a node that manages the cluster state. + The cluster Member nodes elect a [Leader](#cluster-nodes-types) - a node that manages the cluster state. * This view shows your cluster's current state and structure. @@ -29,12 +29,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * And much more * In this page: - * [Cluster View Stats](../../studio/cluster/cluster-view.mdx#cluster-view-stats) - * [Cluster View Operations](../../studio/cluster/cluster-view.mdx#cluster-view-operations) - * [Reassign Cores](../../studio/cluster/cluster-view.mdx#reassign-cores) - * [Cluster Nodes Types](../../studio/cluster/cluster-view.mdx#cluster-nodes-types) - * [Cluster Nodes States & Types Flow](../../studio/cluster/cluster-view.mdx#cluster-nodes-states--types-flow) - * [Cluster-Wide operation -vs- Database Operations](../../studio/cluster/cluster-view.mdx#cluster-wide-operation--vs--database-operations) + * [Cluster View Stats](#cluster-view-stats) + * [Cluster View Operations](#cluster-view-operations) + * [Reassign Cores](#reassign-cores) + * [Cluster Nodes Types](#cluster-nodes-types) + * [Cluster Nodes States & Types Flow](#cluster-nodes-states--types-flow) + * [Cluster-Wide operation -vs- Database Operations](#cluster-wide-operation--vs--database-operations) ## Cluster View Stats diff --git a/versioned_docs/version-7.1/studio/cluster/setting-a-cluster.mdx b/versioned_docs/version-7.1/studio/cluster/setting-a-cluster.mdx index 055855231f..8f7954fa22 100644 --- a/versioned_docs/version-7.1/studio/cluster/setting-a-cluster.mdx +++ b/versioned_docs/version-7.1/studio/cluster/setting-a-cluster.mdx @@ -27,9 +27,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Creating a database on this server * In this page: - * [Bootstrap Cluster](../../studio/cluster/setting-a-cluster.mdx#bootstrap-cluster) - * [Add Another Node to the Cluster](../../studio/cluster/setting-a-cluster.mdx#add-another-node-to-the-cluster) - * [A Cluster with 2 nodes](../../studio/cluster/setting-a-cluster.mdx#a-cluster-with-2-nodes) + * [Bootstrap Cluster](#bootstrap-cluster) + * [Add Another Node to the Cluster](#add-another-node-to-the-cluster) + * [A Cluster with 2 nodes](#a-cluster-with-2-nodes) ## Bootstrap Cluster diff --git a/versioned_docs/version-7.1/studio/database/code-assistance.mdx b/versioned_docs/version-7.1/studio/database/code-assistance.mdx index 101378cba4..8e3e881ce2 100644 --- a/versioned_docs/version-7.1/studio/database/code-assistance.mdx +++ b/versioned_docs/version-7.1/studio/database/code-assistance.mdx @@ -31,8 +31,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; views. * In this page: - * [Auto-Completion](../../studio/database/code-assistance.mdx#auto-completion) - * [Syntax Verification](../../studio/database/code-assistance.mdx#syntax-verification) + * [Auto-Completion](#auto-completion) + * [Syntax Verification](#syntax-verification) ## Auto-Completion diff --git a/versioned_docs/version-7.1/studio/database/create-new-database/from-backup.mdx b/versioned_docs/version-7.1/studio/database/create-new-database/from-backup.mdx index 3d10b22721..0ccfd7f6a9 100644 --- a/versioned_docs/version-7.1/studio/database/create-new-database/from-backup.mdx +++ b/versioned_docs/version-7.1/studio/database/create-new-database/from-backup.mdx @@ -17,11 +17,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; Backups can be easily restored using RavenDB Studio. * In this page: - * [New Database From Backup - Studio Databases View](../../../studio/database/create-new-database/from-backup.mdx#new-database-from-backup---studio-databases-view) - * [New Database From Backup - Studio Backups View](../../../studio/database/create-new-database/from-backup.mdx#new-database-from-backup---studio-backups-view) - * [Backup Source Configuration](../../../studio/database/create-new-database/from-backup.mdx#backup-source-configuration) - * [Setting Up High Availability After Restoration](../../../studio/database/create-new-database/from-backup.mdx#setting-up-high-availability-after-restoration) - * [Importing Backups into a Sharded Database](../../../studio/database/create-new-database/from-backup.mdx#importing-backups-into-a-sharded-database) + * [New Database From Backup - Studio Databases View](#new-database-from-backup---studio-databases-view) + * [New Database From Backup - Studio Backups View](#new-database-from-backup---studio-backups-view) + * [Backup Source Configuration](#backup-source-configuration) + * [Setting Up High Availability After Restoration](#setting-up-high-availability-after-restoration) + * [Importing Backups into a Sharded Database](#importing-backups-into-a-sharded-database) ## New Database From Backup - Studio Databases View diff --git a/versioned_docs/version-7.1/studio/database/create-new-database/from-legacy-files.mdx b/versioned_docs/version-7.1/studio/database/create-new-database/from-legacy-files.mdx index c0bcb36a6f..f3c7ebb82d 100644 --- a/versioned_docs/version-7.1/studio/database/create-new-database/from-legacy-files.mdx +++ b/versioned_docs/version-7.1/studio/database/create-new-database/from-legacy-files.mdx @@ -17,8 +17,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; This database creation option is designed for importing database from data files from RavenDB v3.x. * In this page: - * [1. Creating New Database From Legacy Files](../../../studio/database/create-new-database/from-legacy-files.mdx#1-creating-new-database-from-legacy-files) - * [2. Data Source Configuration](../../../studio/database/create-new-database/from-legacy-files.mdx#2-data-source-configuration) + * [1. Creating New Database From Legacy Files](#1-creating-new-database-from-legacy-files) + * [2. Data Source Configuration](#2-data-source-configuration) ## 1. Creating New Database From Legacy Files diff --git a/versioned_docs/version-7.1/studio/database/create-new-database/general-flow.mdx b/versioned_docs/version-7.1/studio/database/create-new-database/general-flow.mdx index 6337c6be88..392212af02 100644 --- a/versioned_docs/version-7.1/studio/database/create-new-database/general-flow.mdx +++ b/versioned_docs/version-7.1/studio/database/create-new-database/general-flow.mdx @@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * From the Studio, the database creation options are: - * **Regular** database - see [below](../../../studio/database/create-new-database/general-flow.mdx#1-new-database). + * **Regular** database - see [below](#1-new-database). * **Encrypted** database - see [Encrypted Database](../../../studio/database/create-new-database/encrypted.mdx). * Create a database from a **Backup** copy - see [From Backup](../../../studio/database/create-new-database/from-backup.mdx). * Create a database from a **Previous** RavenDB version database - see [From Legacy File](../../../studio/database/create-new-database/from-legacy-files.mdx). @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To create a new database using the Client API, see [Create database operation](../../../client-api/operations/server-wide/create-database.mdx). * In this article: - * [1. New Database](../../../studio/database/create-new-database/general-flow.mdx#1-new-database) - * [2. Database Name](../../../studio/database/create-new-database/general-flow.mdx#2-database-name) - * [3. Configure Replication](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) - * [4. Configure Path](../../../studio/database/create-new-database/general-flow.mdx#4-configure-path) - * [5. Create](../../../studio/database/create-new-database/general-flow.mdx#5-create) + * [1. New Database](#1-new-database) + * [2. Database Name](#2-database-name) + * [3. Configure Replication](#3-configure-replication) + * [4. Configure Path](#4-configure-path) + * [5. Create](#5-create) ## 1. New Database diff --git a/versioned_docs/version-7.1/studio/database/databases-list-view.mdx b/versioned_docs/version-7.1/studio/database/databases-list-view.mdx index b2fa9fcdf4..3222e1c32c 100644 --- a/versioned_docs/version-7.1/studio/database/databases-list-view.mdx +++ b/versioned_docs/version-7.1/studio/database/databases-list-view.mdx @@ -19,11 +19,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions can be performed on each database * In this page: - * [Database Stats](../../studio/database/databases-list-view.mdx#database-stats) - * [Database Actions](../../studio/database/databases-list-view.mdx#database-actions) - * [Creating New Database Options](../../studio/database/databases-list-view.mdx#creating-new-database-options) - * [More Actions](../../studio/database/databases-list-view.mdx#more-actions) - * [Remote Database](../../studio/database/databases-list-view.mdx#remote-database) + * [Database Stats](#database-stats) + * [Database Actions](#database-actions) + * [Creating New Database Options](#creating-new-database-options) + * [More Actions](#more-actions) + * [Remote Database](#remote-database) ## Database Stats @@ -37,7 +37,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * ***Disabled*** - the database has been disabled. * Note: - If the database is contained in a cluster's node that is different than the node that is currently viewed in this Studio instance, then 'Remote' will be indicated - see more [below](../../studio/database/databases-list-view.mdx#remote-database). + If the database is contained in a cluster's node that is different than the node that is currently viewed in this Studio instance, then 'Remote' will be indicated - see more [below](#remote-database). 2. **Containing nodes** These are the nodes that contain a copy of the database. @@ -70,7 +70,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Figure 2. Database Actions](./assets/database-actions-1.png) 1. **Create new database** - A new database can be created from scratch, from a backup copy, or from existing 3.x data - see more [below](../../studio/database/databases-list-view.mdx#creating-new-database-options). + A new database can be created from scratch, from a backup copy, or from existing 3.x data - see more [below](#creating-new-database-options). 2. **Manage group** Click to manage the nodes that contain this database - see more about [The Database Group](../../studio/database/settings/manage-database-group.mdx). @@ -79,7 +79,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; A disabled database cannot be accessed. 4. **More actions** - Pause indexing, Disable indexing, Compact database - see more [below](../../studio/database/databases-list-view.mdx#more-actions). + Pause indexing, Disable indexing, Compact database - see more [below](#more-actions). 5. **Refresh data** Refresh the database stats data in this view from the server. diff --git a/versioned_docs/version-7.1/studio/database/document-extensions/counters.mdx b/versioned_docs/version-7.1/studio/database/document-extensions/counters.mdx index 5ffdfdca22..172bc80968 100644 --- a/versioned_docs/version-7.1/studio/database/document-extensions/counters.mdx +++ b/versioned_docs/version-7.1/studio/database/document-extensions/counters.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Create and manage Counters using [API methods](../../../document-extensions/counters/overview.mdx) or through the Studio. * In this page: - * [Viewing Counters Data](../../../studio/database/document-extensions/counters.mdx#viewing-counters-data) - * [Managing Counters](../../../studio/database/document-extensions/counters.mdx#managing-counters) - * [Counters Export and Import](../../../studio/database/document-extensions/counters.mdx#counters-export-and-import) + * [Viewing Counters Data](#viewing-counters-data) + * [Managing Counters](#managing-counters) + * [Counters Export and Import](#counters-export-and-import) ## Viewing Counters Data diff --git a/versioned_docs/version-7.1/studio/database/document-extensions/revisions/all-revisions.mdx b/versioned_docs/version-7.1/studio/database/document-extensions/revisions/all-revisions.mdx index d7ce462217..18fd674d8a 100644 --- a/versioned_docs/version-7.1/studio/database/document-extensions/revisions/all-revisions.mdx +++ b/versioned_docs/version-7.1/studio/database/document-extensions/revisions/all-revisions.mdx @@ -26,7 +26,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Deleting revisions**: * From this view, you can manually delete selected revisions ("Regular Revisions" only). - Other available deletion methods are summarized in [All ways to delete revisions](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#all-ways-to-delete-revisions). + Other available deletion methods are summarized in [All ways to delete revisions](#all-ways-to-delete-revisions). * Removing revisions from a secure server requires a client certificate with an [Admin](../../../../server/security/authorization/security-clearance-and-permissions.mdx#section) or higher security clearance. @@ -36,9 +36,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Once a revision is removed, it will no longer be available and will Not be listed in this view. * In this page: - * [Opening the All Revisions view](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#opening-the-all-revisions-view) - * [Using the All Revisions view](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#using-the-all-revisions-view) - * [All ways to delete revisions](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#all-ways-to-delete-revisions) + * [Opening the All Revisions view](#opening-the-all-revisions-view) + * [Using the All Revisions view](#using-the-all-revisions-view) + * [All ways to delete revisions](#all-ways-to-delete-revisions) ## Opening the All Revisions view @@ -110,7 +110,7 @@ To access the All Revisions view, go to **Documents > All Revisions** **Deleting "Regular Revisions"**: * "Regular Revisions" can be manually deleted from the All Revisions view. - See [using the All Revisions view](../../../../studio/database/document-extensions/revisions/all-revisions.mdx#using-the-all-revisions-view). + See [using the All Revisions view](#using-the-all-revisions-view). * These revisions can also be deleted through the [Delete revisions operation](../../../../document-extensions/revisions/client-api/operations/delete-revisions.mdx) in the Client API. diff --git a/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-bin.mdx b/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-bin.mdx index 46fae13365..d4cd6b29b4 100644 --- a/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-bin.mdx +++ b/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-bin.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; From this view, you can access these revisions or permanently delete them if needed. * In this page: - * [Overview](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#overview) - * [The Revisions Bin view](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#the-revisions-bin-view) - * [Restoring revisions](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#restoring-revisions) + * [Overview](#overview) + * [The Revisions Bin view](#the-revisions-bin-view) + * [Restoring revisions](#restoring-revisions) ## Overview @@ -58,7 +58,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Restoring revisions**: * Revisions of a deleted document can be restored from the Revisions Bin and associated with a new document. - Learn more [below](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx#restoring-revisions). + Learn more [below](#restoring-revisions). diff --git a/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-overview.mdx b/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-overview.mdx index 32a6baaf26..f270b44535 100644 --- a/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-overview.mdx +++ b/versioned_docs/version-7.1/studio/database/document-extensions/revisions/revisions-overview.mdx @@ -25,9 +25,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To see all revisions in the database, go to the [All Revisions](../../../../studio/database/document-extensions/revisions/all-revisions.mdx) view. * To access revisions of deleted documents, go to the [Revisions Bin](../../../../studio/database/document-extensions/revisions/revisions-bin.mdx) view. * In this page: - * [Revisions tab](../../../../studio/database/document-extensions/revisions/revisions-overview.mdx#revisions-tab) - * [Revision inspection](../../../../studio/database/document-extensions/revisions/revisions-overview.mdx#revision-inspection) - * [Revisions comparison](../../../../studio/database/document-extensions/revisions/revisions-overview.mdx#revisions-comparison) + * [Revisions tab](#revisions-tab) + * [Revision inspection](#revision-inspection) + * [Revisions comparison](#revisions-comparison) ## Revisions tab diff --git a/versioned_docs/version-7.1/studio/database/document-extensions/time-series.mdx b/versioned_docs/version-7.1/studio/database/document-extensions/time-series.mdx index 942df7b41d..b5e35e6882 100644 --- a/versioned_docs/version-7.1/studio/database/document-extensions/time-series.mdx +++ b/versioned_docs/version-7.1/studio/database/document-extensions/time-series.mdx @@ -21,19 +21,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * An **Incremental Time Series** is a special type of time series that allows you to handle time series values as counters. Read more about incremental time series [here](../../../document-extensions/timeseries/incremental-time-series/overview.mdx), - and learn how to define them through Studio [below](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series). + and learn how to define them through Studio [below](#incremental-time-series). * In this page: - * [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) - * [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) - * [Create new Time Series (by Creating the First Entry)](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-its-first-entry) - * [Editing an Entry](../../../studio/database/document-extensions/time-series.mdx#editing-an-entry) - * [Deleting a Range of Entries](../../../studio/database/document-extensions/time-series.mdx#deleting-a-range-of-entries) - * [Querying Time Series](../../../studio/database/document-extensions/time-series.mdx#querying-time-series) - * [Results in Graph View](../../../studio/database/document-extensions/time-series.mdx#results-in-graph-view) - * [Incremental Time Series](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series) - * [Creating a new Incremental Time Series (by Creating its First Entry)](../../../studio/database/document-extensions/time-series.mdx#creating-a-new-incremental-time-series-by-creating-its-first-entry) - * [Editing an Incremental Time Series Entry](../../../studio/database/document-extensions/time-series.mdx#editing-an-incremental-time-series-entry) + * [Document View](#document-view) + * [Time Series View](#time-series-view) + * [Create new Time Series (by Creating the First Entry)](#create-new-time-series-by-creating-its-first-entry) + * [Editing an Entry](#editing-an-entry) + * [Deleting a Range of Entries](#deleting-a-range-of-entries) + * [Querying Time Series](#querying-time-series) + * [Results in Graph View](#results-in-graph-view) + * [Incremental Time Series](#incremental-time-series) + * [Creating a new Incremental Time Series (by Creating its First Entry)](#creating-a-new-incremental-time-series-by-creating-its-first-entry) + * [Editing an Incremental Time Series Entry](#editing-an-incremental-time-series-entry) @@ -45,7 +45,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. To view a document's time series, open its [document view](../../../studio/database/documents/document-view.mdx) and click the time series tab on the right. -2. Click 'Add Time Series' to create a new time series [see more below](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-its-first-entry). +2. Click 'Add Time Series' to create a new time series [see more below](#create-new-time-series-by-creating-its-first-entry). 3. Click to view and modify time series data. @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * A. Time series info: * B. **Name** - [Incremental Time Series](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series) + [Incremental Time Series](#incremental-time-series) names always begin with `INC:` E.g. **INC: Downloads** in the first time series listed above. @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Click to select another time series. -2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a [new time series](../../../studio/database/document-extensions/time-series.mdx#create-new-time-series-by-creating-the-first-entry). +2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a [new time series](#create-new-time-series-by-creating-the-first-entry). 3. Delete all entries from a specified time range. 4. Edit entry. @@ -93,7 +93,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; once all entries have been deleted). * Click the **Add Time Series** button from the - [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) + [Document View](#document-view) to create the time series' first entry. ![Add Time Series](./assets/new-time-series.png) @@ -103,7 +103,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. **Time Series Type** * **Diasble** to create a **non-incremental time series**. - (Learn now to create an incremental time series [here](../../../studio/database/document-extensions/time-series.mdx#incremental-time-series)) + (Learn now to create an incremental time series [here](#incremental-time-series)) 2. **Time Series Name** * Enter time series' name. * Name cannot start with 'INC:' as this prefix is reserved for incremental time series. @@ -121,7 +121,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ### Editing an Entry * Click the **Edit Item** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to edit a time series' entry. ![Edit Time Series](./assets/edit-time-series.png) @@ -138,7 +138,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ### Deleting a Range of Entries * Click the **Delete Range** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to delete a range of time series entries. ![Delete Range Button](./assets/delete-range-button.png) @@ -253,7 +253,7 @@ To specify a range of time series entries: once all entries have been deleted). * Click the **Add Time Series** button from the - [Document View](../../../studio/database/document-extensions/time-series.mdx#document-view) + [Document View](#document-view) to create the incremental time series' first entry. ![Add Time Series](./assets/new-time-series.png) @@ -279,7 +279,7 @@ To specify a range of time series entries: ### Editing an Incremental Time Series Entry * Click the **Edit Item** button from the - [Time Series View](../../../studio/database/document-extensions/time-series.mdx#time-series-view) + [Time Series View](#time-series-view) to edit a time series' entry. ![Edit Time Series](./assets/edit-incremental-time-series.png) diff --git a/versioned_docs/version-7.1/studio/database/documents/create-new-document.mdx b/versioned_docs/version-7.1/studio/database/documents/create-new-document.mdx index ef2443ab36..d560e93b1b 100644 --- a/versioned_docs/version-7.1/studio/database/documents/create-new-document.mdx +++ b/versioned_docs/version-7.1/studio/database/documents/create-new-document.mdx @@ -28,10 +28,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * For a full description of the different ID types, see [Document Identifier Generation](../../../server/kb/document-identifier-generation.mdx). * In this article: - * [Create new document](../../../studio/database/documents/create-new-document.mdx#create-new-document) - * [Create new document in current collection](../../../studio/database/documents/create-new-document.mdx#create-new-document-in-current-collection) - * [Clone an existing document](../../../studio/database/documents/create-new-document.mdx#clone-an-existing-document) - * [Document ID types - examples](../../../studio/database/documents/create-new-document.mdx#document-id-types---examples) + * [Create new document](#create-new-document) + * [Create new document in current collection](#create-new-document-in-current-collection) + * [Clone an existing document](#clone-an-existing-document) + * [Document ID types - examples](#document-id-types---examples) ## Create new document @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Figure 2. Edit the new document](./assets/create-new-document-2.png) -* 1 - **Enter document ID** - see the [examples](../../../studio/database/documents/create-new-document.mdx#document-id-types---examples) below. +* 1 - **Enter document ID** - see the [examples](#document-id-types---examples) below. * Any collection name can be entered as a prefix. * The collection name will be created if it doesn't exist yet. * If no collection name is specified, i.e. the ID string doesn't end with ( / ) or ( | ), @@ -68,7 +68,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 1 - **Enter document ID** * The current collection name is initially suggested. * Any other collection name of your choice can still be entered, - document creation will be handled as described above in [Create New Document](../../../studio/database/documents/create-new-document.mdx#create-new-document). + document creation will be handled as described above in [Create New Document](#create-new-document). * 2 - **Edit document content** * Edit the document fields. @@ -76,7 +76,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; then the initial document content showing will be those fields. (In the above example the fields are: _ID Type_ & _Name_) * If not all documents share the exact same fields, - then the initial document content will be just the initial template as in [Create New Document](../../../studio/database/documents/create-new-document.mdx#create-new-document). + then the initial document content will be just the initial template as in [Create New Document](#create-new-document). * 3 - Click **Save** when done. diff --git a/versioned_docs/version-7.1/studio/database/documents/document-view.mdx b/versioned_docs/version-7.1/studio/database/documents/document-view.mdx index 5b9d76594f..5032f1b714 100644 --- a/versioned_docs/version-7.1/studio/database/documents/document-view.mdx +++ b/versioned_docs/version-7.1/studio/database/documents/document-view.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Actions such as cloning the document, deleting, adding attachments, and much more can be performed. * In this page: - * [Document View](../../../studio/database/documents/document-view.mdx#the-document-view) - * [Documents View - Actions](../../../studio/database/documents/document-view.mdx#document-view---actions) + * [Document View](#the-document-view) + * [Documents View - Actions](#document-view---actions) ## The Document View diff --git a/versioned_docs/version-7.1/studio/database/documents/documents-and-collections.mdx b/versioned_docs/version-7.1/studio/database/documents/documents-and-collections.mdx index 40aa885c1b..f2bf540ebc 100644 --- a/versioned_docs/version-7.1/studio/database/documents/documents-and-collections.mdx +++ b/versioned_docs/version-7.1/studio/database/documents/documents-and-collections.mdx @@ -35,7 +35,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [The Documents View](../../../studio/database/documents/documents-and-collections.mdx#the-documents-view) + * [The Documents View](#the-documents-view) * [The @hilo Collection](../../../studio/database/documents/documents-and-collections.mdx#the-@hilo-collection) * [The @empty Collection](../../../studio/database/documents/documents-and-collections.mdx#the-@empty-collection) diff --git a/versioned_docs/version-7.1/studio/database/documents/identities-view.mdx b/versioned_docs/version-7.1/studio/database/documents/identities-view.mdx index 1a7994fe08..8ac3dfb69a 100644 --- a/versioned_docs/version-7.1/studio/database/documents/identities-view.mdx +++ b/versioned_docs/version-7.1/studio/database/documents/identities-view.mdx @@ -21,10 +21,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Identities values can also be managed from the Client API, see [seed identity operation](../../../client-api/operations/maintenance/identities/seed-identity.mdx). * In this article: - * [What is an identity](../../../studio/database/documents/identities-view.mdx#what-is-an-identity) - * [The latest values](../../../studio/database/documents/identities-view.mdx#the-latest-values) - * [Edit identity value](../../../studio/database/documents/identities-view.mdx#edit-identity-value) - * [Add new identity](../../../studio/database/documents/identities-view.mdx#add-new-identity) + * [What is an identity](#what-is-an-identity) + * [The latest values](#the-latest-values) + * [Edit identity value](#edit-identity-value) + * [Add new identity](#add-new-identity) @@ -55,7 +55,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. **Document ID Prefix** * This string is the collection name for which an identity value was set: - either [via this view](../../../studio/database/documents/identities-view.mdx#add-new-identity), + either [via this view](#add-new-identity), or by creating a document with an identity ID as described [here](../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities). * The string that shows is the collection name + a pipe suffix. diff --git a/versioned_docs/version-7.1/studio/database/documents/patch-view.mdx b/versioned_docs/version-7.1/studio/database/documents/patch-view.mdx index 8654661c9d..415ca5f02e 100644 --- a/versioned_docs/version-7.1/studio/database/documents/patch-view.mdx +++ b/versioned_docs/version-7.1/studio/database/documents/patch-view.mdx @@ -23,11 +23,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Patching a single document](../../../client-api/operations/patching/single-document.mdx) * [Set-based patch operations](../../../client-api/operations/patching/set-based.mdx) * In this article: - * [The patch view](../../../studio/database/documents/patch-view.mdx#the-patch-view) - * [The patch script](../../../studio/database/documents/patch-view.mdx#the-patch-script) - * [Patch configuration](../../../studio/database/documents/patch-view.mdx#patch-configuration) - * [Test patch](../../../studio/database/documents/patch-view.mdx#test-patch) - * [Apply patch](../../../studio/database/documents/patch-view.mdx#apply-patch) + * [The patch view](#the-patch-view) + * [The patch script](#the-patch-script) + * [Patch configuration](#patch-configuration) + * [Test patch](#test-patch) + * [Apply patch](#apply-patch) ## The patch view @@ -40,13 +40,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to view sample patch script syntax. More examples are available [here](../../../client-api/operations/patching/set-based.mdx#examples). 3. **Enter the patch script** - Enter your [Patch script](../../../studio/database/documents/patch-view.mdx#the-patch-script) in this input box. + Enter your [Patch script](#the-patch-script) in this input box. 4. **Apply the patch** Click to apply the patch to the documents selected by the query section of the patch script. - See [Apply patch](../../../studio/database/documents/patch-view.mdx#apply-patch) below. + See [Apply patch](#apply-patch) below. 5. **Test the patch** Click to test your patch without actually applying it to your documents. - See [Test patch](../../../studio/database/documents/patch-view.mdx#test-patch) below. + See [Test patch](#test-patch) below. diff --git a/versioned_docs/version-7.1/studio/database/indexes/create-map-index.mdx b/versioned_docs/version-7.1/studio/database/indexes/create-map-index.mdx index f2921b2800..7139d0e18f 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/create-map-index.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/create-map-index.mdx @@ -18,15 +18,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; that indicate how to index selected document fields, counters, and time series data. * In this page: - * [Edit Index View](../../../studio/database/indexes/create-map-index.mdx#edit-index-view) - * [Test Index](../../../studio/database/indexes/create-map-index.mdx#test-index) - * [Index Fields & Terms](../../../studio/database/indexes/create-map-index.mdx#index-fields--terms) - * [Index Field Options](../../../studio/database/indexes/create-map-index.mdx#index-field-options) - * [Add Compound Field](../../../studio/database/indexes/create-map-index.mdx#add-compound-field) - * [Configuration](../../../studio/database/indexes/create-map-index.mdx#configuration) - * [Additional Assemblies](../../../studio/database/indexes/create-map-index.mdx#additional-assemblies) - * [Additional Sources](../../../studio/database/indexes/create-map-index.mdx#additional-sources) - * [Spatial Field Options](../../../studio/database/indexes/create-map-index.mdx#spatial-field-options) + * [Edit Index View](#edit-index-view) + * [Test Index](#test-index) + * [Index Fields & Terms](#index-fields--terms) + * [Index Field Options](#index-field-options) + * [Add Compound Field](#add-compound-field) + * [Configuration](#configuration) + * [Additional Assemblies](#additional-assemblies) + * [Additional Sources](#additional-sources) + * [Spatial Field Options](#spatial-field-options) ## Edit Index View @@ -40,7 +40,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. Options available for an already saved index: **Copy C#** - Click to view and copy the C# class that defines the index as set in the Studio. **Query** - Click to go the the Query View and query this index. - **Terms** - Click to see the index terms, see [below](../../../studio/database/indexes/create-map-index.mdx#index-fields--terms). + **Terms** - Click to see the index terms, see [below](#index-fields--terms). **Advanced** - Click to dump the raw index or optimize it. **Delete** - Delete this index. @@ -175,7 +175,7 @@ modifications in the index maps and configuration. Hover over a term to Query the index by this term, Preview the term, or Copy the term to the clipboard. Terms are created from the value of the field that was requested to be indexed - by the specified [Field Options](../../../studio/database/indexes/create-map-index.mdx#index-field-options). + by the specified [Field Options](#index-field-options). @@ -190,7 +190,7 @@ modifications in the index maps and configuration. If the Corax search engine is used, compound fields can be added to optimize specific queries. This option is for **expert users only**. * Learn about Corax and compound fields [here](../../../indexes/search-engine/corax.mdx#compound-fields). - * Learn to add a compound field using Studio [below](../../../studio/database/indexes/create-map-index.mdx#add-compound-field). + * Learn to add a compound field using Studio [below](#add-compound-field). 3. **Add default field options** Use this option to set default field options for all indexed fields. @@ -228,7 +228,7 @@ modifications in the index maps and configuration. ask about (i.e. spelling errors). * [Spatial](../../../indexes/querying/spatial.mdx) - See [below](../../../studio/database/indexes/create-map-index.mdx#spatial-field-options) + See [below](#spatial-field-options) 6. **Advanced Options** Click to display or hide these advanced index field options: diff --git a/versioned_docs/version-7.1/studio/database/indexes/create-map-reduce-index.mdx b/versioned_docs/version-7.1/studio/database/indexes/create-map-reduce-index.mdx index 16ffbe6f64..8f2ab6f623 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/create-map-reduce-index.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/create-map-reduce-index.mdx @@ -35,15 +35,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Map-Reduce results can be visualized in the [Map-Reduce Visualizer](../../../studio/database/indexes/map-reduce-visualizer.mdx). * In this page: - * [The Map Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-map-stage) - * [The Reduce Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-reduce-stage) - * [Important Guidelines](../../../studio/database/indexes/create-map-reduce-index.mdx#important-guidelines) - * [Map-Reduce Query Results](../../../studio/database/indexes/create-map-reduce-index.mdx#map-reduce-query-results) - * [Multi-Map-Reduce](../../../studio/database/indexes/create-map-reduce-index.mdx#multi-map-reduce) + * [The Map Stage](#the-map-stage) + * [The Reduce Stage](#the-reduce-stage) + * [Important Guidelines](#important-guidelines) + * [Map-Reduce Query Results](#map-reduce-query-results) + * [Multi-Map-Reduce](#multi-map-reduce) * [Saving Map-Reduce Results into a Collection (Artificial Documents)](../../../studio/database/indexes/create-map-reduce-index.mdx#saving-map-reduce-results-in-a-collection-(artificial-documents)) - * [Artificial -vs- Regular Documents](../../../studio/database/indexes/create-map-reduce-index.mdx#artificial-documents--vs--regular-documents) - * [Artificial Documents Usage](../../../studio/database/indexes/create-map-reduce-index.mdx#artificial-documents-usage) - * [Artificial Documents Limitations](../../../studio/database/indexes/create-map-reduce-index.mdx#limitations) + * [Artificial -vs- Regular Documents](#artificial-documents--vs--regular-documents) + * [Artificial Documents Usage](#artificial-documents-usage) + * [Artificial Documents Limitations](#limitations) ## The Map Stage @@ -81,7 +81,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The accumulative value of this field will represent the total amount spent by a company on _all_ orders. 3. Next, click 'Add Reduction' to continue and add the 'Reduce' function. - See [The Reduce Stage](../../../studio/database/indexes/create-map-reduce-index.mdx#the-reduce-stage). + See [The Reduce Stage](#the-reduce-stage). ## The Reduce Stage diff --git a/versioned_docs/version-7.1/studio/database/indexes/create-multi-map-index.mdx b/versioned_docs/version-7.1/studio/database/indexes/create-multi-map-index.mdx index 9b387992d8..0f3b85fb38 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/create-multi-map-index.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/create-multi-map-index.mdx @@ -22,8 +22,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Multi-Map indexes require that all the Map functions defined have the _same_ output structure. * In this page: - * [Define a Map Function](../../../studio/database/indexes/create-multi-map-index.mdx#define-a-map-function) - * [Add another Map Function](../../../studio/database/indexes/create-multi-map-index.mdx#add-another-map-function) + * [Define a Map Function](#define-a-map-function) + * [Add another Map Function](#add-another-map-function) ## Define a Map Function diff --git a/versioned_docs/version-7.1/studio/database/indexes/index-cleanup.mdx b/versioned_docs/version-7.1/studio/database/indexes/index-cleanup.mdx index 777309738b..7de49e6c57 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/index-cleanup.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/index-cleanup.mdx @@ -28,11 +28,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Merge indexes](../../../studio/database/indexes/index-cleanup.mdx#merge-indexes) - * [Remove sub-indexes](../../../studio/database/indexes/index-cleanup.mdx#remove-sub-indexes) - * [Remove unused indexes](../../../studio/database/indexes/index-cleanup.mdx#remove-unused-indexes) - * [Indexes that will not be merged](../../../studio/database/indexes/index-cleanup.mdx#indexes-that-will-not-be-merged) - * [Merge suggestions errors](../../../studio/database/indexes/index-cleanup.mdx#merge-suggestions-errors) + * [Merge indexes](#merge-indexes) + * [Remove sub-indexes](#remove-sub-indexes) + * [Remove unused indexes](#remove-unused-indexes) + * [Indexes that will not be merged](#indexes-that-will-not-be-merged) + * [Merge suggestions errors](#merge-suggestions-errors) ## Merge indexes diff --git a/versioned_docs/version-7.1/studio/database/indexes/index-history.mdx b/versioned_docs/version-7.1/studio/database/indexes/index-history.mdx index 879d008438..17e5c1c217 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/index-history.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/index-history.mdx @@ -17,7 +17,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * An index revision is created for any change made to the index definition. * By default 10 index revisions are kept. This number can be modified using - the [Database Settings view](../../../studio/database/indexes/index-history.mdx#view-and-update-number-of-index-revisions) + the [Database Settings view](#view-and-update-number-of-index-revisions) or through [configuration](../../../server/configuration/configuration-options.mdx). * The Index History dialog allows you to browse these revisions and revert @@ -26,10 +26,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can revert only the 'Map and Reduce' methods or the full index definition. * In this page: - * [Open Index History Dialog](../../../studio/database/indexes/index-history.mdx#open-index-history-dialog) - * [Index History Dialog](../../../studio/database/indexes/index-history.mdx#index-history-dialog) - * [Select and Load an Index Revision](../../../studio/database/indexes/index-history.mdx#select-and-load-an-index-revision) - * [View and Update Number of Index Revisions](../../../studio/database/indexes/index-history.mdx#view-and-update-number-of-index-revisions) + * [Open Index History Dialog](#open-index-history-dialog) + * [Index History Dialog](#index-history-dialog) + * [Select and Load an Index Revision](#select-and-load-an-index-revision) + * [View and Update Number of Index Revisions](#view-and-update-number-of-index-revisions) ## Open Index History Dialog diff --git a/versioned_docs/version-7.1/studio/database/indexes/indexes-list-view.mdx b/versioned_docs/version-7.1/studio/database/indexes/indexes-list-view.mdx index e588cc72c2..49d304475d 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/indexes-list-view.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/indexes-list-view.mdx @@ -20,11 +20,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; and more. * In this article: - * [Indexes list view](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view) - * [Indexes list view - Actions](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---actions) - * [Indexes list view - Index errors](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---errors) - * [Indexes list view - Side by side indexing](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing) - * [Indexes list view - Rolling deployment](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---rolling-deployment) + * [Indexes list view](#indexes-list-view) + * [Indexes list view - Actions](#indexes-list-view---actions) + * [Indexes list view - Index errors](#indexes-list-view---errors) + * [Indexes list view - Side by side indexing](#indexes-list-view---side-by-side-indexing) + * [Indexes list view - Rolling deployment](#indexes-list-view---rolling-deployment) ## Indexes list view @@ -110,7 +110,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; By default, RavenDB prioritizes request processing over indexing to ensure responsiveness. * **Mode** Set the modification behavior (for static-indexes only): - * Unlocked - Changes to the index definition will be applied. See [Side by side indexing](../../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing). + * Unlocked - Changes to the index definition will be applied. See [Side by side indexing](#indexes-list-view---side-by-side-indexing). * Locked - Changes to the index definition will not be applied. No error is raised. * Locked(Error) - Changes to the index definition will not be applied, and an error is raised when attempting to modify the index. diff --git a/versioned_docs/version-7.1/studio/database/indexes/indexes-overview.mdx b/versioned_docs/version-7.1/studio/database/indexes/indexes-overview.mdx index e3e68bdaf3..e6374e4407 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/indexes-overview.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/indexes-overview.mdx @@ -30,19 +30,19 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Auto-indexes are generated by the server - see [Auto indexes](../../../indexes/creating-and-deploying.mdx#auto-indexes) * In this page: - * [Indexes - The General Concept](../../../studio/database/indexes/indexes-overview.mdx#indexes---the-general-concept) - * [Indexes - The Moving Parts](../../../studio/database/indexes/indexes-overview.mdx#indexes---the-moving-parts) : - * [Index Definition](../../../studio/database/indexes/indexes-overview.mdx#1-index-definition) - * [Indexing Process](../../../studio/database/indexes/indexes-overview.mdx#2-indexing-process) - * [Indexed Data](../../../studio/database/indexes/indexes-overview.mdx#3-indexed-data) - * [Index Types](../../../studio/database/indexes/indexes-overview.mdx#index-types) : - * [Auto Indexes -vs- Static Indexes](../../../studio/database/indexes/indexes-overview.mdx#auto-indexes--vs--static-indexes) - * [Map Indexes -vs- Map-Reduce Indexes](../../../studio/database/indexes/indexes-overview.mdx#map-indexes--vs--map-reduce-indexes) - * [Single-Collection Indexes -vs- Multi-Collection Indexes](../../../studio/database/indexes/indexes-overview.mdx#single-collection-indexes--vs--multi-collection-indexes) - * [Field Configuration Options](../../../studio/database/indexes/indexes-overview.mdx#field-configuration-options) - * [Modifying Index Definition](../../../studio/database/indexes/indexes-overview.mdx#modifying-index-definition) - * [Indexes in the Cluster](../../../studio/database/indexes/indexes-overview.mdx#indexes-in-the-cluster) - * [Indexing Errors](../../../studio/database/indexes/indexes-overview.mdx#indexing-errors) + * [Indexes - The General Concept](#indexes---the-general-concept) + * [Indexes - The Moving Parts](#indexes---the-moving-parts) : + * [Index Definition](#1-index-definition) + * [Indexing Process](#2-indexing-process) + * [Indexed Data](#3-indexed-data) + * [Index Types](#index-types) : + * [Auto Indexes -vs- Static Indexes](#auto-indexes--vs--static-indexes) + * [Map Indexes -vs- Map-Reduce Indexes](#map-indexes--vs--map-reduce-indexes) + * [Single-Collection Indexes -vs- Multi-Collection Indexes](#single-collection-indexes--vs--multi-collection-indexes) + * [Field Configuration Options](#field-configuration-options) + * [Modifying Index Definition](#modifying-index-definition) + * [Indexes in the Cluster](#indexes-in-the-cluster) + * [Indexing Errors](#indexing-errors) @@ -58,7 +58,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * After the first **indexing** run, the index will keep this map current _without_ re-processing the entire dataset - the index will only update the relevant indexed data when a document update happens in the database. -* Indexes in RavenDB are split across multiple axes (see more [below](../../../studio/database/indexes/indexes-overview.mdx#index-types)) +* Indexes in RavenDB are split across multiple axes (see more [below](#index-types)) * Auto Indexes -vs- Static Indexes * Map Indexes -vs- Map-Reduce Indexes diff --git a/versioned_docs/version-7.1/studio/database/indexes/indexing-performance.mdx b/versioned_docs/version-7.1/studio/database/indexes/indexing-performance.mdx index dbcb9386f6..ded03e4f96 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/indexing-performance.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/indexing-performance.mdx @@ -23,14 +23,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Indexing Performance View](../../../studio/database/indexes/indexing-performance.mdx#indexing-performance-view) -* [Types of Index Tracks](../../../studio/database/indexes/indexing-performance.mdx#types-of-index-tracks) -* [Index Statistics View](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view) -* [Common Indexing Issues](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) - - [Resource Exhaustion](../../../studio/database/indexes/indexing-performance.mdx#resource-exhaustion) - - [Low Memory](../../../studio/database/indexes/indexing-performance.mdx#low-memory) - - [Concurrent Processing of Too Many Indexes](../../../studio/database/indexes/indexing-performance.mdx#concurrent-processing-of-too-many-indexes) - - [LoadDocument Misuse](../../../studio/database/indexes/indexing-performance.mdx#loaddocument-misuse) +* [Indexing Performance View](#indexing-performance-view) +* [Types of Index Tracks](#types-of-index-tracks) +* [Index Statistics View](#index-statistics-view) +* [Common Indexing Issues](#common-indexing-issues) + - [Resource Exhaustion](#resource-exhaustion) + - [Low Memory](#low-memory) + - [Concurrent Processing of Too Many Indexes](#concurrent-processing-of-too-many-indexes) + - [LoadDocument Misuse](#loaddocument-misuse) ## Indexing Performance View ![Indexing Performance View](./assets/indexing-performance-overview.png) @@ -55,10 +55,10 @@ In this page: * The red area represents the area that is zoomed in below. Enlarge or shrink it to zoom in and out below. 9. **Auto/Orders/ByOrderedAt** (Expanded Track) * This is one of the various types of indexes that is tracked in time. - * Clicking the index title expands the track (as seen in the **Auto/Orders/ByOrderedAt** image above) to show index [batch process details](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view). + * Clicking the index title expands the track (as seen in the **Auto/Orders/ByOrderedAt** image above) to show index [batch process details](#index-statistics-view). * Varying index types have different processes and they may index different volumes of data, so the graphs are likely to differ from one another. * Each colored stripe shows the duration of a stage in the batch process. - * Hovering over each stripe shows [detailed statistics](../../../studio/database/indexes/indexing-performance.mdx#index-statistics-view) about each stage. + * Hovering over each stripe shows [detailed statistics](#index-statistics-view) about each stage. 10. **Vertical line** Each verticle purple line shows that there was a time-lapse in the timeline before a batch process started. @@ -152,7 +152,7 @@ Click the following links to learn more about defining indexes via the Studio: - **(Name of the method used to create a batch stop)** There are a number of configurations that break up large batch processes into smaller batches to prevent exhausting system resources. While these batch stops prevent system exhaustion, they also point to potential opportunities to optimize your indexes. - These situations are discussed in the section on [common indexing issues](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) + These situations are discussed in the section on [common indexing issues](#common-indexing-issues) 3. **Storage** stages The amount of time it took to read or write the data to disk. * If this stage takes a long time after the index is already built, it may reveal a hardware problem. @@ -176,16 +176,16 @@ While they prevent system exhaustion, batch stops also point to potential **oppo Batch stops break up processes into smaller batches when - - An index is processing a [dataset that is too large](../../../studio/database/indexes/indexing-performance.mdx#resource-exhaustion) for your system resources. + - An index is processing a [dataset that is too large](#resource-exhaustion) for your system resources. - The index definition requires a complex Linq process (in Java - Stream API process) that can exhaust your resources. - - [Low memory](../../../studio/database/indexes/indexing-performance.mdx#low-memory) resources for indexing process on local machines or burstable cloud instances. - - [Too many concurrent index processes](../../../studio/database/indexes/indexing-performance.mdx#concurrent-processing-of-too-many-indexes) are exhausting your system resources. - - The [LoadDocument](../../../studio/database/indexes/indexing-performance.mdx#loaddocument-misuse) method is misused. + - [Low memory](#low-memory) resources for indexing process on local machines or burstable cloud instances. + - [Too many concurrent index processes](#concurrent-processing-of-too-many-indexes) are exhausting your system resources. + - The [LoadDocument](#loaddocument-misuse) method is misused. #### Resource Exhaustion Some indexes are responsible for a huge dataset and/or have very complex, demanding definitions. To prevent resource exhaustion, RavenDB can break up large batches into smaller ones. -You can configure [batch stops](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues) with the following methods: +You can configure [batch stops](#common-indexing-issues) with the following methods: - [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) Number of seconds after which mapping will end even if there is more to map. @@ -195,7 +195,7 @@ You can configure [batch stops](../../../studio/database/indexes/indexing-perfor Maximum number of documents to be processed by the index per indexing batch. #### Low Memory -* [Low Memory](../../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) resources can slow down your system and result in [batch stops](../../../studio/database/indexes/indexing-performance.mdx#common-indexing-issues). +* [Low Memory](../../../server/configuration/memory-configuration.mdx#memorylowmemorylimitinmb) resources can slow down your system and result in [batch stops](#common-indexing-issues). * **On a local machine** * You can upgrade your hardware, divide the work onto more machines in a cluster, and/or optimize your indexes. * Until then, there are a number of [indexing configurations](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that you can configure diff --git a/versioned_docs/version-7.1/studio/database/indexes/map-reduce-visualizer.mdx b/versioned_docs/version-7.1/studio/database/indexes/map-reduce-visualizer.mdx index a5b4651d5f..88c9434e77 100644 --- a/versioned_docs/version-7.1/studio/database/indexes/map-reduce-visualizer.mdx +++ b/versioned_docs/version-7.1/studio/database/indexes/map-reduce-visualizer.mdx @@ -18,8 +18,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; by graphing the relations between the documents and the Map-Reduce results. * In this page: - * [Map-Reduce Visualizer Usage Flow](../../../studio/database/indexes/map-reduce-visualizer.mdx#map-reduce-visualizer-usage-flow) - * [Map-Reduce Visualizer for Big Data](../../../studio/database/indexes/map-reduce-visualizer.mdx#map-reduce-visualizer-for-big-data) + * [Map-Reduce Visualizer Usage Flow](#map-reduce-visualizer-usage-flow) + * [Map-Reduce Visualizer for Big Data](#map-reduce-visualizer-for-big-data) ## Map-Reduce Visualizer Usage Flow diff --git a/versioned_docs/version-7.1/studio/database/queries/query-view.mdx b/versioned_docs/version-7.1/studio/database/queries/query-view.mdx index 0423f08d16..04885f374b 100644 --- a/versioned_docs/version-7.1/studio/database/queries/query-view.mdx +++ b/versioned_docs/version-7.1/studio/database/queries/query-view.mdx @@ -24,11 +24,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Query results can be saved/exported to a CSV file. * In this page: - * [Query View](../../../studio/database/queries/query-view.mdx#query-view) - * [Query Results](../../../studio/database/queries/query-view.mdx#query-results) - * [Select Visible Columns](../../../studio/database/queries/query-view.mdx#select-visible-columns) - * [Result Columns](../../../studio/database/queries/query-view.mdx#result-columns) - * [Additional Query Options](../../../studio/database/queries/query-view.mdx#additional-query-options) + * [Query View](#query-view) + * [Query Results](#query-results) + * [Select Visible Columns](#select-visible-columns) + * [Result Columns](#result-columns) + * [Additional Query Options](#additional-query-options) ## Query View @@ -72,7 +72,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 8. **Run Query** Click to run the query. 9. **Query Results** - The results area displays selected columns of results retrieved by your query (see [below](../../../studio/database/queries/query-view.mdx#query-results)). + The results area displays selected columns of results retrieved by your query (see [below](#query-results)). ## Query Results @@ -112,7 +112,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to expand or collapse the results view. ### Select Visible Columns -To modify the displayed result columns, open the Display drop-down dialog from the [Query Results](../../../studio/database/queries/query-view.mdx#query-results) view. +To modify the displayed result columns, open the Display drop-down dialog from the [Query Results](#query-results) view. Custom result columns can be added, edited and removed. ![Display Dialog](./assets/query-view-display-dialog.png) diff --git a/versioned_docs/version-7.1/studio/database/queries/spatial-queries-map-view.mdx b/versioned_docs/version-7.1/studio/database/queries/spatial-queries-map-view.mdx index 9db1b24bd8..41a4f0c3d3 100644 --- a/versioned_docs/version-7.1/studio/database/queries/spatial-queries-map-view.mdx +++ b/versioned_docs/version-7.1/studio/database/queries/spatial-queries-map-view.mdx @@ -29,13 +29,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Spatial data in documents](../../../studio/database/queries/spatial-queries-map-view.mdx#spatial-data-in-documents) - * [Running a dynamic spatial query](../../../studio/database/queries/spatial-queries-map-view.mdx#running-a-dynamic-spatial-query) - * [Spatial map view](../../../studio/database/queries/spatial-queries-map-view.mdx#spatial-map-view) - * [Examples](../../../studio/database/queries/spatial-queries-map-view.mdx#examples) - * [Circular region example](../../../studio/database/queries/spatial-queries-map-view.mdx#circular-region-example) - * [Polygonal region example](../../../studio/database/queries/spatial-queries-map-view.mdx#polygonal-region-example) - * [Mixed shapes intersection example](../../../studio/database/queries/spatial-queries-map-view.mdx#mixed-shapes-intersection-example) + * [Spatial data in documents](#spatial-data-in-documents) + * [Running a dynamic spatial query](#running-a-dynamic-spatial-query) + * [Spatial map view](#spatial-map-view) + * [Examples](#examples) + * [Circular region example](#circular-region-example) + * [Polygonal region example](#polygonal-region-example) + * [Mixed shapes intersection example](#mixed-shapes-intersection-example) ## Spatial data in documents diff --git a/versioned_docs/version-7.1/studio/database/settings/client-configuration-per-database.mdx b/versioned_docs/version-7.1/studio/database/settings/client-configuration-per-database.mdx index a0fd483f0b..43a5bb8159 100644 --- a/versioned_docs/version-7.1/studio/database/settings/client-configuration-per-database.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/client-configuration-per-database.mdx @@ -29,7 +29,7 @@ import Panel from '@site/src/components/Panel'; For example, adjusting load balancing behavior on the fly in response to changing system demands. * In this article: - * [Set the client configuration (for database)](../../../studio/database/settings/client-configuration-per-database.mdx#set-the-client-configuration-for-database) + * [Set the client configuration (for database)](#set-the-client-configuration-for-database) diff --git a/versioned_docs/version-7.1/studio/database/settings/conflict-resolution.mdx b/versioned_docs/version-7.1/studio/database/settings/conflict-resolution.mdx index a1da5dda08..83e548afca 100644 --- a/versioned_docs/version-7.1/studio/database/settings/conflict-resolution.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/conflict-resolution.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Conflicts that are created can be manually resolved in [Documents Conflicts View](../../../studio/database/documents/conflicts-view.mdx). * In this page: - * [The Conflicts Resolution View](../../../studio/database/settings/conflict-resolution.mdx#the-conflicts-resolution-view) - * [Script Examples](../../../studio/database/settings/conflict-resolution.mdx#script-examples) + * [The Conflicts Resolution View](#the-conflicts-resolution-view) + * [Script Examples](#script-examples) ## The Conflicts Resolution View diff --git a/versioned_docs/version-7.1/studio/database/settings/custom-analyzers.mdx b/versioned_docs/version-7.1/studio/database/settings/custom-analyzers.mdx index 4e4677017c..a231e737f1 100644 --- a/versioned_docs/version-7.1/studio/database/settings/custom-analyzers.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/custom-analyzers.mdx @@ -29,10 +29,10 @@ that come with RavenDB out of the box. It can then be selected when configuring [index field options](../../../studio/database/indexes/create-map-index.mdx#index-field-options). * These views allow you to write your own custom analyzers: - * [Database Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#database-custom-analyzer-view) - * [Server-Wide Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#server-wide-custom-analyzer-view) - * [Edit Custom Analyzer View](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view) - * [Change the Default Analyzers](../../../studio/database/settings/custom-analyzers.mdx#change-the-default-analyzers) + * [Database Custom Analyzer View](#database-custom-analyzer-view) + * [Server-Wide Custom Analyzer View](#server-wide-custom-analyzer-view) + * [Edit Custom Analyzer View](#edit-custom-analyzer-view) + * [Change the Default Analyzers](#change-the-default-analyzers) ## Database Custom Analyzer View @@ -40,9 +40,9 @@ that come with RavenDB out of the box. It can then be selected when configuring ![Figure 1. Database Custom Analyzer View](./assets/custom-analyzer-1.png) -1. Create a new database custom analyzer. Takes you to the analyzer editing view, see [below](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view). +1. Create a new database custom analyzer. Takes you to the analyzer editing view, see [below](#edit-custom-analyzer-view). 2. Edit an existing analyzer. -3. Go to the Server-Wide Custom Analyzer View, see [below](../../../studio/database/settings/custom-analyzers.mdx#server-wide-custom-analyzer-view). +3. Go to the Server-Wide Custom Analyzer View, see [below](#server-wide-custom-analyzer-view). @@ -58,7 +58,7 @@ The database custom analyzer will be the one used by indexes of this database. 1. Create a new server-wide custom analyzer. Takes you to the analyzer editing view, see -[below](../../../studio/database/settings/custom-analyzers.mdx#edit-custom-analyzer-view). +[below](#edit-custom-analyzer-view). 2. Edit an existing analyzer. diff --git a/versioned_docs/version-7.1/studio/database/settings/custom-sorters.mdx b/versioned_docs/version-7.1/studio/database/settings/custom-sorters.mdx index 3364680b36..cb8dd8e29f 100644 --- a/versioned_docs/version-7.1/studio/database/settings/custom-sorters.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/custom-sorters.mdx @@ -30,10 +30,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Once deployed, you can order your query results using the custom sorter. A query example is available [here](../../../client-api/session/querying/sort-query-results.mdx#custom-sorters). * In this page: - * [Database custom sorter view](../../../studio/database/settings/custom-sorters.mdx#database-custom-sorter-view) - * [Server-wide custom sorter view](../../../studio/database/settings/custom-sorters.mdx#server-wide-custom-sorter-view) - * [Add a custom sorter](../../../studio/database/settings/custom-sorters.mdx#add-a-custom-sorter) - * [Test the custom sorter](../../../studio/database/settings/custom-sorters.mdx#test-the-custom-sorter) + * [Database custom sorter view](#database-custom-sorter-view) + * [Server-wide custom sorter view](#server-wide-custom-sorter-view) + * [Add a custom sorter](#add-a-custom-sorter) + * [Test the custom sorter](#test-the-custom-sorter) ## Database custom sorter view @@ -45,12 +45,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Navigate to __Settings > Custom Sorters__. 2. Click to add a new database custom sorter. - See the sorter edit view [below](../../../studio/database/settings/custom-sorters.mdx#add-a-custom-sorter). + See the sorter edit view [below](#add-a-custom-sorter). 3. The custom sorters deployed for this __database__ are listed here. 4. Click to test this custom sorter. - See the test view [below](../../../studio/database/settings/custom-sorters.mdx#test-the-custom-sorter). + See the test view [below](#test-the-custom-sorter). 5. Click to edit this custom sorter. @@ -73,7 +73,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. Navigate to __Manage Server > Server-Wide Sorters__. 2. Click to add a new server-wide custom sorter. - See the sorter edit view [below](../../../studio/database/settings/custom-sorters.mdx#add-a-custom-sorter). + See the sorter edit view [below](#add-a-custom-sorter). 3. The custom sorters deployed __server-wide__ are listed here. diff --git a/versioned_docs/version-7.1/studio/database/settings/database-record.mdx b/versioned_docs/version-7.1/studio/database/settings/database-record.mdx index 6864638db1..b036d427aa 100644 --- a/versioned_docs/version-7.1/studio/database/settings/database-record.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/database-record.mdx @@ -24,8 +24,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Database Record is Not editable * In this page: - * [The Database Record](../../../studio/database/settings/database-record.mdx#the-database-record) - * [The Database Record Fields](../../../studio/database/settings/database-record.mdx#the-database-record-fields) + * [The Database Record](#the-database-record) + * [The Database Record Fields](#the-database-record-fields) diff --git a/versioned_docs/version-7.1/studio/database/settings/database-settings.mdx b/versioned_docs/version-7.1/studio/database/settings/database-settings.mdx index 3266d35eb7..339f89a6dc 100644 --- a/versioned_docs/version-7.1/studio/database/settings/database-settings.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/database-settings.mdx @@ -20,17 +20,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; To edit a server-scope key follow any of the available options listed in the [Configuration overview](../../../server/configuration/configuration-options.mdx) article. * After editing & saving a configuration key, the change does not take effect - until the database is [reloaded](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + until the database is [reloaded](#how-to-reload-the-database). Do not modify the database settings unless you are an expert and know what you're doing. * In this page: - * [View Database Settings](../../../studio/database/settings/database-settings.mdx#view-database-settings) - * [Edit Database Settings](../../../studio/database/settings/database-settings.mdx#edit-database-settings) - * [Database Settings View with Pending Values](../../../studio/database/settings/database-settings.mdx#database-settings-view-with-pending-values) - * [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database) + * [View Database Settings](#view-database-settings) + * [Edit Database Settings](#edit-database-settings) + * [Database Settings View with Pending Values](#database-settings-view-with-pending-values) + * [How to Reload the Database](#how-to-reload-the-database) ## View Database Settings @@ -39,7 +39,7 @@ Do not modify the database settings unless you are an expert and know what you'r 1. Navigate to **Settings > Database Settings**. 2. Type a keyword here to filter the configuration keys. -3. Click on **Edit** to access the database setting editing view. [See next section](../../../studio/database/settings/database-settings.mdx#edit-database-settings). +3. Click on **Edit** to access the database setting editing view. [See next section](#edit-database-settings). 4. This column lists the **Configuration Keys**. * A 'yellow' entry is a key whose value was customized by the user. * A 'green' entry is a key holding a default value that was not modified. @@ -62,7 +62,7 @@ Do not modify the database settings unless you are an expert and know what you'r * Once you save the changes made in this view, all modifications are saved into the [database record](../../../studio/database/settings/database-record.mdx). However, in order for those changes to be in effect, the database must be reloaded. - See [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + See [How to Reload the Database](#how-to-reload-the-database). ![Figure 2: Edit Database Settings](./assets/database-settings-2.png) @@ -82,7 +82,7 @@ Do not modify the database settings unless you are an expert and know what you'r All changes will immediately be written to the database record. However, in this view, the changes will appear as pending and will not be in effect until the database is reloaded. - See [How to Reload the Database](../../../studio/database/settings/database-settings.mdx#how-to-reload-the-database). + See [How to Reload the Database](#how-to-reload-the-database). ### Database Settings View with Pending Values diff --git a/versioned_docs/version-7.1/studio/database/settings/document-revisions.mdx b/versioned_docs/version-7.1/studio/database/settings/document-revisions.mdx index 8c3a8752e0..dfcd1975c4 100644 --- a/versioned_docs/version-7.1/studio/database/settings/document-revisions.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/document-revisions.mdx @@ -19,13 +19,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about revisions [here](../../../document-extensions/revisions/overview.mdx). * In this page: - * [Document revisions view](../../../studio/database/settings/document-revisions.mdx#document-revisions-view) - * [Revisions configuration](../../../studio/database/settings/document-revisions.mdx#revisions-configuration) - * [Define default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) - * [Define collection-specific configuration](../../../studio/database/settings/document-revisions.mdx#define-collection-specific-configuration) - * [Edit conflicting document defaults](../../../studio/database/settings/document-revisions.mdx#edit-conflicting-document-defaults) - * [Conflicting documents example](../../../studio/database/settings/document-revisions.mdx#conflicting-documents-example) - * [Enforce configuration](../../../studio/database/settings/document-revisions.mdx#enforce-configuration) + * [Document revisions view](#document-revisions-view) + * [Revisions configuration](#revisions-configuration) + * [Define default configuration](#define-default-configuration) + * [Define collection-specific configuration](#define-collection-specific-configuration) + * [Edit conflicting document defaults](#edit-conflicting-document-defaults) + * [Conflicting documents example](#conflicting-documents-example) + * [Enforce configuration](#enforce-configuration) @@ -50,7 +50,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Only documents are reverted. Other entities (such as ongoing tasks) are not modified by this process. 5. **Enforce Configuration** - Click to [enforce the revisions configuration](../../../studio/database/settings/document-revisions.mdx#enforce-configuration). + Click to [enforce the revisions configuration](#enforce-configuration). This operation may delete many revisions irrevocably and require substantial server resources. @@ -58,16 +58,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; 6. **Create document defaults** - Click to define [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) + Click to define [default configuration](#define-default-configuration) that will apply to documents in all collections that don't have a collection-specific configuration defined. 7. **Add a collection-specific configuration** - Click to create a [configuration for a specific collection](../../../studio/database/settings/document-revisions.mdx#define-collection-specific-configuration). + Click to create a [configuration for a specific collection](#define-collection-specific-configuration). If default settings were defined, the collection-specific configuration will override them for this collection. 8. **The defined Revisions configuration** - Read more [below](../../../studio/database/settings/document-revisions.mdx#revisions-configuration). + Read more [below](#revisions-configuration). @@ -86,7 +86,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Defined Configuration](./assets/defined-configuration.png) 1. **Document Defaults** - This is the [default revisions configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration) that applies to all non-conflicting documents in all collections + This is the [default revisions configuration](#define-default-configuration) that applies to all non-conflicting documents in all collections that don't have a collection-specific configuration defined. These settings are optional and can be removed. @@ -95,7 +95,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; When enabled, a revision is created for each conflicting item. A revision is also created for the conflict resolution document. * The Conflicting Document Defaults configuration cannot be removed. - * You can [modify](../../../studio/database/settings/document-revisions.mdx#edit-conflicting-document-defaults) this configuration, + * You can [modify](#edit-conflicting-document-defaults) this configuration, or disable it if not interested in tracking document conflicts using revisions. * When "Document Defaults configuration" is defined, it __overrides__ these conflict defaults. * When a "Collection-specific configuration" is defined, @@ -177,7 +177,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Select Collection](./assets/select-collection.png) 3. **Configuration options** - These options are similar to those explained above for the [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration), + These options are similar to those explained above for the [default configuration](#define-default-configuration), the only difference is the configuration scope. 4. Click __OK__ to keep the configuration, or __Cancel__. @@ -198,7 +198,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Editing the Conflicting Document Defaults](./assets/edit-conflicting-docs-configuration.png) -* The settings options are similar to those explained above for the [default configuration](../../../studio/database/settings/document-revisions.mdx#define-default-configuration). +* The settings options are similar to those explained above for the [default configuration](#define-default-configuration). * Note: the __Limit # of revisions to keep by age__ value is set to `45 Days` by default. This means that revisions created for conflicting documents will start to be purged after 45 days, diff --git a/versioned_docs/version-7.1/studio/database/settings/documents-compression.mdx b/versioned_docs/version-7.1/studio/database/settings/documents-compression.mdx index 9ae3e806f5..03b12fc031 100644 --- a/versioned_docs/version-7.1/studio/database/settings/documents-compression.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/documents-compression.mdx @@ -35,7 +35,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To see the contents and size details of your database storage go to the [Storage Report](../../../studio/database/stats/storage-report.mdx) view in the Studio. * In this page: - * [Set documents compression from Studio](../../../studio/database/settings/documents-compression.mdx#set-documents-compression-from-studio) + * [Set documents compression from Studio](#set-documents-compression-from-studio) ## Set documents compression from Studio diff --git a/versioned_docs/version-7.1/studio/database/settings/integrations.mdx b/versioned_docs/version-7.1/studio/database/settings/integrations.mdx index ba6ac46bea..1867f4fcc3 100644 --- a/versioned_docs/version-7.1/studio/database/settings/integrations.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/integrations.mdx @@ -22,7 +22,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Secure Server](../../../start/installation/setup-wizard/choose-security-option.mdx). * In this page: - * [Integrations View](../../../studio/database/settings/integrations.mdx#integrations-view) + * [Integrations View](#integrations-view) ## Integrations View diff --git a/versioned_docs/version-7.1/studio/database/settings/manage-database-group.mdx b/versioned_docs/version-7.1/studio/database/settings/manage-database-group.mdx index c90c832933..9fb4b730ea 100644 --- a/versioned_docs/version-7.1/studio/database/settings/manage-database-group.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/manage-database-group.mdx @@ -38,10 +38,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Note 2: Although not all nodes in the cluster belong to the Database Group, each node in the cluster _has_ a full copy of _all_ Database Group Topologies. * In this page: - * [Database Group Topology - View](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---view) - * [Database Group Topology - Actions](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---actions) - * [Database Group Topology - Add New Node](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---add-new-node) - * [Database Group Topology - Members Duties](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---members-duties) + * [Database Group Topology - View](#database-group-topology---view) + * [Database Group Topology - Actions](#database-group-topology---actions) + * [Database Group Topology - Add New Node](#database-group-topology---add-new-node) + * [Database Group Topology - Members Duties](#database-group-topology---members-duties) ## Database Group Topology - View @@ -72,7 +72,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The order of the nodes is relevant for the client, as it selects which node to contact from this list. Click this button to reorder the nodes order. -2. **Add a Node to the database group** - See [below](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---add-new-node) +2. **Add a Node to the database group** - See [below](#database-group-topology---add-new-node) 3. **Settings** Open settings to set ***Dynamic Database Distribution*** @@ -105,7 +105,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Check the 'Choose preferred mentor node manually' checkbox in order to specify which node will be the preferred mentor for the newly added node. If not checked, then any one of the already existing Member nodes in the group will become the mentor node. The preferred mentor will be responsible for updating the new node with all the database data and its state. - See [Members Duties](../../../studio/database/settings/manage-database-group.mdx#database-group-topology---members-duties) + See [Members Duties](#database-group-topology---members-duties) diff --git a/versioned_docs/version-7.1/studio/database/settings/studio-configuration.mdx b/versioned_docs/version-7.1/studio/database/settings/studio-configuration.mdx index 396c05908c..97d3732f2a 100644 --- a/versioned_docs/version-7.1/studio/database/settings/studio-configuration.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/studio-configuration.mdx @@ -24,16 +24,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -[Studio Configuration - Single Database](../../../studio/database/settings/studio-configuration.mdx#studio-configuration---single-database) +[Studio Configuration - Single Database](#studio-configuration---single-database) -* [Database Studio Configuration View](../../../studio/database/settings/studio-configuration.mdx#database-studio-configuration-view) -* [Disabling Auto-Index Creation on Studio Queries or Patches](../../../studio/database/settings/studio-configuration.mdx#disabling-auto-index-creation-on-studio-queries-or-patches) - * [About Auto-Index Creation](../../../studio/database/settings/studio-configuration.mdx#about-auto-indexes-and-the-studio) +* [Database Studio Configuration View](#database-studio-configuration-view) +* [Disabling Auto-Index Creation on Studio Queries or Patches](#disabling-auto-index-creation-on-studio-queries-or-patches) + * [About Auto-Index Creation](#about-auto-indexes-and-the-studio) * [If Disabled, Temporarily Enable Auto-Index Creation](../../../studio/database/settings/studio-configuration.mdx#if-disabled,-temporarily-enable-auto-index-creation) -[Studio Configuration - Server-wide](../../../studio/database/settings/studio-configuration.mdx#studio-configuration---server-wide) +[Studio Configuration - Server-wide](#studio-configuration---server-wide) -* [Server Studio Configuration View](../../../studio/database/settings/studio-configuration.mdx#server-studio-configuration-view) +* [Server Studio Configuration View](#server-studio-configuration-view) diff --git a/versioned_docs/version-7.1/studio/database/settings/time-series-settings.mdx b/versioned_docs/version-7.1/studio/database/settings/time-series-settings.mdx index ed25bf6425..8cc2578835 100644 --- a/versioned_docs/version-7.1/studio/database/settings/time-series-settings.mdx +++ b/versioned_docs/version-7.1/studio/database/settings/time-series-settings.mdx @@ -36,11 +36,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; You can set a different retention period for each rollup so that you can delete the previous data after it has been summarized/aggregated. * In this page: - * [Rationale for Configuring Time Series Policies](../../../studio/database/settings/time-series-settings.mdx#rationale-for-configuring-time-series-policies) - * [Time Series Settings View](../../../studio/database/settings/time-series-settings.mdx#time-series-settings-view) - * [Defined Time Series Configurations](../../../studio/database/settings/time-series-settings.mdx#defined-time-series-configurations) - * [Add or Edit Time Series Configuration](../../../studio/database/settings/time-series-settings.mdx#add-or-edit-time-series-configuration) - * [Rollup Policies for Rollup Time Series](../../../studio/database/settings/time-series-settings.mdx#rollup-policies-for-rollup-time-series) + * [Rationale for Configuring Time Series Policies](#rationale-for-configuring-time-series-policies) + * [Time Series Settings View](#time-series-settings-view) + * [Defined Time Series Configurations](#defined-time-series-configurations) + * [Add or Edit Time Series Configuration](#add-or-edit-time-series-configuration) + * [Rollup Policies for Rollup Time Series](#rollup-policies-for-rollup-time-series) ## Rationale for Configuring Time Series Policies @@ -113,7 +113,7 @@ Here are the different levels of resolution that they want to see: 2 seconds will still be checked and executed every 8 seconds. 4. **Defined Time Series Configurations** - View and manage the time series configurations that were already defined (read more [below](../../../studio/database/settings/time-series-settings.mdx#defined-time-series-configurations)). + View and manage the time series configurations that were already defined (read more [below](#defined-time-series-configurations)). 5. **Add or Edit time series configurations** * Click the **Add a collection-specific configuration** button to create a new configuration. * Click a defined configuration **Edit** button to edit an existing configuration. @@ -130,11 +130,11 @@ Here are the different levels of resolution that they want to see: Check to select/deselect this configuration. Rollup and Retention policies for selected configurations can be enabled or disabled using the - [time series settings view](../../../studio/database/settings/time-series-settings.mdx#time-series-settings-view) **Set Status** button. + [time series settings view](#time-series-settings-view) **Set Status** button. 2. **Enable/Disable Configuration** Click to enable or disable Rollup and Retention policies for this configuration. 3. **Edit** - Click to [edit this configuration](../../../studio/database/settings/time-series-settings.mdx#add-or-edit-time-series-configuration). + Click to [edit this configuration](#add-or-edit-time-series-configuration). 4. **Remove** Click to remove this configuration. !["Defined Time Series Configurations - Info"](./assets/time-series-settings-04_per-collection-configuration-info.png) @@ -225,7 +225,7 @@ Here are the different levels of resolution that they want to see: Rollup policies can be defined both for **raw time series data** and for **rollup time series**. - Read more [here](../../../studio/database/settings/time-series-settings.mdx#rollup-policies-for-rollup-time-series). + Read more [here](#rollup-policies-for-rollup-time-series). In the above image, the rollup policy aggregates the **raw data** of the selected collection's time series, into **new** rollup time series. diff --git a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx index 8e933bbf46..c9d10f8c03 100644 --- a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The data shown in the graph will be either 'Outgoing' or 'Incoming', depending on whether the source or the target database is viewed. * In this page: - * [External Replication Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx#external-replication-stats-closed-view) - * [External Replication Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/external-replication-stats.mdx#external-replication-stats-expanded-view) + * [External Replication Stats Closed View](#external-replication-stats-closed-view) + * [External Replication Stats Expanded View](#external-replication-stats-expanded-view) ## External Replication Stats diff --git a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx index 08a7036c11..970d62640d 100644 --- a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx @@ -20,8 +20,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the OLAP ETL task [here](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx). * In this page: - * [OLAP ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx#olap-etl-stats-closed-view) - * [OLAP ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/olap-etl-stats.mdx#olap-etl-stats-expanded-view) + * [OLAP ETL Stats Closed View](#olap-etl-stats-closed-view) + * [OLAP ETL Stats Expanded View](#olap-etl-stats-expanded-view) ## OLAP ETL Stats diff --git a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/overview.mdx b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/overview.mdx index 8b8411c8af..530f4d3223 100644 --- a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/overview.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/overview.mdx @@ -23,13 +23,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Tasks activities are graphically displayed for selected time frames. * In this page: - * [Ongoing Tasks Stats View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#ongoing-tasks-stats-view) - * [The Timeline Ruler](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#the-timeline-ruler) - * [Task Rulers](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-rulers) - * [Closed View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-ruler-closed-view) - * [Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-ruler-expanded-view) - * [Time Grid](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#task-rulers-time-grid) - * [Active and Inactive Display](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#active-and-inactive-display) + * [Ongoing Tasks Stats View](#ongoing-tasks-stats-view) + * [The Timeline Ruler](#the-timeline-ruler) + * [Task Rulers](#task-rulers) + * [Closed View](#task-ruler-closed-view) + * [Expanded View](#task-ruler-expanded-view) + * [Time Grid](#task-rulers-time-grid) + * [Active and Inactive Display](#active-and-inactive-display) ## Ongoing Tasks Stats View @@ -127,10 +127,10 @@ during the time specified by the timeline ruler above. A grid of vertical time lines allows you to easily relate task events to their time of occurence. -Note that the [stats graph](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#stats-graph) +Note that the [stats graph](#stats-graph) displays **two different time grids**. -* The [Timeline ruler time grid](../../../../studio/database/stats/ongoing-tasks-stats/overview.mdx#the-timeline-ruler) +* The [Timeline ruler time grid](#the-timeline-ruler) shows time points across the entire timeline ruler line. * The Task rulers time grid, discussed here, shows points of time **within the selected time frame**. diff --git a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx index 10b6447eb2..37a840d5ea 100644 --- a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the RavenDB ETL task [here](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx). * In this page: - * [RavenDB ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx#ravendb-etl-stats-closed-view) - * [RavenDB ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/ravendb-etl-stats.mdx#ravendb-etl-stats-expanded-view) + * [RavenDB ETL Stats Closed View](#ravendb-etl-stats-closed-view) + * [RavenDB ETL Stats Expanded View](#ravendb-etl-stats-expanded-view) ## RavenDB ETL Stats diff --git a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx index c06ff9c3a5..e15d463e7a 100644 --- a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx @@ -19,8 +19,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about the SQL ETL task [here](../../../../server/ongoing-tasks/etl/sql.mdx). * In this page: - * [SQL ETL Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx#sql-etl-stats-closed-view) - * [SQL ETL Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/sql-etl-stats.mdx#sql-etl-stats-expanded-view) + * [SQL ETL Stats Closed View](#sql-etl-stats-closed-view) + * [SQL ETL Stats Expanded View](#sql-etl-stats-expanded-view) ## SQL ETL Stats diff --git a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx index 620a09fb38..042a5f42c8 100644 --- a/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Learn more about data subscription tasks [here](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx). * In this page: - * [Subscription Stats Closed View](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#subscription-stats-closed-view) - * [Subscription Stats Expanded View](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#subscription-stats-expanded-view) - * [Connection Event Indicators](../../../../studio/database/stats/ongoing-tasks-stats/subscription-stats.mdx#connection-event-indicators) + * [Subscription Stats Closed View](#subscription-stats-closed-view) + * [Subscription Stats Expanded View](#subscription-stats-expanded-view) + * [Connection Event Indicators](#connection-event-indicators) ## Subscription Stats diff --git a/versioned_docs/version-7.1/studio/database/stats/storage-report.mdx b/versioned_docs/version-7.1/studio/database/stats/storage-report.mdx index 94ce706d38..0796fcaa19 100644 --- a/versioned_docs/version-7.1/studio/database/stats/storage-report.mdx +++ b/versioned_docs/version-7.1/studio/database/stats/storage-report.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Refresh the page to see the effect of [Documents Compression](../../../server/storage/documents-compression.mdx) and [Database Compaction](../../../client-api/operations/server-wide/compact-database.mdx). * In this page: - * [Database storage report](../../../studio/database/stats/storage-report.mdx#database-storage-report) + * [Database storage report](#database-storage-report) ## Database storage report diff --git a/versioned_docs/version-7.1/studio/database/tasks/backup-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/backup-task.mdx index b6e1889e24..3dc1d779b4 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/backup-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/backup-task.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; [restore](../../../studio/database/create-new-database/from-backup.mdx) your database from that point. Learn more in [Backup Overview](../../../server/ongoing-tasks/backup-overview.mdx). -* This Studio view enables you to create ongoing [periodic backup tasks](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation), +* This Studio view enables you to create ongoing [periodic backup tasks](#periodic-backup-creation), as well as one-time - [manual backups](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups), for a particular database. + [manual backups](#manually-creating-one-time-backups), for a particular database. It also enables **server-wide backups** which can back up all of the databases on one server/node. See [Studio: Server-Wide Backups](../../../studio/server/server-wide-backup.mdx) to learn more. @@ -31,22 +31,22 @@ import LanguageContent from "@site/src/components/LanguageContent"; Read about backups on a sharded database [in the section dedicated to it](../../../sharding/backup-and-restore/backup.mdx). * A backup is _not equivalent_ to replicating your data, as explained below in - [Backup -vs- Replication](../../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task). + [Backup -vs- Replication](#backup-task--vs--replication-task). * To check what data different backup types save, see the [backup overview article](../../../server/ongoing-tasks/backup-overview.mdx). * In this page: - * [Backups View](../../../studio/database/tasks/backup-task.mdx#backups-view) - * [Periodic Backup Creation](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation) - * [Scheduling Backups](../../../studio/database/tasks/backup-task.mdx#scheduling-backups) - * [Retention Policy](../../../studio/database/tasks/backup-task.mdx#retention-policy) - * [Backup Encryption](../../../studio/database/tasks/backup-task.mdx#backup-encryption) - * [Destination](../../../studio/database/tasks/backup-task.mdx#destination) - * [Periodic Backup Details](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details) - * [Manually Creating One-Time Backups](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups) - * [Delaying a Running Backup Task](../../../studio/database/tasks/backup-task.mdx#delaying-a-running-backup-task) - * [When the Cluster or Node is Down](../../../studio/database/tasks/backup-task.mdx#when-the-cluster-or-node-is-down) - * [Backup Task -vs- Replication Task](../../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task) + * [Backups View](#backups-view) + * [Periodic Backup Creation](#periodic-backup-creation) + * [Scheduling Backups](#scheduling-backups) + * [Retention Policy](#retention-policy) + * [Backup Encryption](#backup-encryption) + * [Destination](#destination) + * [Periodic Backup Details](#periodic-backup-details) + * [Manually Creating One-Time Backups](#manually-creating-one-time-backups) + * [Delaying a Running Backup Task](#delaying-a-running-backup-task) + * [When the Cluster or Node is Down](#when-the-cluster-or-node-is-down) + * [Backup Task -vs- Replication Task](#backup-task--vs--replication-task) ## Backups View @@ -56,9 +56,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; 1. **Go to Studio Backups View** To back up your database or server, click on the **Tasks** tab then **Backups**. 2. **Create a Periodic Backup** - To schedule [automatic, recurrent backups](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation). + To schedule [automatic, recurrent backups](#periodic-backup-creation). 3. **Create a Manual Backup** - For a [one-time backup](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups). + For a [one-time backup](#manually-creating-one-time-backups). 4. **Restore a database from a backup** To [restore a database](../../../studio/database/create-new-database/from-backup.mdx) from a previously created backup. 5. **Go to Server Wide Tasks View** to [back up all of the databases](../../../studio/server/server-wide-backup.mdx) on this server. @@ -74,9 +74,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; ![Periodic Backup View](./assets/Periodic-backup-task-view.png) 1. **Create a periodic backup task** - To schedule [automatic, recurrent backups](../../../studio/database/tasks/backup-task.mdx#creating-periodic-backups). - 2. [View Details of periodic backup](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details) tasks - * [Backup Now](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details) (e.g. before software updates) can be triggered in the 'View Details' interface. + To schedule [automatic, recurrent backups](#creating-periodic-backups). + 2. [View Details of periodic backup](#periodic-backup-details) tasks + * [Backup Now](#periodic-backup-details) (e.g. before software updates) can be triggered in the 'View Details' interface. 3. **Edit** this database backup task. To edit server/node-wide backup tasks, see button #5. 4. **Delete** this periodic backup task. 5. **Go to the server-wide backups view** to [back up all databases on the server](../../../studio/server/server-wide-backup.mdx). @@ -245,9 +245,9 @@ Make sure to save the destinations and credentials information so that your team ![Manual Backup View](./assets/manual-backup-task-view.png) - 1. Create a one-time [manual backup](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups). + 1. Create a one-time [manual backup](#manually-creating-one-time-backups). This can be vital before upgrading or whenever you want an unscheduled backup. - 2. Unscheduled backups (e.g. before upgrades) can also be done in the [periodic backup details view](../../../studio/database/tasks/backup-task.mdx#periodic-backup-details). + 2. Unscheduled backups (e.g. before upgrades) can also be done in the [periodic backup details view](#periodic-backup-details). If you've selected 'manual backup', the following screen will open. @@ -256,7 +256,7 @@ If you've selected 'manual backup', the following screen will open. 1. **Backup Type**. * "Snapshot" saves the entire database and its indexes. * "Backup" saves the data, but only index definitions. -2. **Encryption** - See [Backup Encryption](../../../studio/database/tasks/backup-task.mdx#backup-encryption). +2. **Encryption** - See [Backup Encryption](#backup-encryption). 3. **Destination** for backup to be stored. Click **Backup Now** to finish the process. @@ -267,7 +267,7 @@ Manual backups have only some of the properties of periodic backups: * The backup can be _full_ or _snapshot_. * The backup can be encrypted or not. -* The backup must have a [destination](../../../studio/database/tasks/backup-task.mdx#destination). +* The backup must have a [destination](#destination). There are also some important differences: @@ -289,8 +289,8 @@ The execution of a running backup task can be **delayed** for a given time perio * All scheduled executions of the task during the delay period are cancelled. Delaying a running backup operation is only available for - [periodic backup tasks](../../../studio/database/tasks/backup-task.mdx#periodic-backup-creation). - A [one-time backup operation](../../../studio/database/tasks/backup-task.mdx#manually-creating-one-time-backups) + [periodic backup tasks](#periodic-backup-creation). + A [one-time backup operation](#manually-creating-one-time-backups) cannot be delayed. * When the delay period has passed, the backup operation is executed diff --git a/versioned_docs/version-7.1/studio/database/tasks/create-sample-data.mdx b/versioned_docs/version-7.1/studio/database/tasks/create-sample-data.mdx index 27d2756ce8..fe5b17edf2 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/create-sample-data.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/create-sample-data.mdx @@ -23,8 +23,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; Creating it will enable you to play with the data as you use the documentation to familiarize yourself with RavenDB features. * In this page: - * [Create Sample Data](../../../studio/database/tasks/create-sample-data.mdx#create-sample-data) - * [The Data Generated - Documents View](../../../studio/database/tasks/create-sample-data.mdx#the-data-generated---documents-view) + * [Create Sample Data](#create-sample-data) + * [The Data Generated - Documents View](#the-data-generated---documents-view) * [The C# Entities](../../../studio/database/tasks/create-sample-data.mdx#the-c#-entities) ## Create Sample Data diff --git a/versioned_docs/version-7.1/studio/database/tasks/export-database.mdx b/versioned_docs/version-7.1/studio/database/tasks/export-database.mdx index 03991ecec2..8a1f652a1f 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/export-database.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/export-database.mdx @@ -25,8 +25,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; [section dedicated to this operation](../../../sharding/import-and-export.mdx#export). * In this page: - * [Export Database View](../../../studio/database/tasks/export-database.mdx#export-database-view) - * [Advanced Export Options](../../../studio/database/tasks/export-database.mdx#advanced-export-options) + * [Export Database View](#export-database-view) + * [Advanced Export Options](#advanced-export-options) ## Export Database View @@ -65,7 +65,7 @@ and export it to a `.ravendbdump` file. ![Provide Encryption Key](./assets/export-encryption-key.png) 7. **Advanced** - Click to display [advanced export settings](../../../studio/database/tasks/export-database.mdx#advanced-export-options). + Click to display [advanced export settings](#advanced-export-options). 8. **Export Database** Click to export the selected data to a `.ravendbdump` file. diff --git a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-data-file.mdx b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-data-file.mdx index 68f39df833..3b2f578ea8 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-data-file.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-data-file.mdx @@ -26,12 +26,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; In this page: -* [Import data to destination server from file](../../../../studio/database/tasks/import-data/import-data-file.mdx#import-data-to-destination-server-from-file) -* [Import options](../../../../studio/database/tasks/import-data/import-data-file.mdx#import-options) -* [Advanced import options](../../../../studio/database/tasks/import-data/import-data-file.mdx#advanced-import-options) - * [Transform Script](../../../../studio/database/tasks/import-data/import-data-file.mdx#transform-script) - * [Customize Configuration and Ongoing Tasks](../../../../studio/database/tasks/import-data/import-data-file.mdx#customize-configuration-and-ongoing-tasks) - * [Copy command as PowerShell](../../../../studio/database/tasks/import-data/import-data-file.mdx#copy-command-as-powershell) +* [Import data to destination server from file](#import-data-to-destination-server-from-file) +* [Import options](#import-options) +* [Advanced import options](#advanced-import-options) + * [Transform Script](#transform-script) + * [Customize Configuration and Ongoing Tasks](#customize-configuration-and-ongoing-tasks) + * [Copy command as PowerShell](#copy-command-as-powershell) @@ -54,7 +54,7 @@ If you have already [exported a database](../export-database.mdx), follow these 5. **Select file** Select the `.ravendbdump` file that you previously exported from the source server. 6. **Documents and Extensions** - Select desired [options](../../tasks/import-data/import-data-file.mdx#import-options). + Select desired [options](#import-options). *If you encrypted while exporting* make sure to select **imported file is encrypted**. You will need to paste the encryption key that you saved when creating the encrypted database. 7. **Advanced** diff --git a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-csv.mdx b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-csv.mdx index 973593140d..e9f74bee9d 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-csv.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-csv.mdx @@ -22,9 +22,9 @@ Because some CSV files are formatted differently, the RavenDB Studio enables you In this page: -* [What is CSV](../../../../studio/database/tasks/import-data/import-from-csv.mdx#what-is-csv) -* [How should I format my documents as CSV](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-should-i-format-my-documents-as-csv) -* [How to Import a CSV via RavenDB Studio](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-to-import-a-csv-via-ravendb-studio) +* [What is CSV](#what-is-csv) +* [How should I format my documents as CSV](#how-should-i-format-my-documents-as-csv) +* [How to Import a CSV via RavenDB Studio](#how-to-import-a-csv-via-ravendb-studio) @@ -189,6 +189,6 @@ Now that we've got a valid CSV file we can import it to RavenDB. 8. Select **Import Collection** After importing the CSV file, the resulting .json document should look like the document -[above](../../../../studio/database/tasks/import-data/import-from-csv.mdx#how-should-i-format-my-documents-as-csv). +[above](#how-should-i-format-my-documents-as-csv). diff --git a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-other.mdx b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-other.mdx index c231b07fa6..67c9791759 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-other.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-other.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Download Raven.Migrator Tool](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool) - * [Import from MongoDB](../../../../studio/database/tasks/import-data/import-from-other.mdx#import-from-mongodb) - * [Import from CosmosDB](../../../../studio/database/tasks/import-data/import-from-other.mdx#import-from-cosmosdb) + * [Download Raven.Migrator Tool](#download-ravenmigrator-tool) + * [Import from MongoDB](#import-from-mongodb) + * [Import from CosmosDB](#import-from-cosmosdb) @@ -47,7 +47,7 @@ In the RavenDB Studio client on the left side, select `Tasks` -> `Import Data ![Figure 1.](./assets/mongodb-1.png) 1. **Migrator Path** - * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** @@ -79,7 +79,7 @@ In the RavenDB Studio client on the left side, select `Tasks` -> `Import Data 1. **Migrator Path** - * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** diff --git a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-ravendb.mdx b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-ravendb.mdx index f6e1be0c62..519e405c20 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-ravendb.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-ravendb.mdx @@ -147,7 +147,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; - [Include Identities](../../../../client-api/document-identifiers/working-with-document-identifiers.mdx) - [Include Compare Exchange](../../../../compare-exchange/overview.mdx) - [Include Subscriptions](../../../../client-api/data-subscriptions/what-are-data-subscriptions.mdx) - - [Include Configuration and OngoingTasks](../../../../studio/database/tasks/import-data/import-from-ravendb.mdx#customize-configuration-and-ongoing-tasks) + - [Include Configuration and OngoingTasks](#customize-configuration-and-ongoing-tasks) diff --git a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-sql.mdx b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-sql.mdx index 9ac241e99b..935e5f24e8 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-sql.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/import-data/import-from-sql.mdx @@ -33,16 +33,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; Changes made while preparing the data model maintain data integrity and cohesion. * In this page: - * [Import Data From SQL Source](../../../../studio/database/tasks/import-data/import-from-sql.mdx#import-data-from-sql-source) - * [Create a New Import Configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) - * [Advanced Import Options](../../../../studio/database/tasks/import-data/import-from-sql.mdx#advanced-import-options) - * [Run an Existing Import Configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration) - * [SQL Migration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#sql-migration) - * [Data Conversion: General Settings](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) - * [Data Conversion: Table/Collection Settings](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-tablecollection-settings) - * [Filtering and Transforming Documents](../../../../studio/database/tasks/import-data/import-from-sql.mdx#filtering-and-transforming-documents) - * [Handling Relationships](../../../../studio/database/tasks/import-data/import-from-sql.mdx#handling-relationships) - * [Data integrity Helpers](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-integrity-helpers) + * [Import Data From SQL Source](#import-data-from-sql-source) + * [Create a New Import Configuration](#create-a-new-import-configuration) + * [Advanced Import Options](#advanced-import-options) + * [Run an Existing Import Configuration](#run-an-existing-import-configuration) + * [SQL Migration](#sql-migration) + * [Data Conversion: General Settings](#data-conversion-general-settings) + * [Data Conversion: Table/Collection Settings](#data-conversion-tablecollection-settings) + * [Filtering and Transforming Documents](#filtering-and-transforming-documents) + * [Handling Relationships](#handling-relationships) + * [Data integrity Helpers](#data-integrity-helpers) ## Import Data From SQL Source @@ -54,15 +54,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to import data. 3. **From SQL** Click to import data from an SQL source. -4. [Create new import configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) +4. [Create new import configuration](#create-a-new-import-configuration) Create a new import configuration from scratch. The configuration can be exported and reused. -5. [Continue existing migration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration) +5. [Continue existing migration](#run-an-existing-import-configuration) Run an existing import configuration. ### Create a New Import Configuration Use this option to enter a new import configuration. -The configuration can then be exported and [reused](../../../../studio/database/tasks/import-data/import-from-sql.mdx#run-an-existing-import-configuration). +The configuration can then be exported and [reused](#run-an-existing-import-configuration). ![Create New Import Configuration](./assets/sql-migration-create-new-import.png) @@ -82,10 +82,10 @@ The configuration can then be exported and [reused](../../../../studio/database/ Click the **Syntax** caption to display valid connection strings for the different SQL sources. -3. [Advanced](../../../../studio/database/tasks/import-data/import-from-sql.mdx#advanced-import-options) +3. [Advanced](#advanced-import-options) Click for advanced import options. -4. [Create new import](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +4. [Create new import](#data-conversion-general-settings) Click to connect the SQL source and import the database schema and data. 5. **Test Connection** @@ -127,7 +127,7 @@ you can locate and run it here. ![Use Existing Import Configuration](./assets/sql-migration-use-existing-configuration.png) 1. Click to locate an existing import configuration on the file system. -2. Click to [run the selected configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +2. Click to [run the selected configuration](#data-conversion-general-settings) and migrate data from the SQL source. @@ -145,7 +145,7 @@ In _NoSQL_, this can be modeled as a list of foreign object IDs and requires no ### Data Conversion: General Settings -When an [import configuration](../../../../studio/database/tasks/import-data/import-from-sql.mdx#create-a-new-import-configuration) +When an [import configuration](#create-a-new-import-configuration) is executed RavenDB connects the SQL source, obtains information about database tables and keys, and displays the following view to allow the user to alter the migration and target documents structure. @@ -188,7 +188,7 @@ target documents structure. Please note that limiting the migration may break links between documents. -7. [Table/Collection Conversion Tuning](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-tablecollection-settings) +7. [Table/Collection Conversion Tuning](#data-conversion-tablecollection-settings) Specific details related to the transfer of each table can be altered as well. See additional details below. ### Data Conversion: Table/Collection Settings @@ -210,7 +210,7 @@ target documents structure. Click for details regarding each relationship, and to select whether to skip each relationship or embed it in the document. -5. [Filter/Transform](../../../../studio/database/tasks/import-data/import-from-sql.mdx#filtering-and-transforming-documents) +5. [Filter/Transform](#filtering-and-transforming-documents) Click to alter the **filter query** executed over the source database, and/or the **transform script** used to shape the imported data. @@ -240,7 +240,7 @@ Filtering the read data is gained by altering the query RavenDB runs over the SQL server to fetch the data. transforming written documents is done using a transform script through which all incoming data passes. -Learn [here](../../../../studio/database/tasks/import-data/import-from-sql.mdx#data-conversion-general-settings) +Learn [here](#data-conversion-general-settings) how to connect the source database and open the filter/transform dialog. ![Filter and Transform](./assets/sql-migration-filter-and-export-I.png) diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx index 2810b37315..bf7c985d7d 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx @@ -27,11 +27,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; an Amazon SQS ETL task using the Client API. . * In this page: - * [Ongoing Tasks View](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#ongoing-tasks-view) - * [Define the Amazon SQS ETL task](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#define-amazon-sqs-etl-task) - * [Add or Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#add-or-edit-transformation-script) - * [Comments](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#comments) - * [ETL message size -vs- Queue message size](../../../../studio/database/tasks/ongoing-tasks/amazon-sqs-etl.mdx#etl-message-size--vs--queue-message-size) + * [Ongoing Tasks View](#ongoing-tasks-view) + * [Define the Amazon SQS ETL task](#define-amazon-sqs-etl-task) + * [Add or Edit Transformation Script](#add-or-edit-transformation-script) + * [Comments](#comments) + * [ETL message size -vs- Queue message size](#etl-message-size--vs--queue-message-size) ## Ongoing Tasks View diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx index 7c717ee525..607320ad25 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx @@ -30,11 +30,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/azure-queue.mdx) how to define an Azure Queue Storage ETL task using the Client API. * In this page: - * [Open Azure Queue Storage ETL task view](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#open-azure-queue-storage-etl-task-view) - * [Define Azure Queue Storage ETL task](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#define-azure-queue-storage-etl-task) - * [Authentication method](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#authentication-method) - * [Options per queue](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#options-per-queue) - * [Add transformation script](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#add-transformation-script) + * [Open Azure Queue Storage ETL task view](#open-azure-queue-storage-etl-task-view) + * [Define Azure Queue Storage ETL task](#define-azure-queue-storage-etl-task) + * [Authentication method](#authentication-method) + * [Options per queue](#options-per-queue) + * [Add transformation script](#add-transformation-script) ## Open Azure Queue Storage ETL task view @@ -72,7 +72,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Toggle OFF to select an existing connection string from the list, or toggle ON to create a new one. * **Name** - Enter a name for the connection string. * **Authentication method** - Select the authentication method by which to connect to an Azure storage account. - Learn more about the available authentication methods [below](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#authentication-method). + Learn more about the available authentication methods [below](#authentication-method). 5. **Test Connection** After defining the connection string, click to test the connection to the Azure storage account. @@ -82,7 +82,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Click to add a transformation script. 7. **Advanced** - Click to open the [advanced section](../../../../studio/database/tasks/ongoing-tasks/azure-queue-storage-etl.mdx#options-per-queue) where you can configure the deletion of RavenDB documents per queue. + Click to open the [advanced section](#options-per-queue) where you can configure the deletion of RavenDB documents per queue. diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx index 04625ff7ee..8820ac0d7d 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx @@ -24,14 +24,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; the client API in [Ongoing Tasks: Elasticsearch ETL](../../../../server/ongoing-tasks/etl/elasticsearch.mdx) * In this page: - * [Navigate to the Elasticsearch ETL Task View](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#navigate-to-the-elasticsearch-etl-task-view) - * [Define the Elasticsearch ETL Task](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#define-the-elasticsearch-etl-task) - * [Elasticsearch Indexes](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) - * [Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#transformation-script) - * [Add Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#add-transformation-script) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#edit-transformation-script) - * [Test Transformation Script](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#test-transformation-script) - * [Test Results](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#test-results) + * [Navigate to the Elasticsearch ETL Task View](#navigate-to-the-elasticsearch-etl-task-view) + * [Define the Elasticsearch ETL Task](#define-the-elasticsearch-etl-task) + * [Elasticsearch Indexes](#elasticsearch-indexes) + * [Transformation Script](#transformation-script) + * [Add Transformation Script](#add-transformation-script) + * [Edit Transformation Script](#edit-transformation-script) + * [Test Transformation Script](#test-transformation-script) + * [Test Results](#test-results) ## Navigate to the Elasticsearch ETL Task View @@ -179,7 +179,7 @@ Elasticsearch destination per RavenDB document from the selected collections. * Make sure that one of the properties of the document object is given the value `id(this)`. - The ETL task will use this property [to identify](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#document-id-property-name) + The ETL task will use this property [to identify](#document-id-property-name) documents that reside on the Elasticsearch destination by their source RavenDB document ID. @@ -201,10 +201,10 @@ Elasticsearch destination per RavenDB document from the selected collections. specified collections** the first time the task runs. * When this option is **disabled**: The script will be executed **only over new and modified documents**. - * If [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + * If [Insert Only](#elasticsearch-indexes) is **enabled**: RavenDB documents will be appended to Elasticsearch **without deleting documents from Elasticsearch first**. - * If [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + * If [Insert Only](#elasticsearch-indexes) is **disabled**: Documents will be **deleted from Elasticsearch first**, and then appended to it from RavenDB. @@ -244,7 +244,7 @@ The test results view displays a **preview** of the tested document, and the **c 3. [_delete_by_query](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html) Segment The delete POST command with a list of IDs by which Elasticsearch would locate and remove existing documents. - Deleting existing document versions is **optional**, enable [Insert Only](../../../../studio/database/tasks/ongoing-tasks/elasticsearch-etl-task.mdx#elasticsearch-indexes) + Deleting existing document versions is **optional**, enable [Insert Only](#elasticsearch-indexes) to prevent the task from sending `_delete_by_query` commands. 4. [_bulk ](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html) Segment The bulk POST command with a list of document objects, each with data extracted from RavenDB and an ID that Elasticsearch stores it by. diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/external-replication-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/external-replication-task.mdx index f24c1308f7..2662b1d89f 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/external-replication-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/external-replication-task.mdx @@ -26,7 +26,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; such as filtration and two-way (master-master) replication, consider [Hub/Sink Replication](../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx). * To replicate between two separate, secure RavenDB servers, - you need to [pass a client certificate](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#step-by-step-guide) from the source server to the destination. + you need to [pass a client certificate](#step-by-step-guide) from the source server to the destination. * External replication can be a comfortable means of data migration into a [sharded](../../../../sharding/overview.mdx) database. You can read more about this option in the sharding documentation [external replication](../../../../sharding/external-replication.mdx) and [migration](../../../../sharding/migration.mdx) sections. @@ -35,11 +35,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; See more in [Backup -vs- Replication](../../../../studio/database/tasks/backup-task.mdx#backup-task--vs--replication-task) * In this page: - * [General Information about External Replication Task](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#general-information-about-external-replication-task) - * [Step-by-Step Guide](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#step-by-step-guide) - * [Definition](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition) - * [Details in Tasks List View](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#details-in-tasks-list-view) - * [Offline Behavior](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#offline-behavior) + * [General Information about External Replication Task](#general-information-about-external-replication-task) + * [Step-by-Step Guide](#step-by-step-guide) + * [Definition](#definition) + * [Details in Tasks List View](#details-in-tasks-list-view) + * [Offline Behavior](#offline-behavior) @@ -99,7 +99,7 @@ To explore this concept further, refer to the [Data Ownership in a Distributed S be sure that the target database is as well. ![Encrypted Logo](./assets/encrypted-logo.png) 3. **Define External Replication Task in the Source Database** - Learn more about [defining the task](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#definition) in the dedicated section. + Learn more about [defining the task](#definition) in the dedicated section. * **Optional Parameters** - Task Name - Delay Time @@ -164,7 +164,7 @@ f. Click **External Replication** to access the following interface. You can set multiple connection strings to multiple different nodes on different machines so that if one is down, the other can keep the destination updated. - See [Offline Behavior - When the destination node is down](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx#offline-behavior). + See [Offline Behavior - When the destination node is down](#offline-behavior). If you define only one node's connection string, RavenDB will wait until that node is online and will then update any missing information. diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/general-info.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/general-info.mdx index 07b0e47cc4..b60f37891d 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/general-info.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/general-info.mdx @@ -24,9 +24,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; and its responsible node executes the defined task work whenever relevant data changes occur. * In this page: - * [The ongoing tasks](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks) - * [The ongoing tasks list - View](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks-list---view) - * [The ongoing tasks list - Actions](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx#the-ongoing-tasks-list---actions) + * [The ongoing tasks](#the-ongoing-tasks) + * [The ongoing tasks list - View](#the-ongoing-tasks-list---view) + * [The ongoing tasks list - Actions](#the-ongoing-tasks-list---actions) ## The ongoing tasks diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx index 3dbe803307..9088502a21 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx @@ -25,22 +25,22 @@ and Sink replication tasks. * The connection is always initiated by the Sink, but you can choose whether to replicate data from *Hub to Sink* and/or from *Sink to Hub*. -* Replication can be [filtered](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) +* Replication can be [filtered](#filtered-replication) by both the Hub and the Sink, and for both *incoming* and *outgoing* documents, using wildcards and document IDs, to select the documents that would be replicated. -* The connection between Hub and Sink tasks is [secure](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#accesses-and-certificates), +* The connection between Hub and Sink tasks is [secure](#accesses-and-certificates), requiring a secure RavenDB cluster setup. A secure cluster can be raised using RavenDB's [setup wizard](../../../../../start/installation/setup-wizard/choose-security-option.mdx). * In this page: * [What is Hub/Sink Replication for?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-is-hub/sink-replication-for?) * [What is and is not replicated?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-is-and-is-not-replicated?) - * [Accesses and Certificates](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#accesses-and-certificates) - * [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) + * [Accesses and Certificates](#accesses-and-certificates) + * [Filtered Replication](#filtered-replication) * [What does the replication include?](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#what-does-the-replication-include?) - * [Failover](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#failover) - * [Backward Compatibility](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#backward-compatibility) + * [Failover](#failover) + * [Backward Compatibility](#backward-compatibility) ## What is Hub/Sink Replication for? diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx index 9744353a68..57a0148c84 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx @@ -26,12 +26,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) to choose which documents are to be replicated * In this page: - * [Create an Ongoing Replication Hub Task](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#create-an-ongoing-replication-hub-task) - * [Hub Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#hub-configuration) - * [Access Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#access-configuration) - * [Viewing and Editing Existing Accesses](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#viewing-and-editing-existing-accesses) - * [Defining Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#defining-filtered-replication) - * [Ongoing Tasks View](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-hub-task.mdx#ongoing-tasks-view) + * [Create an Ongoing Replication Hub Task](#create-an-ongoing-replication-hub-task) + * [Hub Configuration](#hub-configuration) + * [Access Configuration](#access-configuration) + * [Viewing and Editing Existing Accesses](#viewing-and-editing-existing-accesses) + * [Defining Filtered Replication](#defining-filtered-replication) + * [Ongoing Tasks View](#ongoing-tasks-view) ## Create an Ongoing Replication Hub Task diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx index bb5bf8fea2..8d6190e23c 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx @@ -26,12 +26,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use [Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/overview.mdx#filtered-replication) to choose which documents are to be replicated * In this page: - * [Create an Ongoing Replication Sink Task](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#create-an-ongoing-replication-sink-task) - * [Import Configuration From Hub](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#import-configuration-from-hub) - * [Sink Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#sink-configuration) - * [Access Configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#access-configuration) - * [Definining Filtered Replication](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#defining-filtered-replication) - * [Ongoing Tasks View](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#ongoing-tasks-view) + * [Create an Ongoing Replication Sink Task](#create-an-ongoing-replication-sink-task) + * [Import Configuration From Hub](#import-configuration-from-hub) + * [Sink Configuration](#sink-configuration) + * [Access Configuration](#access-configuration) + * [Definining Filtered Replication](#defining-filtered-replication) + * [Ongoing Tasks View](#ongoing-tasks-view) ## Create an Ongoing Replication Sink Task @@ -112,7 +112,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; 2. **Certificate Source** Choose a source for the Sink certificate. - ([Import Hub configuration](../../../../../studio/database/tasks/ongoing-tasks/hub-sink-replication/replication-sink-task.mdx#import-configuration-from-hub) + ([Import Hub configuration](#import-configuration-from-hub) to save yourself the need to redefine these details.) * **Provide your own certificate** Use this option to import a certificate of your own, e.g. one diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx index d9d4aeac41..832855d924 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx @@ -33,17 +33,17 @@ import ContentFrame from "@site/src/components/ContentFrame"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/kafka.mdx) how to define a Kafka ETL task using code. * In this article: - * [Setup workflow](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#setup-workflow) - * [Creating a Kafka ETL task](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#creating-a-kafka-etl-task) - * [Open Kafka ETL Task View](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#open-kafka-etl-task-view) - * [Define Kafka ETL Task](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#define-kafka-etl-task) - * [Use RavenDB Certificate](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#use-ravendb-certificate) - * [Options Per Topic](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#options-per-topic) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#edit-transformation-script) - * [Prerequisites for a secure Kafka server](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#prerequisites-for-a-secure-kafka-server) - * [What needs to be granted](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#what-needs-to-be-granted) - * [Reading the transactional IDs from Studio](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#reading-the-transactional-ids-from-studio) - * [Entering the grants on the Kafka cluster](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#entering-the-grants-on-the-kafka-cluster) + * [Setup workflow](#setup-workflow) + * [Creating a Kafka ETL task](#creating-a-kafka-etl-task) + * [Open Kafka ETL Task View](#open-kafka-etl-task-view) + * [Define Kafka ETL Task](#define-kafka-etl-task) + * [Use RavenDB Certificate](#use-ravendb-certificate) + * [Options Per Topic](#options-per-topic) + * [Edit Transformation Script](#edit-transformation-script) + * [Prerequisites for a secure Kafka server](#prerequisites-for-a-secure-kafka-server) + * [What needs to be granted](#what-needs-to-be-granted) + * [Reading the transactional IDs from Studio](#reading-the-transactional-ids-from-studio) + * [Entering the grants on the Kafka cluster](#entering-the-grants-on-the-kafka-cluster) @@ -135,7 +135,7 @@ extension that permits acting as a TLS client) or a separate certificate that RavenDB issues from the server certificate's key pair. Enabling **Use RavenDB Certificate** replaces the security options you would -otherwise enter via [Add new connection option](../../../../studio/database/tasks/ongoing-tasks/kafka-etl-task.mdx#define-kafka-etl-task). +otherwise enter via [Add new connection option](#define-kafka-etl-task). diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx index ab51120abc..8d1a052f2a 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx @@ -31,10 +31,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn how to define a Kafka queue sink using the API [here](../../../../server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#add-a-database-task) - * [Define a Kafka Sink Task](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-a-kafka-sink-task) - * [Define and Test Task Scripts](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#define-and-test-task-scripts) - * [Task Statistics](../../../../studio/database/tasks/ongoing-tasks/kafka-queue-sink.mdx#task-statistics) + * [Add a Database Task](#add-a-database-task) + * [Define a Kafka Sink Task](#define-a-kafka-sink-task) + * [Define and Test Task Scripts](#define-and-test-task-scripts) + * [Task Statistics](#task-statistics) ## Add a Database Task diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx index a25b92d18e..29c0c600de 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/olap-etl-task.mdx @@ -29,14 +29,14 @@ learn more about OLAP ETL tasks, and how to create one using the client API, see [Ongoing Tasks: OLAP ETL](../../../../server/ongoing-tasks/etl/olap.mdx). * In this page: - * [Navigate to the OLAP ETL View](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#navigate-to-the-olap-etl-view) - * [Define an OLAP ETL Task](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#define-an-olap-etl-task) - * [Custom Partition Value](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#custom-partition-value) - * [Run Frequency](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#run-frequency) - * [OLAP Connection String](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#olap-connection-string) - * [OLAP ETL Destinations](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#olap-etl-destinations) - * [Transform Scripts](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#transform-scripts) - * [Override ID column](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#override-id-column) + * [Navigate to the OLAP ETL View](#navigate-to-the-olap-etl-view) + * [Define an OLAP ETL Task](#define-an-olap-etl-task) + * [Custom Partition Value](#custom-partition-value) + * [Run Frequency](#run-frequency) + * [OLAP Connection String](#olap-connection-string) + * [OLAP ETL Destinations](#olap-etl-destinations) + * [Transform Scripts](#transform-scripts) + * [Override ID column](#override-id-column) ## Create an OLAP ETL Task @@ -66,7 +66,7 @@ To begin creating your OLAP ETL task: * A custom partition can be defined to differentiate parquet file locations when using the same connection string in multiple OLAP ETL tasks. -* The custom partition **name** is defined inside the [transformation scripts](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#transform-scripts). +* The custom partition **name** is defined inside the [transformation scripts](#transform-scripts). * The custom partition **value** is defined in the input box above. * The custom partition value is referenced in the transform script as `$customPartitionValue`. @@ -154,7 +154,7 @@ aren't specified in the script: * `_id` Contains the source document ID. The default name used for this column is `_id`. You can override this name in the task definition - see more - [below](../../../../studio/database/tasks/ongoing-tasks/olap-etl-task.mdx#override-id-column). + [below](#override-id-column). * `_lastModifiedTime` The value of the `last-modified` field in a document's metadata. Represented in unix time. diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx index 3f39791a90..5413018967 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx @@ -29,10 +29,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Learn here](../../../../server/ongoing-tasks/etl/queue-etl/rabbit-mq.mdx) how to define a RabbitMQ ETL task using code. * In this page: - * [Open RabbitMQ ETL Task View](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#open-rabbitmq-etl-task-view) - * [Define RabbitMQ ETL Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#define-rabbitmq-etl-task) - * [Options Per Exchange](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#options-per-exchange) - * [Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-etl-task.mdx#edit-transformation-script) + * [Open RabbitMQ ETL Task View](#open-rabbitmq-etl-task-view) + * [Define RabbitMQ ETL Task](#define-rabbitmq-etl-task) + * [Options Per Exchange](#options-per-exchange) + * [Edit Transformation Script](#edit-transformation-script) ## Open RabbitMQ ETL Task View diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx index 1e182ceb72..5fb27cb8f8 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx @@ -33,10 +33,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn how to define a RabbitMQ queue sink using the API [here](../../../../server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#add-a-database-task) - * [Define a RabbitMQ Sink Task](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-a-rabbitmq-sink-task) - * [Define and Test Task Scripts](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#define-and-test-task-scripts) - * [Task Statistics](../../../../studio/database/tasks/ongoing-tasks/rabbitmq-queue-sink.mdx#task-statistics) + * [Add a Database Task](#add-a-database-task) + * [Define a RabbitMQ Sink Task](#define-a-rabbitmq-sink-task) + * [Define and Test Task Scripts](#define-and-test-task-scripts) + * [Task Statistics](#task-statistics) ## Add a Database Task diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx index 5aa4515926..1201b7364e 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx @@ -23,19 +23,19 @@ import ContentFrame from "@site/src/components/ContentFrame"; Learn more about the RavenDB ETL task options in [Ongoing Tasks: RavenDB ETL](../../../../server/ongoing-tasks/etl/raven.mdx). * RavenDB ETL is different from External Replication, - see [RavenDB ETL task -vs- External Replication task](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task--vs--external-replication-task) + see [RavenDB ETL task -vs- External Replication task](#ravendb-etl-task--vs--external-replication-task) * On secure servers, the destination cluster must trust the source, - see [Passing certificate between secure clusters](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#passing-certificate-between-secure-clusters). + see [Passing certificate between secure clusters](#passing-certificate-between-secure-clusters). * In this article: - * [RavenDB ETL task - definition](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-definition) - * [RavenDB ETL task - transform scripts](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-transform-scripts) - * [RavenDB ETL task - test script](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-test-script) - * [RavenDB ETL task - details in tasks list view](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-details-in-tasks-list-view) - * [RavenDB ETL task - offline behavior](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-offline-behavior) - * [RavenDB ETL task -vs- External Replication task](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#ravendb-etl-task-vs-external-replication-task) - * [Passing certificate between secure clusters](../../../../studio/database/tasks/ongoing-tasks/ravendb-etl-task.mdx#passing-certificate-between-secure-clusters) + * [RavenDB ETL task - definition](#ravendb-etl-task-definition) + * [RavenDB ETL task - transform scripts](#ravendb-etl-task-transform-scripts) + * [RavenDB ETL task - test script](#ravendb-etl-task-test-script) + * [RavenDB ETL task - details in tasks list view](#ravendb-etl-task-details-in-tasks-list-view) + * [RavenDB ETL task - offline behavior](#ravendb-etl-task-offline-behavior) + * [RavenDB ETL task -vs- External Replication task](#ravendb-etl-task-vs-external-replication-task) + * [Passing certificate between secure clusters](#passing-certificate-between-secure-clusters) diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx index a433ad9b50..aecb23f88b 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more [here](../../../../server/ongoing-tasks/etl/snowflake.mdx). * In this page: - * [Add a Database Task](../../../../studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx#add-a-database-task) - * [Define a Snowflake ETL Task](../../../../studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx#define-a-snowflake-etl-task) - * [Add or Edit Transformation Script](../../../../studio/database/tasks/ongoing-tasks/snowflake-etl-task.mdx#add-or-edit-transformation-script) + * [Add a Database Task](#add-a-database-task) + * [Define a Snowflake ETL Task](#define-a-snowflake-etl-task) + * [Add or Edit Transformation Script](#add-or-edit-transformation-script) ## Add a Database Task diff --git a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/subscription-task.mdx b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/subscription-task.mdx index 9c8b07b31d..3a979a39a5 100644 --- a/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/subscription-task.mdx +++ b/versioned_docs/version-7.1/studio/database/tasks/ongoing-tasks/subscription-task.mdx @@ -20,9 +20,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This page explains how to create a subscription task on the server side using the Studio. * In this page: - * [Subscription Task Definition](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#subscription-task-definition) - * [Testing Subscriptions](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#testing) - * [Details in Task List View](../../../../studio/database/tasks/ongoing-tasks/subscription-task.mdx#details-in-task-list-view) + * [Subscription Task Definition](#subscription-task-definition) + * [Testing Subscriptions](#testing) + * [Details in Task List View](#details-in-task-list-view) ## Subscription Task Definition diff --git a/versioned_docs/version-7.1/studio/overview.mdx b/versioned_docs/version-7.1/studio/overview.mdx index edb2b374b1..bab39e0389 100644 --- a/versioned_docs/version-7.1/studio/overview.mdx +++ b/versioned_docs/version-7.1/studio/overview.mdx @@ -33,14 +33,14 @@ import LanguageContent from "@site/src/components/LanguageContent"; and much more. * In this page: - * [Accessing Studio After Setup](../studio/overview.mdx#accessing-studio-after-setup) - * [Connecting to an Unsecure server](../studio/overview.mdx#connecting-to-an-unsecure-server) - * [Connecting to a Secure server](../studio/overview.mdx#connecting-to-a-secure-server) - * [Where should the certificate be located](../studio/overview.mdx#where-should-the-certificate-be-located) - * [The Cluster Dashboard](../studio/overview.mdx#the-cluster-dashboard) - * [Manage Your Server](../studio/overview.mdx#manage-your-server) - * [Manage Your Databases](../studio/overview.mdx#manage-your-databases) - * [Header and Footer Areas](../studio/overview.mdx#header-and-footer-areas) + * [Accessing Studio After Setup](#accessing-studio-after-setup) + * [Connecting to an Unsecure server](#connecting-to-an-unsecure-server) + * [Connecting to a Secure server](#connecting-to-a-secure-server) + * [Where should the certificate be located](#where-should-the-certificate-be-located) + * [The Cluster Dashboard](#the-cluster-dashboard) + * [Manage Your Server](#manage-your-server) + * [Manage Your Databases](#manage-your-databases) + * [Header and Footer Areas](#header-and-footer-areas) ## Accessing Studio After Setup diff --git a/versioned_docs/version-7.1/studio/server/certificates/read-only-access-level.mdx b/versioned_docs/version-7.1/studio/server/certificates/read-only-access-level.mdx index 04e61a0163..dfd105fe66 100644 --- a/versioned_docs/version-7.1/studio/server/certificates/read-only-access-level.mdx +++ b/versioned_docs/version-7.1/studio/server/certificates/read-only-access-level.mdx @@ -32,7 +32,7 @@ that make it clear to the user what they can and can't do. * In this page: - * [Create a Client Certificate with Read Only Access](../../../studio/server/certificates/read-only-access-level.mdx#create-a-client-certificate-with-read-only-access) + * [Create a Client Certificate with Read Only Access](#create-a-client-certificate-with-read-only-access) * [The Studio in "Read Only" Mode](../../../studio/server/certificates/read-only-access-level.mdx#the-studio-in-"read-only"-mode) diff --git a/versioned_docs/version-7.1/studio/server/certificates/server-management-certificates-view.mdx b/versioned_docs/version-7.1/studio/server/certificates/server-management-certificates-view.mdx index 42e01bc0e7..956a69e409 100644 --- a/versioned_docs/version-7.1/studio/server/certificates/server-management-certificates-view.mdx +++ b/versioned_docs/version-7.1/studio/server/certificates/server-management-certificates-view.mdx @@ -17,13 +17,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use the **Certificates** view to create, customize, import and export certificates. * In this article: - * [The certificates view](../../../studio/server/certificates/server-management-certificates-view.mdx#the-certificates-view) - * [View and edit certificates](../../../studio/server/certificates/server-management-certificates-view.mdx#view-and-edit-certificates) - * [Generate a client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#generate-a-client-certificate) - * [Enable communication between secure servers](../../../studio/server/certificates/server-management-certificates-view.mdx#enable-communication-between-secure-servers) - * [Upload an existing client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#upload-an-existing-client-certificate) - * [Export server certificates](../../../studio/server/certificates/server-management-certificates-view.mdx#export-server-certificates) - * [Certificate collections](../../../studio/server/certificates/server-management-certificates-view.mdx#certificate-collections) + * [The certificates view](#the-certificates-view) + * [View and edit certificates](#view-and-edit-certificates) + * [Generate a client certificate](#generate-a-client-certificate) + * [Enable communication between secure servers](#enable-communication-between-secure-servers) + * [Upload an existing client certificate](#upload-an-existing-client-certificate) + * [Export server certificates](#export-server-certificates) + * [Certificate collections](#certificate-collections) @@ -166,7 +166,7 @@ While uploading the client certificate you can modify its settings. ![Modify uploaded certificate settings](./assets/upload-settings.png) -See the [Generate a client certificate](../../../studio/server/certificates/server-management-certificates-view.mdx#generate-a-client-certificate) section to learn about the available settings. +See the [Generate a client certificate](#generate-a-client-certificate) section to learn about the available settings. ## Export server certificates diff --git a/versioned_docs/version-7.1/studio/server/client-configuration.mdx b/versioned_docs/version-7.1/studio/server/client-configuration.mdx index bd08f36641..efc648f77f 100644 --- a/versioned_docs/version-7.1/studio/server/client-configuration.mdx +++ b/versioned_docs/version-7.1/studio/server/client-configuration.mdx @@ -32,7 +32,7 @@ import Panel from '@site/src/components/Panel'; see: [Client configuration (for database)](../../studio/database/settings/client-configuration-per-database.mdx) * In this article: - * [Set the client configuration (server-wide)](../../studio/server/client-configuration.mdx#set-the-client-configuration-server-wide) + * [Set the client configuration (server-wide)](#set-the-client-configuration-server-wide) diff --git a/versioned_docs/version-7.1/studio/server/debug/admin-js-console.mdx b/versioned_docs/version-7.1/studio/server/debug/admin-js-console.mdx index 57d5ec0cc5..4c0f845639 100644 --- a/versioned_docs/version-7.1/studio/server/debug/admin-js-console.mdx +++ b/versioned_docs/version-7.1/studio/server/debug/admin-js-console.mdx @@ -28,9 +28,9 @@ Incorrect usage may crash the server, corrupt data, or cause irreversible change --- * In this article: - * [Admin JS Console view](../../../studio/server/debug/admin-js-console.mdx#admin-js-console-view) - * [Context objects in scripts](../../../studio/server/debug/admin-js-console.mdx#context-objects-in-scripts) - * [Console methods](../../../studio/server/debug/admin-js-console.mdx#console-methods) + * [Admin JS Console view](#admin-js-console-view) + * [Context objects in scripts](#context-objects-in-scripts) + * [Console methods](#console-methods) diff --git a/versioned_docs/version-7.1/studio/server/debug/admin-logs.mdx b/versioned_docs/version-7.1/studio/server/debug/admin-logs.mdx index c44479aa5e..b5fc4c06c8 100644 --- a/versioned_docs/version-7.1/studio/server/debug/admin-logs.mdx +++ b/versioned_docs/version-7.1/studio/server/debug/admin-logs.mdx @@ -29,11 +29,11 @@ import Panel from '@site/src/components/Panel'; originating resource, logger, or any other criteria. * In this article: - * [Admin Logs view](../../../studio/server/debug/admin-logs.mdx#admin-logs-view) - * [Logs on this view](../../../studio/server/debug/admin-logs.mdx#logs-on-this-view) - * [Logs on disk](../../../studio/server/debug/admin-logs.mdx#logs-on-disk) - * [Log stream](../../../studio/server/debug/admin-logs.mdx#log-stream) - * [Syntax for filter conditions](../../../studio/server/debug/admin-logs.mdx#syntax-for-filter-conditions) + * [Admin Logs view](#admin-logs-view) + * [Logs on this view](#logs-on-this-view) + * [Logs on disk](#logs-on-disk) + * [Log stream](#log-stream) + * [Syntax for filter conditions](#syntax-for-filter-conditions) @@ -45,13 +45,13 @@ From the debug menu, click **Admin Logs**. ![Click to open the Admin Logs view](./assets/admin-logs_admin-logs-menu.png) ![Admin Logs view](./assets/admin-logs_admin-logs-view.png) -1. [Logs on this view](../../../studio/server/debug/admin-logs.mdx#logs-on-this-view) +1. [Logs on this view](#logs-on-this-view) Use this section to adjust how the live log stream is displayed. You can filter the streamed data and export it in JSON format. -2. [Logs on disk](../../../studio/server/debug/admin-logs.mdx#logs-on-disk) +2. [Logs on disk](#logs-on-disk) Use this section to customize RavenDB's logging to your local storage. Filters can be applied here too, and you can download selected portions of your logs. -3. [Log stream](../../../studio/server/debug/admin-logs.mdx#log-stream) +3. [Log stream](#log-stream) This section shows the live stream of RavenDB's logs as they are generated. You can search within the stream and expand individual log entries for more detail. @@ -61,12 +61,12 @@ From the debug menu, click **Admin Logs**. **Use these controls to**: -* Adjust [monitor controls](../../../studio/server/debug/admin-logs.mdx#monitor-controls). -* Set the [minimum logging level](../../../studio/server/debug/admin-logs.mdx#set-displayed-logs-minimum-level) +* Adjust [monitor controls](#monitor-controls). +* Set the [minimum logging level](#set-displayed-logs-minimum-level) from which log entries are displayed. -* Create [additional filters](../../../studio/server/debug/admin-logs.mdx#set-displayed-logs-filters) +* Create [additional filters](#set-displayed-logs-filters) to select the precise data that you want to view. -* [Export the displayed log data](../../../studio/server/debug/admin-logs.mdx#export-displayed-logs-data) +* [Export the displayed log data](#export-displayed-logs-data) to files. ![Logs on this view](./assets/admin-logs_logs-on-this-view.png) @@ -132,11 +132,11 @@ From the debug menu, click **Admin Logs**. **Use these controls to**: -* Set the [minimum logging level](../../../studio/server/debug/admin-logs.mdx#define-logs-on-disk-minimum-level) +* Set the [minimum logging level](#define-logs-on-disk-minimum-level) from which log entries are stored in log files on the server disk. -* Create [additional filters](../../../studio/server/debug/admin-logs.mdx#define-logs-on-disk-filters) +* Create [additional filters](#define-logs-on-disk-filters) to select the precise data that you want to log. -* [Download existing log files](../../../studio/server/debug/admin-logs.mdx#download-log-files) +* [Download existing log files](#download-log-files) from the server disk by a date range of your choice. ![Logs on disk](./assets/admin-logs_logs-on-disk.png) @@ -217,7 +217,7 @@ From the debug menu, click **Admin Logs**. -* This area displays live log entries as they are generated by the server, filtered by the [Logs on this view](../../../studio/server/debug/admin-logs.mdx#logs-on-this-view) settings. +* This area displays live log entries as they are generated by the server, filtered by the [Logs on this view](#logs-on-this-view) settings. You can search and expand individual entries for more details. ![Log stream](./assets/admin-logs_log-stream.png) diff --git a/versioned_docs/version-7.1/studio/server/debug/advanced/cluster-observer.mdx b/versioned_docs/version-7.1/studio/server/debug/advanced/cluster-observer.mdx index c69097bdc1..598b471b23 100644 --- a/versioned_docs/version-7.1/studio/server/debug/advanced/cluster-observer.mdx +++ b/versioned_docs/version-7.1/studio/server/debug/advanced/cluster-observer.mdx @@ -23,9 +23,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; If there is no Leader, no Database Group Topology decisions can be made. * In this page: - * [The Observer Log](../../../../studio/server/debug/advanced/cluster-observer.mdx#the-observer-log) - * [Observer Log Data](../../../../studio/server/debug/advanced/cluster-observer.mdx#observer-log-data) - * [States Flow](../../../../studio/server/debug/advanced/cluster-observer.mdx#states-flow) + * [The Observer Log](#the-observer-log) + * [Observer Log Data](#observer-log-data) + * [States Flow](#states-flow) diff --git a/versioned_docs/version-7.1/studio/server/manage-server.mdx b/versioned_docs/version-7.1/studio/server/manage-server.mdx index 672747ad15..cd4b3928bd 100644 --- a/versioned_docs/version-7.1/studio/server/manage-server.mdx +++ b/versioned_docs/version-7.1/studio/server/manage-server.mdx @@ -17,9 +17,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Use the **Manage Server** menu to access your server's configuration and debugging options. * In this page: - * [Manage Server menu](../../studio/server/manage-server.mdx#manage-server-menu) - * [Configuration options](../../studio/server/manage-server.mdx#manage-server-configuration-options) - * [Debug options](../../studio/server/manage-server.mdx#debug-debugging-and-statistics-options) + * [Manage Server menu](#manage-server-menu) + * [Configuration options](#manage-server-configuration-options) + * [Debug options](#debug-debugging-and-statistics-options) ## Manage Server menu diff --git a/versioned_docs/version-7.1/studio/server/server-settings.mdx b/versioned_docs/version-7.1/studio/server/server-settings.mdx index e31a2a9545..0b54eac714 100644 --- a/versioned_docs/version-7.1/studio/server/server-settings.mdx +++ b/versioned_docs/version-7.1/studio/server/server-settings.mdx @@ -24,7 +24,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings.mdx) view. * In this page: - * [Server Settings View](../../studio/server/server-settings.mdx#server-settings-view) + * [Server Settings View](#server-settings-view) ## Server Settings View diff --git a/versioned_docs/version-7.1/studio/server/server-wide-backup.mdx b/versioned_docs/version-7.1/studio/server/server-wide-backup.mdx index 217812950a..ff2f7db769 100644 --- a/versioned_docs/version-7.1/studio/server/server-wide-backup.mdx +++ b/versioned_docs/version-7.1/studio/server/server-wide-backup.mdx @@ -32,10 +32,10 @@ _-or-_ files locally or in a variety of remote locations. * In this page: - * [Scheduling a Server-Wide Backup Task](../../studio/server/server-wide-backup.mdx#scheduling-a-server-wide-backup-task) - * [Restoring a Database From a Server-Wide Backup](../../studio/server/server-wide-backup.mdx#restoring-a-database-from-a-server-wide-backup) - * [Server-Wide Backup Tasks in the Database Tasks View](../../studio/server/server-wide-backup.mdx#server-wide-backup-tasks-in-the-database-tasks-view) - * [The Responsible Node](../../studio/server/server-wide-backup.mdx#the-responsible-node) + * [Scheduling a Server-Wide Backup Task](#scheduling-a-server-wide-backup-task) + * [Restoring a Database From a Server-Wide Backup](#restoring-a-database-from-a-server-wide-backup) + * [Server-Wide Backup Tasks in the Database Tasks View](#server-wide-backup-tasks-in-the-database-tasks-view) + * [The Responsible Node](#the-responsible-node) ## Scheduling a Server-Wide Backup Task @@ -77,7 +77,7 @@ The settings are similar to those of a [regular backup task](../../studio/databa See below. 7. **Destination** - See [below](../../studio/server/server-wide-backup.mdx#destination). + See [below](#destination). * If you use an [Amazon S3](https://aws.amazon.com/s3/) custom host: ![ForcePathStyle](./assets/studio-force-path-style.png) * a- **Use a custom S3 host** @@ -124,7 +124,7 @@ Backup files are created in a separate child folder per database, under a common ## Restoring a Database From a Server-Wide Backup There is no difference between restoring a database from a backup file created by the -[Server-Wide procedure](../../studio/server/server-wide-backup.mdx#scheduling-a-server-wide-backup-task) +[Server-Wide procedure](#scheduling-a-server-wide-backup-task) and a [separately created backup](../../studio/database/tasks/backup-task.mdx#backup-task). In both cases, you can restore the database by [Creating a New Database from Backup](../../studio/database/create-new-database/from-backup.mdx). @@ -162,7 +162,7 @@ To edit or modify a Server-Wide task, navigate back to the [Server-Wide Backup v ## The Responsible Node * When defining a Server-Wide backup, the user is not given the option to select a - [responsible node](../../studio/server/server-wide-backup.mdx#the-responsible-node) manually, + [responsible node](#the-responsible-node) manually, since the responsible node can differ per database depending on the nodes the database resides on (the [Database Group](../../studio/database/settings/manage-database-group.mdx#database-group)). For each database, the responsible node for the task is set by the cluster to one of the database group nodes. diff --git a/versioned_docs/version-7.1/users-issues/recovering-from-voron-errors.mdx b/versioned_docs/version-7.1/users-issues/recovering-from-voron-errors.mdx index 307921d198..77ba676119 100644 --- a/versioned_docs/version-7.1/users-issues/recovering-from-voron-errors.mdx +++ b/versioned_docs/version-7.1/users-issues/recovering-from-voron-errors.mdx @@ -28,7 +28,7 @@ If such errors happen, they need to be reported as soon as possible to [RavenDB * Such exceptions are caused by the corruption of a Voron _data file_, which could occur due to a few reasons: * Hardware failure of hard-drive or memory - * In compliance‏ with RavenDB [hardware and OS requirements](../users-issues/recovering-from-voron-errors.mdx#ravendb-hardware-and-os-requirements) + * In compliance‏ with RavenDB [hardware and OS requirements](#ravendb-hardware-and-os-requirements) * Critical bug in `Voron` From 0e6f036bde4683b9812b21a45a4066ca47c2551d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Tue, 30 Jun 2026 15:22:29 +0200 Subject: [PATCH 10/16] RDoc-3724 Shorten non-minimal relative internal links to minimal form (docs, cloud, 7.1, 6.2) --- cloud/cloud-api.mdx | 2 +- cloud/cloud-aws-marketplace.mdx | 2 +- cloud/cloud-backup-and-restore.mdx | 10 +- cloud/cloud-instances.mdx | 30 ++-- cloud/cloud-microsoft-azure-marketplace.mdx | 2 +- cloud/cloud-migration.mdx | 6 +- cloud/cloud-overview.mdx | 26 +-- cloud/cloud-pricing-payment-billing.mdx | 12 +- cloud/cloud-scaling.mdx | 18 +-- cloud/cloud-security.mdx | 8 +- cloud/cloud-settings.mdx | 4 +- cloud/portal/cloud-portal-account-tab.mdx | 2 +- cloud/portal/cloud-portal-api-tab.mdx | 2 +- cloud/portal/cloud-portal-backups-tab.mdx | 4 +- cloud/portal/cloud-portal-products-tab.mdx | 20 +-- cloud/portal/cloud-portal-support-tab.mdx | 6 +- cloud/portal/cloud-portal.mdx | 26 +-- .../_reading-conversation-history-csharp.mdx | 10 +- .../_creating-ai-agents_api-csharp.mdx | 26 +-- .../_creating-ai-agents_api-nodejs.mdx | 26 +-- .../_creating-ai-agents_api-python.mdx | 14 +- .../creating-ai-agents_studio.mdx | 16 +- .../ai-integration/ai-agents/multi-agents.mdx | 8 +- docs/ai-integration/ai-agents/overview.mdx | 48 +++--- .../ai-agents/security-concerns.mdx | 6 +- docs/ai-integration/ai-tasks-list-view.mdx | 4 +- docs/ai-integration/configuration.mdx | 4 +- .../content/_azure-open-ai-csharp.mdx | 10 +- .../content/_azure-open-ai-nodejs.mdx | 10 +- .../content/_azure-open-ai-python.mdx | 10 +- .../content/_embedded-csharp.mdx | 4 +- .../content/_embedded-nodejs.mdx | 4 +- .../content/_embedded-python.mdx | 4 +- .../content/_google-ai-csharp.mdx | 10 +- .../content/_google-ai-nodejs.mdx | 10 +- .../content/_google-ai-python.mdx | 10 +- .../content/_hugging-face-csharp.mdx | 4 +- .../content/_hugging-face-nodejs.mdx | 4 +- .../content/_hugging-face-python.mdx | 4 +- .../content/_mistral-ai-csharp.mdx | 4 +- .../content/_mistral-ai-nodejs.mdx | 4 +- .../content/_mistral-ai-python.mdx | 4 +- .../content/_ollama-csharp.mdx | 6 +- .../content/_ollama-nodejs.mdx | 6 +- .../content/_ollama-python.mdx | 6 +- .../content/_open-ai-csharp.mdx | 10 +- .../content/_open-ai-nodejs.mdx | 10 +- .../content/_open-ai-python.mdx | 10 +- .../content/_vertex-ai-csharp.mdx | 4 +- .../content/_vertex-ai-nodejs.mdx | 4 +- .../content/_vertex-ai-python.mdx | 4 +- .../connection-strings/overview.mdx | 38 ++--- .../_create-gen-ai-task_api-csharp.mdx | 16 +- .../_create-gen-ai-task_api-nodejs.mdx | 24 +-- .../_create-gen-ai-task_api-python.mdx | 16 +- .../create-gen-ai-task_studio.mdx | 10 +- .../gen-ai-security-concerns.mdx | 8 +- .../_modify-gen-ai-task_api-csharp.mdx | 6 +- .../_modify-gen-ai-task_api-nodejs.mdx | 6 +- .../_modify-gen-ai-task_api-python.mdx | 6 +- .../modify-gen-ai-task_studio.mdx | 6 +- .../gen-ai-integration/overview.mdx | 16 +- .../_processing-attachments_api-csharp.mdx | 18 +-- .../_processing-attachments_api-nodejs.mdx | 18 +-- .../_processing-attachments_api-python.mdx | 18 +-- .../processing-attachments_studio.mdx | 6 +- .../_embeddings-generation-task-csharp.mdx | 24 +-- .../_embeddings-generation-task-nodejs.mdx | 22 +-- .../_embeddings-generation-task-python.mdx | 24 +-- .../content/_overview-csharp.mdx | 42 ++--- .../content/_overview-nodejs.mdx | 46 +++--- .../content/_overview-python.mdx | 46 +++--- .../embedding-collections.mdx | 8 +- .../generating-embeddings/start.mdx | 10 +- .../_data-types-for-vector-search-csharp.mdx | 4 +- .../_data-types-for-vector-search-nodejs.mdx | 4 +- ...g-attachments-for-vector-search-csharp.mdx | 6 +- ...g-attachments-for-vector-search-nodejs.mdx | 6 +- ...g-attachments-for-vector-search-python.mdx | 6 +- ...ctor-search-using-dynamic-query-csharp.mdx | 26 +-- ...ctor-search-using-dynamic-query-nodejs.mdx | 26 +-- ...ctor-search-using-dynamic-query-python.mdx | 22 +-- ...ector-search-using-static-index-csharp.mdx | 44 ++--- ...ector-search-using-static-index-nodejs.mdx | 34 ++-- ...ector-search-using-static-index-python.mdx | 34 ++-- .../ai-integration/vector-search/overview.mdx | 38 ++--- docs/ai-integration/vector-search/start.mdx | 8 +- .../what-affects-vector-search-results.mdx | 20 +-- docs/backup/configuration.mdx | 6 +- docs/backup/create/one-time-backup.mdx | 20 +-- .../create/periodic-tasks/database-backup.mdx | 22 +-- .../periodic-tasks/server-wide-backup.mdx | 22 +-- docs/backup/faq.mdx | 18 +-- docs/backup/overview.mdx | 42 ++--- docs/backup/restore.mdx | 14 +- ...work-with-bulk-insert-operation-csharp.mdx | 4 +- ...-subscribe-to-operation-changes-csharp.mdx | 4 +- .../content/_what-is-changes-api-csharp.mdx | 36 ++--- .../content/_what-is-changes-api-java.mdx | 22 +-- .../content/_what-is-changes-api-nodejs.mdx | 22 +-- ...es-with-replication-and-cluster-csharp.mdx | 4 +- ...ates-with-replication-and-cluster-java.mdx | 2 +- ...es-with-replication-and-cluster-nodejs.mdx | 2 +- docs/client-api/cluster/speed-test.mdx | 2 +- ...multiple-commands-using-a-batch-csharp.mdx | 6 +- ...multiple-commands-using-a-batch-nodejs.mdx | 6 +- .../commands/content/_overview-csharp.mdx | 20 +-- .../commands/content/_overview-java.mdx | 12 +- .../commands/content/_overview-nodejs.mdx | 20 +-- .../documents/content/_delete-csharp.mdx | 2 +- .../documents/content/_delete-nodejs.mdx | 2 +- .../documents/content/_get-csharp.mdx | 2 +- .../documents/content/_get-nodejs.mdx | 2 +- .../documents/content/_put-csharp.mdx | 4 +- .../documents/content/_put-nodejs.mdx | 4 +- .../content/_conventions-csharp.mdx | 34 ++-- .../content/_conventions-nodejs.mdx | 18 +-- .../content/_deserialization-csharp.mdx | 4 +- .../content/_serialization-csharp.mdx | 6 +- .../content/_global-csharp.mdx | 2 +- .../content/_global-java.mdx | 2 +- .../content/_global-nodejs.mdx | 2 +- .../content/_type-specific-csharp.mdx | 2 +- .../content/_type-specific-java.mdx | 2 +- .../content/_type-specific-nodejs.mdx | 2 +- .../content/_load-balance-behavior-csharp.mdx | 16 +- .../content/_load-balance-behavior-nodejs.mdx | 16 +- .../content/_load-balance-behavior-php.mdx | 16 +- .../content/_load-balance-behavior-python.mdx | 16 +- .../content/_read-balance-behavior-csharp.mdx | 14 +- .../content/_read-balance-behavior-nodejs.mdx | 14 +- .../content/_read-balance-behavior-php.mdx | 14 +- .../content/_read-balance-behavior-python.mdx | 14 +- .../configuration/load-balance/overview.mdx | 20 +-- .../_creating-document-store-csharp.mdx | 10 +- .../_setting-up-default-database-java.mdx | 2 +- .../_setting-up-default-database-nodejs.mdx | 2 +- .../_what-is-a-document-store-csharp.mdx | 18 +-- .../_what-is-a-document-store-java.mdx | 14 +- .../_what-is-a-document-store-nodejs.mdx | 12 +- .../_maintenance-operations-csharp.mdx | 4 +- .../_maintenance-operations-nodejs.mdx | 4 +- .../content/_api-overview-csharp.mdx | 4 +- .../content/_api-overview-java.mdx | 2 +- .../content/_api-overview-nodejs.mdx | 6 +- .../content/_api-overview-python.mdx | 6 +- ...ow-to-consume-data-subscription-csharp.mdx | 8 +- ..._how-to-consume-data-subscription-java.mdx | 4 +- ...ow-to-consume-data-subscription-nodejs.mdx | 8 +- ...ow-to-consume-data-subscription-python.mdx | 6 +- .../_concurrent-subscriptions-csharp.mdx | 8 +- .../_concurrent-subscriptions-nodejs.mdx | 8 +- .../_what-are-data-subscriptions-csharp.mdx | 14 +- .../_what-are-data-subscriptions-java.mdx | 8 +- .../_what-are-data-subscriptions-nodejs.mdx | 8 +- .../creation/content/_api-overview-csharp.mdx | 4 +- .../creation/content/_api-overview-nodejs.mdx | 12 +- .../creation/content/_api-overview-python.mdx | 2 +- .../creation/content/_examples-csharp.mdx | 10 +- .../creation/content/_examples-nodejs.mdx | 10 +- .../creation/content/_examples-python.mdx | 8 +- ...how-to-create-data-subscription-csharp.mdx | 6 +- .../_how-to-create-data-subscription-java.mdx | 4 +- ...how-to-create-data-subscription-nodejs.mdx | 6 +- ...how-to-create-data-subscription-python.mdx | 6 +- .../content/_hilo-algorithm-csharp.mdx | 12 +- ...rking-with-document-identifiers-csharp.mdx | 16 +- docs/client-api/faq/transaction-support.mdx | 28 ++-- docs/client-api/faq/what-is-a-collection.mdx | 4 +- .../_setup-aggressive-caching-csharp.mdx | 12 +- .../_setup-aggressive-caching-java.mdx | 12 +- .../_setup-aggressive-caching-python.mdx | 12 +- .../how-to/subscribe-to-store-events.mdx | 20 +-- .../content/_delete-by-query-csharp.mdx | 4 +- .../content/_delete-by-query-nodejs.mdx | 4 +- .../common/content/_delete-by-query-php.mdx | 4 +- .../content/_delete-by-query-python.mdx | 2 +- .../content/_what-are-operations-csharp.mdx | 132 +++++++-------- .../content/_what-are-operations-java.mdx | 66 ++++---- .../content/_what-are-operations-nodejs.mdx | 132 +++++++-------- .../content/_what-are-operations-php.mdx | 132 +++++++-------- .../content/_what-are-operations-python.mdx | 132 +++++++-------- ...rations-to-a-different-database-csharp.mdx | 6 +- ...rations-to-a-different-database-nodejs.mdx | 6 +- ...operations-to-a-different-database-php.mdx | 6 +- ...rations-to-a-different-database-python.mdx | 6 +- ...-operations-to-a-different-node-csharp.mdx | 4 +- ...-operations-to-a-different-node-nodejs.mdx | 4 +- ...tch-operations-to-a-different-node-php.mdx | 4 +- .../_database-settings-operation-csharp.mdx | 2 +- .../_database-settings-operation-nodejs.mdx | 2 +- .../_database-settings-operation-php.mdx | 2 +- .../_get-client-configuration-csharp.mdx | 2 +- .../_get-client-configuration-nodejs.mdx | 2 +- .../content/_get-client-configuration-php.mdx | 2 +- .../_get-client-configuration-python.mdx | 2 +- .../_put-client-configuration-csharp.mdx | 10 +- .../_put-client-configuration-nodejs.mdx | 10 +- .../content/_put-client-configuration-php.mdx | 10 +- .../_put-client-configuration-python.mdx | 10 +- .../content/_get-connection-string-csharp.mdx | 4 +- .../maintenance/content/_get-stats-csharp.mdx | 2 +- .../maintenance/content/_get-stats-java.mdx | 2 +- .../maintenance/content/_get-stats-nodejs.mdx | 2 +- .../maintenance/content/_get-stats-php.mdx | 2 +- .../maintenance/content/_get-stats-python.mdx | 2 +- .../etl/content/_add-etl-csharp.mdx | 10 +- .../content/_get-identities-csharp.mdx | 2 +- .../content/_get-identities-php.mdx | 2 +- .../content/_get-identities-python.mdx | 2 +- .../content/_delete-index-errors-csharp.mdx | 4 +- .../content/_delete-index-errors-nodejs.mdx | 4 +- .../content/_delete-index-errors-php.mdx | 4 +- .../content/_delete-index-errors-python.mdx | 4 +- .../indexes/content/_disable-index-csharp.mdx | 12 +- .../indexes/content/_disable-index-java.mdx | 2 +- .../indexes/content/_disable-index-nodejs.mdx | 12 +- .../indexes/content/_disable-index-php.mdx | 12 +- .../indexes/content/_disable-index-python.mdx | 12 +- .../indexes/content/_enable-index-csharp.mdx | 8 +- .../indexes/content/_enable-index-nodejs.mdx | 8 +- .../indexes/content/_enable-index-php.mdx | 8 +- .../indexes/content/_enable-index-python.mdx | 8 +- .../indexes/content/_get-index-csharp.mdx | 4 +- .../content/_get-index-errors-csharp.mdx | 4 +- .../content/_get-index-errors-nodejs.mdx | 4 +- .../indexes/content/_get-index-errors-php.mdx | 4 +- .../content/_get-index-errors-python.mdx | 4 +- .../indexes/content/_get-index-nodejs.mdx | 4 +- .../indexes/content/_get-index-php.mdx | 2 +- .../indexes/content/_get-index-python.mdx | 4 +- .../indexes/content/_get-indexes-csharp.mdx | 4 +- .../indexes/content/_get-indexes-nodejs.mdx | 4 +- .../indexes/content/_get-indexes-php.mdx | 2 +- .../indexes/content/_get-indexes-python.mdx | 4 +- .../content/_index-has-changed-csharp.mdx | 2 +- .../content/_index-has-changed-nodejs.mdx | 2 +- .../content/_index-has-changed-php.mdx | 2 +- .../content/_index-has-changed-python.mdx | 2 +- .../indexes/content/_put-indexes-csharp.mdx | 2 +- .../indexes/content/_put-indexes-nodejs.mdx | 2 +- .../indexes/content/_put-indexes-php.mdx | 2 +- .../indexes/content/_put-indexes-python.mdx | 2 +- .../indexes/content/_reset-index-csharp.mdx | 8 +- .../indexes/content/_reset-index-nodejs.mdx | 8 +- .../indexes/content/_reset-index-php.mdx | 4 +- .../indexes/content/_reset-index-python.mdx | 8 +- .../content/_set-index-lock-csharp.mdx | 2 +- .../content/_set-index-lock-nodejs.mdx | 2 +- .../indexes/content/_set-index-lock-php.mdx | 2 +- .../content/_set-index-lock-python.mdx | 2 +- .../indexes/content/_start-index-csharp.mdx | 2 +- .../indexes/content/_start-index-nodejs.mdx | 2 +- .../indexes/content/_start-index-php.mdx | 2 +- .../indexes/content/_start-index-python.mdx | 2 +- .../content/_start-indexing-csharp.mdx | 4 +- .../content/_start-indexing-nodejs.mdx | 4 +- .../indexes/content/_start-indexing-php.mdx | 4 +- .../content/_start-indexing-python.mdx | 4 +- .../indexes/content/_stop-index-csharp.mdx | 10 +- .../indexes/content/_stop-index-nodejs.mdx | 10 +- .../indexes/content/_stop-index-php.mdx | 10 +- .../indexes/content/_stop-index-python.mdx | 10 +- .../indexes/content/_stop-indexing-csharp.mdx | 10 +- .../indexes/content/_stop-indexing-java.mdx | 4 +- .../indexes/content/_stop-indexing-nodejs.mdx | 10 +- .../indexes/content/_stop-indexing-php.mdx | 10 +- .../indexes/content/_stop-indexing-python.mdx | 10 +- .../_ongoing-task-operations-csharp.mdx | 2 +- .../patching/content/_set-based-nodejs.mdx | 4 +- .../content/_single-document-csharp.mdx | 2 +- .../content/_single-document-nodejs.mdx | 12 +- .../operations/patching/json-patch-syntax.mdx | 2 +- ...serverwide-client-configuration-csharp.mdx | 6 +- ...serverwide-client-configuration-nodejs.mdx | 6 +- ...serverwide-client-configuration-csharp.mdx | 6 +- ...serverwide-client-configuration-nodejs.mdx | 6 +- .../content/_compact-database-csharp.mdx | 8 +- .../content/_compact-database-nodejs.mdx | 8 +- .../content/_compact-database-php.mdx | 6 +- .../content/_compact-database-python.mdx | 4 +- .../content/_create-database-csharp.mdx | 14 +- .../content/_create-database-java.mdx | 12 +- .../document-commands/batch-commands.mdx | 8 +- .../document-commands/get-documents-by-id.mdx | 4 +- .../document-commands/put-documents.mdx | 2 +- .../rest-api/queries/patch-by-query.mdx | 2 +- .../rest-api/queries/query-the-database.mdx | 10 +- docs/client-api/rest-api/rest-api-intro.mdx | 4 +- .../content/_overview-csharp.mdx | 6 +- .../content/_overview-nodejs.mdx | 4 +- .../content/_overview-php.mdx | 4 +- .../content/_overview-python.mdx | 4 +- .../_how-to-disable-caching-csharp.mdx | 2 +- .../content/_how-to-disable-caching-java.mdx | 2 +- .../_how-to-disable-caching-nodejs.mdx | 2 +- .../content/_how-to-disable-caching-php.mdx | 2 +- .../_how-to-disable-tracking-csharp.mdx | 2 +- ...o-enable-optimistic-concurrency-csharp.mdx | 24 +-- ...-to-enable-optimistic-concurrency-java.mdx | 6 +- ...o-enable-optimistic-concurrency-nodejs.mdx | 10 +- ...w-to-enable-optimistic-concurrency-php.mdx | 8 +- ...o-enable-optimistic-concurrency-python.mdx | 10 +- ...o-customize-id-generation-for-entities.mdx | 6 +- .../content/_deleting-entities-csharp.mdx | 2 +- .../content/_deleting-entities-java.mdx | 2 +- .../content/_deleting-entities-nodejs.mdx | 2 +- .../content/_deleting-entities-php.mdx | 2 +- .../content/_deleting-entities-python.mdx | 2 +- .../content/_loading-entities-csharp.mdx | 6 +- .../content/_loading-entities-java.mdx | 2 +- .../content/_loading-entities-nodejs.mdx | 2 +- .../session/content/_loading-entities-php.mdx | 4 +- .../content/_loading-entities-python.mdx | 8 +- .../content/_opening-a-session-csharp.mdx | 12 +- .../content/_opening-a-session-java.mdx | 6 +- .../content/_opening-a-session-nodejs.mdx | 10 +- .../content/_opening-a-session-php.mdx | 10 +- .../content/_opening-a-session-python.mdx | 10 +- .../content/_saving-changes-csharp.mdx | 6 +- .../session/content/_saving-changes-java.mdx | 6 +- .../content/_saving-changes-nodejs.mdx | 4 +- .../session/content/_saving-changes-php.mdx | 4 +- .../content/_saving-changes-python.mdx | 6 +- .../content/_updating-entities-csharp.mdx | 2 +- .../content/_updating-entities-nodejs.mdx | 2 +- .../content/_updating-entities-php.mdx | 2 +- .../content/_updating-entities-python.mdx | 2 +- ...-a-session-and-how-does-it-work-csharp.mdx | 38 ++--- ...is-a-session-and-how-does-it-work-java.mdx | 38 ++--- ...-a-session-and-how-does-it-work-nodejs.mdx | 40 ++--- ...-is-a-session-and-how-does-it-work-php.mdx | 38 ++--- ...-a-session-and-how-does-it-work-python.mdx | 38 ++--- .../_check-if-attachment-exists-csharp.mdx | 2 +- .../_check-if-attachment-exists-java.mdx | 2 +- .../_check-if-attachment-exists-nodejs.mdx | 2 +- .../_check-if-attachment-exists-php.mdx | 2 +- .../_check-if-attachment-exists-python.mdx | 2 +- .../_check-if-document-exists-csharp.mdx | 2 +- .../_check-if-document-exists-java.mdx | 2 +- .../_check-if-document-exists-nodejs.mdx | 2 +- .../content/_check-if-document-exists-php.mdx | 2 +- .../_check-if-document-exists-python.mdx | 2 +- .../_check-if-entity-has-changed-csharp.mdx | 6 +- .../_check-if-entity-has-changed-nodejs.mdx | 6 +- .../_check-if-entity-has-changed-php.mdx | 4 +- .../_check-if-entity-has-changed-python.mdx | 4 +- ...re-are-any-changes-on-a-session-csharp.mdx | 6 +- ...here-are-any-changes-on-a-session-java.mdx | 2 +- ...re-are-any-changes-on-a-session-nodejs.mdx | 6 +- ...there-are-any-changes-on-a-session-php.mdx | 4 +- ...re-are-any-changes-on-a-session-python.mdx | 4 +- .../content/_clear-a-session-csharp.mdx | 2 +- .../content/_clear-a-session-nodejs.mdx | 2 +- .../_evict-entity-from-a-session-csharp.mdx | 10 +- .../_evict-entity-from-a-session-java.mdx | 2 +- .../_evict-entity-from-a-session-nodejs.mdx | 10 +- .../_evict-entity-from-a-session-php.mdx | 2 +- .../_evict-entity-from-a-session-python.mdx | 2 +- .../_get-current-session-node-csharp.mdx | 4 +- .../_get-current-session-node-java.mdx | 4 +- .../_get-current-session-node-nodejs.mdx | 4 +- .../content/_get-current-session-node-php.mdx | 4 +- .../content/_get-tracked-entities-csharp.mdx | 6 +- .../content/_get-tracked-entities-nodejs.mdx | 6 +- .../content/_ignore-entity-changes-csharp.mdx | 8 +- .../content/_ignore-entity-changes-nodejs.mdx | 8 +- .../content/_ignore-entity-changes-php.mdx | 8 +- .../content/_ignore-entity-changes-python.mdx | 2 +- .../_perform-operations-lazily-csharp.mdx | 10 +- .../_perform-operations-lazily-nodejs.mdx | 10 +- .../_perform-operations-lazily-php.mdx | 10 +- .../_perform-operations-lazily-python.mdx | 10 +- .../content/_subscribe-to-events-csharp.mdx | 2 +- .../content/_subscribe-to-events-java.mdx | 2 +- .../content/_subscribe-to-events-nodejs.mdx | 2 +- .../_how-to-count-query-results-csharp.mdx | 2 +- .../_how-to-count-query-results-nodejs.mdx | 2 +- .../_how-to-count-query-results-php.mdx | 2 +- .../_how-to-count-query-results-python.mdx | 2 +- .../_how-to-get-query-statistics-csharp.mdx | 2 +- .../_how-to-get-query-statistics-php.mdx | 2 +- .../_how-to-get-query-statistics-python.mdx | 2 +- .../_how-to-perform-queries-lazily-csharp.mdx | 6 +- .../_how-to-perform-queries-lazily-nodejs.mdx | 6 +- .../_how-to-perform-queries-lazily-php.mdx | 4 +- .../_how-to-perform-queries-lazily-python.mdx | 10 +- .../_how-to-project-query-results-csharp.mdx | 2 +- .../_how-to-project-query-results-nodejs.mdx | 2 +- .../_how-to-project-query-results-php.mdx | 2 +- .../_how-to-project-query-results-python.mdx | 2 +- .../content/_ends-with-query-csharp.mdx | 2 +- .../content/_ends-with-query-nodejs.mdx | 2 +- .../content/_ends-with-query-php.mdx | 2 +- .../content/_ends-with-query-python.mdx | 2 +- .../content/_full-text-search-csharp.mdx | 6 +- .../content/_full-text-search-nodejs.mdx | 4 +- .../content/_full-text-search-php.mdx | 4 +- .../content/_full-text-search-python.mdx | 4 +- .../_highlight-query-results-csharp.mdx | 4 +- .../_highlight-query-results-nodejs.mdx | 4 +- .../content/_highlight-query-results-php.mdx | 4 +- .../_highlight-query-results-python.mdx | 4 +- .../content/_proximity-search-csharp.mdx | 2 +- .../content/_proximity-search-nodejs.mdx | 2 +- .../content/_proximity-search-php.mdx | 2 +- .../content/_proximity-search-python.mdx | 2 +- .../content/_what-is-smuggler-csharp.mdx | 2 +- .../content/_what-is-smuggler-java.mdx | 2 +- .../content/_what-is-smuggler-nodejs.mdx | 2 +- .../client-api-references.mdx | 42 ++--- .../studio-references.mdx | 10 +- docs/compare-exchange/configuration.mdx | 2 +- .../content/_atomic-guards-csharp.mdx | 10 +- .../content/_atomic-guards-nodejs.mdx | 10 +- .../content/_atomic-guards-php.mdx | 10 +- .../content/_atomic-guards-python.mdx | 10 +- .../_cmpxchg-in-dynamic-queries-csharp.mdx | 2 +- .../_cmpxchg-in-dynamic-queries-nodejs.mdx | 2 +- .../_cmpxchg-item-expiration-csharp.mdx | 8 +- .../_cmpxchg-item-expiration-nodejs.mdx | 8 +- .../content/_create-cmpxchg-items-csharp.mdx | 6 +- .../content/_create-cmpxchg-items-java.mdx | 6 +- .../content/_create-cmpxchg-items-nodejs.mdx | 6 +- .../content/_create-cmpxchg-items-php.mdx | 4 +- .../content/_create-cmpxchg-items-python.mdx | 4 +- .../content/_delete-cmpxchg-items-csharp.mdx | 6 +- .../content/_delete-cmpxchg-items-java.mdx | 6 +- .../content/_delete-cmpxchg-items-nodejs.mdx | 6 +- .../content/_delete-cmpxchg-items-php.mdx | 6 +- .../content/_delete-cmpxchg-items-python.mdx | 6 +- .../content/_get-cmpxchg-item-csharp.mdx | 4 +- .../content/_get-cmpxchg-item-java.mdx | 4 +- .../content/_get-cmpxchg-item-nodejs.mdx | 4 +- .../content/_get-cmpxchg-item-php.mdx | 4 +- .../content/_get-cmpxchg-item-python.mdx | 4 +- .../content/_get-cmpxchg-items-csharp.mdx | 6 +- .../content/_get-cmpxchg-items-java.mdx | 4 +- .../content/_get-cmpxchg-items-nodejs.mdx | 6 +- .../content/_get-cmpxchg-items-php.mdx | 4 +- .../content/_get-cmpxchg-items-python.mdx | 4 +- ..._include-compare-exchange-items-csharp.mdx | 2 +- ..._include-compare-exchange-items-nodejs.mdx | 2 +- ...ndexing-compare-exchange-values-csharp.mdx | 2 +- ...ndexing-compare-exchange-values-nodejs.mdx | 2 +- .../content/_overview-csharp.mdx | 14 +- .../content/_overview-java.mdx | 14 +- .../content/_overview-php.mdx | 14 +- .../content/_overview-python.mdx | 14 +- .../content/_update-cmpxchg-item-csharp.mdx | 4 +- .../content/_update-cmpxchg-item-java.mdx | 2 +- .../content/_update-cmpxchg-item-nodejs.mdx | 4 +- .../client-api-references.mdx | 2 +- ...ed-documents-and-other-features-csharp.mdx | 26 +-- .../content/_enable-data-archiving-csharp.mdx | 2 +- .../_schedule-document-archiving-csharp.mdx | 4 +- .../content/_unarchiving-documents-csharp.mdx | 8 +- docs/data-archival/overview.mdx | 16 +- .../attachments-and-other-features.mdx | 4 +- .../_configure-remote-attachments-csharp.mdx | 4 +- .../content/_indexing-attachments-csharp.mdx | 4 +- .../attachments/content/_overview-csharp.mdx | 16 +- docs/document-extensions/attachments/faq.mdx | 12 +- .../content/_bulk-insert-csharp.mdx | 4 +- .../_store-attachments-local-csharp.mdx | 6 +- .../_store-attachments-remote-csharp.mdx | 26 +-- .../_counters-and-other-features-csharp.mdx | 6 +- .../_counters-and-other-features-java.mdx | 2 +- .../_counters-and-other-features-nodejs.mdx | 6 +- .../_counters-and-other-features-php.mdx | 4 +- .../_counters-and-other-features-python.mdx | 6 +- .../content/_create-or-modify-csharp.mdx | 2 +- .../content/_create-or-modify-java.mdx | 2 +- .../content/_create-or-modify-nodejs.mdx | 2 +- .../content/_create-or-modify-php.mdx | 2 +- .../content/_create-or-modify-python.mdx | 2 +- .../counters/content/_delete-csharp.mdx | 2 +- .../counters/content/_delete-java.mdx | 2 +- .../counters/content/_delete-nodejs.mdx | 2 +- .../counters/content/_delete-php.mdx | 4 +- .../counters/content/_delete-python.mdx | 4 +- .../counters/content/_overview-csharp.mdx | 10 +- .../counters/content/_overview-java.mdx | 10 +- .../counters/content/_overview-nodejs.mdx | 10 +- .../counters/content/_overview-php.mdx | 10 +- .../counters/content/_overview-python.mdx | 10 +- .../_retrieve-counter-values-csharp.mdx | 2 +- .../content/_retrieve-counter-values-java.mdx | 2 +- .../_retrieve-counter-values-nodejs.mdx | 2 +- .../content/_retrieve-counter-values-php.mdx | 2 +- .../_retrieve-counter-values-python.mdx | 2 +- .../counters/counters-in-clusters.mdx | 8 +- docs/document-extensions/overview.mdx | 8 +- .../client-api/content/_overview-csharp.mdx | 22 +-- .../client-api/content/_overview-java.mdx | 32 ++-- .../client-api/content/_overview-nodejs.mdx | 22 +-- .../client-api/content/_overview-php.mdx | 16 +- .../client-api/content/_overview-python.mdx | 16 +- .../content/_configure-revisions-csharp.mdx | 4 +- .../content/_configure-revisions-java.mdx | 2 +- .../content/_configure-revisions-nodejs.mdx | 4 +- .../content/_configure-revisions-php.mdx | 4 +- .../content/_configure-revisions-python.mdx | 4 +- ...onflict-revisions-configuration-csharp.mdx | 4 +- ...onflict-revisions-configuration-nodejs.mdx | 4 +- .../_conflict-revisions-configuration-php.mdx | 4 +- .../content/_delete-revisions-csharp.mdx | 6 +- ...enforce-revisions-configuration-csharp.mdx | 4 +- .../_enforce-revisions-configuration-java.mdx | 4 +- ...enforce-revisions-configuration-nodejs.mdx | 4 +- .../content/_get-revisions-csharp.mdx | 2 +- .../content/_get-revisions-nodejs.mdx | 2 +- .../operations/content/_get-revisions-php.mdx | 2 +- .../content/_get-revisions-python.mdx | 2 +- .../session/content/_including-csharp.mdx | 2 +- .../session/content/_including-nodejs.mdx | 2 +- .../session/content/_including-php.mdx | 2 +- .../revisions/content/_overview-csharp.mdx | 16 +- .../revisions/content/_overview-nodejs.mdx | 16 +- .../revisions/content/_overview-python.mdx | 22 +-- .../_revisions-and-other-features-csharp.mdx | 16 +- .../_revisions-and-other-features-nodejs.mdx | 14 +- .../_revisions-and-other-features-php.mdx | 14 +- .../_revisions-and-other-features-python.mdx | 14 +- ...documents-to-specific-revisions-csharp.mdx | 4 +- .../revert-documents-to-specific-time.mdx | 4 +- .../content/_append-in-bulk-csharp.mdx | 2 +- .../content/_append-in-bulk-nodejs.mdx | 2 +- .../content/_javascript-support-csharp.mdx | 10 +- .../content/_javascript-support-nodejs.mdx | 10 +- .../client-api/content/_overview-csharp.mdx | 30 ++-- .../client-api/content/_overview-nodejs.mdx | 30 ++-- .../content/_append-and-delete-csharp.mdx | 2 +- .../content/_append-and-delete-nodejs.mdx | 2 +- .../operations/content/_get-csharp.mdx | 8 +- .../operations/content/_get-nodejs.mdx | 4 +- .../operations/content/_patch-csharp.mdx | 12 +- .../operations/content/_patch-nodejs.mdx | 12 +- .../session/content/_append-csharp.mdx | 8 +- .../session/content/_append-nodejs.mdx | 8 +- .../session/content/_append-php.mdx | 2 +- .../session/content/_append-python.mdx | 8 +- .../session/content/_delete-csharp.mdx | 2 +- .../session/content/_delete-nodejs.mdx | 2 +- .../session/content/_delete-php.mdx | 2 +- .../session/content/_delete-python.mdx | 2 +- .../session/content/_patch-csharp.mdx | 4 +- .../session/content/_patch-nodejs.mdx | 4 +- .../session/content/_patch-python.mdx | 4 +- .../session/content/_querying-csharp.mdx | 8 +- .../session/content/_querying-nodejs.mdx | 8 +- .../get/content/_get-entries-csharp.mdx | 12 +- .../get/content/_get-entries-nodejs.mdx | 10 +- .../session/get/content/_get-entries-php.mdx | 6 +- .../get/content/_get-entries-python.mdx | 10 +- .../include/content/_overview-csharp.mdx | 6 +- .../include/content/_overview-nodejs.mdx | 6 +- .../timeseries/content/_design-csharp.mdx | 2 +- .../timeseries/content/_design-nodejs.mdx | 2 +- .../timeseries/content/_indexing-csharp.mdx | 6 +- .../timeseries/content/_indexing-nodejs.mdx | 6 +- .../timeseries/content/_indexing-php.mdx | 4 +- .../timeseries/content/_indexing-python.mdx | 6 +- .../content/_rollup-and-retention-csharp.mdx | 6 +- .../content/_rollup-and-retention-nodejs.mdx | 4 +- .../content/_rollup-and-retention-php.mdx | 4 +- .../content/_rollup-and-retention-python.mdx | 4 +- ..._time-series-and-other-features-csharp.mdx | 10 +- ..._time-series-and-other-features-nodejs.mdx | 10 +- .../client-api/javascript-support.mdx | 16 +- .../client-api/operations/get.mdx | 4 +- .../client-api/session/get.mdx | 14 +- .../client-api/session/increment.mdx | 4 +- .../client-api/session/overview.mdx | 16 +- .../incremental-time-series/overview.mdx | 16 +- .../timeseries/overview.mdx | 30 ++-- .../_aggregation-and-projections-csharp.mdx | 6 +- .../_aggregation-and-projections-nodejs.mdx | 6 +- .../_aggregation-and-projections-php.mdx | 4 +- .../content/_choosing-query-range-csharp.mdx | 2 +- .../content/_choosing-query-range-nodejs.mdx | 2 +- .../content/_choosing-query-range-python.mdx | 2 +- .../querying/content/_filtering-csharp.mdx | 10 +- .../querying/content/_filtering-nodejs.mdx | 10 +- .../querying/content/_filtering-php.mdx | 8 +- .../querying/content/_filtering-python.mdx | 8 +- .../querying/content/_gap-filling-csharp.mdx | 2 +- .../querying/content/_gap-filling-java.mdx | 2 +- .../querying/content/_gap-filling-nodejs.mdx | 2 +- .../content/_overview-and-syntax-csharp.mdx | 16 +- .../content/_overview-and-syntax-nodejs.mdx | 14 +- .../content/_overview-and-syntax-php.mdx | 14 +- .../content/_overview-and-syntax-python.mdx | 14 +- .../content/_stream-timeseries-csharp.mdx | 2 +- .../content/_using-indexes-csharp.mdx | 4 +- .../content/_using-indexes-nodejs.mdx | 4 +- .../querying/content/_using-indexes-php.mdx | 4 +- .../content/_using-indexes-python.mdx | 4 +- .../timeseries/querying/statistics.mdx | 4 +- .../auditing-document-compliance_api.mdx | 6 +- .../auditing-document-compliance_studio.mdx | 14 +- .../schema-validation/configuration.mdx | 14 +- docs/documents/schema-validation/overview.mdx | 46 +++--- .../write-validation/write-validation_api.mdx | 2 +- .../write-validation_studio.mdx | 6 +- docs/glossary/cluster-node.mdx | 2 +- docs/glossary/database-group.mdx | 2 +- docs/glossary/node-tag.mdx | 2 +- docs/glossary/raft-command.mdx | 2 +- docs/indexes/additional-assemblies.mdx | 2 +- docs/indexes/content/_boosting-java.mdx | 4 +- .../_creating-and-deploying-csharp.mdx | 6 +- .../content/_creating-and-deploying-java.mdx | 6 +- .../_creating-and-deploying-nodejs.mdx | 6 +- .../content/_extending-indexes-csharp.mdx | 2 +- .../content/_extending-indexes-java.mdx | 2 +- .../content/_extending-indexes-nodejs.mdx | 2 +- .../content/_indexing-basics-csharp.mdx | 8 +- .../indexes/content/_indexing-basics-java.mdx | 8 +- .../content/_indexing-basics-nodejs.mdx | 8 +- .../_indexing-linq-extensions-csharp.mdx | 4 +- .../_indexing-linq-extensions-java.mdx | 4 +- .../_indexing-linq-extensions-nodejs.mdx | 4 +- .../content/_indexing-metadata-csharp.mdx | 2 +- .../content/_indexing-metadata-nodejs.mdx | 2 +- .../content/_indexing-metadata-php.mdx | 2 +- .../content/_indexing-metadata-python.mdx | 2 +- .../content/_indexing-nested-data-csharp.mdx | 2 +- .../content/_indexing-nested-data-java.mdx | 2 +- .../content/_indexing-nested-data-nodejs.mdx | 2 +- .../content/_indexing-nested-data-php.mdx | 2 +- .../content/_indexing-nested-data-python.mdx | 2 +- .../_indexing-polymorphic-data-nodejs.mdx | 2 +- .../content/_indexing-spatial-data-csharp.mdx | 2 +- .../content/_indexing-spatial-data-java.mdx | 4 +- .../content/_indexing-spatial-data-nodejs.mdx | 2 +- .../content/_indexing-spatial-data-php.mdx | 2 +- .../content/_indexing-spatial-data-python.mdx | 2 +- .../content/_javascript-indexes-csharp.mdx | 12 +- .../content/_javascript-indexes-java.mdx | 8 +- docs/indexes/content/_map-indexes-csharp.mdx | 16 +- docs/indexes/content/_map-indexes-java.mdx | 12 +- docs/indexes/content/_map-indexes-nodejs.mdx | 12 +- docs/indexes/content/_map-indexes-php.mdx | 14 +- docs/indexes/content/_map-indexes-python.mdx | 16 +- .../content/_map-reduce-indexes-csharp.mdx | 4 +- .../content/_map-reduce-indexes-java.mdx | 4 +- .../content/_map-reduce-indexes-nodejs.mdx | 4 +- .../content/_map-reduce-indexes-php.mdx | 4 +- .../content/_map-reduce-indexes-python.mdx | 4 +- .../content/_multi-map-indexes-csharp.mdx | 4 +- .../content/_multi-map-indexes-java.mdx | 4 +- .../content/_multi-map-indexes-nodejs.mdx | 4 +- .../content/_multi-map-indexes-php.mdx | 4 +- .../content/_multi-map-indexes-python.mdx | 4 +- .../_number-type-conversion-csharp.mdx | 2 +- .../content/_storing-data-in-index-csharp.mdx | 14 +- .../content/_storing-data-in-index-java.mdx | 4 +- .../content/_storing-data-in-index-nodejs.mdx | 4 +- .../content/_storing-data-in-index-php.mdx | 4 +- .../content/_storing-data-in-index-python.mdx | 4 +- .../content/_using-analyzers-csharp.mdx | 14 +- .../indexes/content/_using-analyzers-java.mdx | 4 +- .../content/_using-analyzers-nodejs.mdx | 14 +- .../content/_using-dynamic-fields-csharp.mdx | 26 +-- .../content/_using-dynamic-fields-java.mdx | 26 +-- .../content/_using-dynamic-fields-nodejs.mdx | 22 +-- .../content/_using-dynamic-fields-php.mdx | 26 +-- .../content/_using-dynamic-fields-python.mdx | 26 +-- .../content/_what-are-indexes-csharp.mdx | 16 +- .../content/_what-are-indexes-java.mdx | 16 +- .../content/_what-are-indexes-nodejs.mdx | 16 +- .../indexes/content/_what-are-indexes-php.mdx | 16 +- .../content/_what-are-indexes-python.mdx | 16 +- docs/indexes/index-administration.mdx | 6 +- docs/indexes/index-throttling.mdx | 2 +- .../querying/content/_distinct-csharp.mdx | 6 +- .../querying/content/_distinct-java.mdx | 6 +- .../querying/content/_distinct-nodejs.mdx | 6 +- .../querying/content/_highlighting-csharp.mdx | 2 +- .../querying/content/_highlighting-nodejs.mdx | 2 +- .../querying/content/_highlighting-php.mdx | 2 +- .../querying/content/_highlighting-python.mdx | 2 +- .../content/_include-explanations-csharp.mdx | 2 +- .../content/_include-explanations-nodejs.mdx | 2 +- .../querying/content/_morelikethis-csharp.mdx | 4 +- .../querying/content/_morelikethis-java.mdx | 4 +- .../querying/content/_morelikethis-nodejs.mdx | 4 +- .../querying/content/_morelikethis-php.mdx | 4 +- .../querying/content/_morelikethis-python.mdx | 4 +- .../querying/content/_paging-csharp.mdx | 6 +- .../indexes/querying/content/_paging-java.mdx | 6 +- .../querying/content/_paging-nodejs.mdx | 6 +- docs/indexes/querying/content/_paging-php.mdx | 6 +- .../querying/content/_paging-python.mdx | 6 +- .../querying/content/_projections-csharp.mdx | 4 +- .../querying/content/_projections-java.mdx | 2 +- .../querying/content/_projections-nodejs.mdx | 4 +- .../querying/content/_projections-php.mdx | 2 +- .../querying/content/_projections-python.mdx | 2 +- .../querying/content/_query-index-csharp.mdx | 2 +- .../querying/content/_query-index-java.mdx | 8 +- .../querying/content/_query-index-nodejs.mdx | 2 +- .../querying/content/_query-index-php.mdx | 2 +- .../querying/content/_query-index-python.mdx | 2 +- .../querying/content/_searching-csharp.mdx | 24 +-- .../querying/content/_searching-java.mdx | 4 +- .../querying/content/_searching-nodejs.mdx | 24 +-- .../querying/content/_searching-php.mdx | 8 +- .../querying/content/_searching-python.mdx | 8 +- .../querying/content/_spatial-csharp.mdx | 2 +- .../querying/content/_spatial-java.mdx | 2 +- .../querying/content/_spatial-nodejs.mdx | 2 +- .../indexes/querying/content/_spatial-php.mdx | 2 +- .../querying/content/_spatial-python.mdx | 2 +- .../querying/content/_suggestions-csharp.mdx | 2 +- .../querying/content/_suggestions-nodejs.mdx | 2 +- .../querying/content/_suggestions-php.mdx | 2 +- .../querying/content/_suggestions-python.mdx | 2 +- docs/indexes/rolling-index-deployment.mdx | 4 +- docs/indexes/search-engine/corax.mdx | 16 +- .../events-and-snapshots.mdx | 4 +- .../integrating-with-akka-persistence.mdx | 6 +- .../postgresql-protocol/overview.mdx | 4 +- .../postgresql-protocol/power-bi.mdx | 8 +- docs/licensing/activate-license.mdx | 4 +- docs/licensing/faq.mdx | 4 +- docs/licensing/force-update.mdx | 6 +- docs/licensing/license-under-docker.mdx | 2 +- docs/licensing/overview.mdx | 12 +- docs/licensing/renew-license.mdx | 8 +- docs/licensing/replace-license.mdx | 6 +- .../migration/client-api/client-migration.mdx | 2 +- ...vious-versions-client-breaking-changes.mdx | 2 +- docs/migration/server/data-migration.mdx | 2 +- .../server/legacy-versions-data-migration.mdx | 2 +- ...vious-versions-server-breaking-changes.mdx | 6 +- .../server/server-breaking-changes.mdx | 2 +- docs/monitoring/task-errors/configuration.mdx | 4 +- docs/monitoring/task-errors/overview.mdx | 10 +- docs/monitoring/task-errors/studio-views.mdx | 6 +- docs/monitoring/tombstones/configuration.mdx | 2 +- docs/monitoring/tombstones/overview.mdx | 6 +- .../monitoring/tombstones/tombstones-view.mdx | 6 +- .../content/_customize-query-csharp.mdx | 12 +- .../content/_customize-query-java.mdx | 2 +- .../content/_customize-query-nodejs.mdx | 8 +- .../querying/content/_customize-query-php.mdx | 6 +- .../content/_customize-query-python.mdx | 10 +- docs/querying/content/_overview-csharp.mdx | 18 +-- docs/querying/content/_overview-nodejs.mdx | 24 +-- docs/querying/content/_overview-php.mdx | 44 ++--- docs/querying/content/_overview-python.mdx | 42 ++--- .../content/_stream-query-results-csharp.mdx | 4 +- .../content/_stream-query-results-java.mdx | 4 +- .../content/_stream-query-results-nodejs.mdx | 2 +- .../_query-vs-document-query-csharp.mdx | 10 +- .../_query-vs-document-query-nodejs.mdx | 2 +- .../content/_query-vs-document-query-php.mdx | 6 +- .../_query-vs-document-query-python.mdx | 6 +- .../_what-is-document-query-csharp.mdx | 36 ++--- .../content/_what-is-document-query-java.mdx | 12 +- .../_what-is-document-query-nodejs.mdx | 4 +- .../content/_what-is-document-query-php.mdx | 6 +- .../_what-is-document-query-python.mdx | 8 +- .../content/_filter-query-results-csharp.mdx | 4 +- .../content/_filter-query-results-java.mdx | 4 +- .../content/_filter-query-results-nodejs.mdx | 4 +- .../content/_filter-query-results-php.mdx | 4 +- .../content/_filter-query-results-python.mdx | 4 +- .../_filter-with-lucene-syntax-csharp.mdx | 4 +- .../_filter-with-lucene-syntax-java.mdx | 4 +- .../_filter-with-lucene-syntax-nodejs.mdx | 4 +- .../_filter-with-lucene-syntax-php.mdx | 4 +- .../_filter-with-lucene-syntax-python.mdx | 4 +- .../content/_use-logical-operators-csharp.mdx | 4 +- .../content/_use-logical-operators-java.mdx | 4 +- .../content/_use-logical-operators-nodejs.mdx | 4 +- .../content/_use-logical-operators-php.mdx | 4 +- .../content/_use-logical-operators-python.mdx | 4 +- docs/querying/rql/rql-code-assistance.mdx | 8 +- docs/querying/rql/what-is-rql.mdx | 42 ++--- .../content/_sort-query-results-csharp.mdx | 4 +- .../content/_sort-query-results-java.mdx | 4 +- .../content/_sort-query-results-nodejs.mdx | 4 +- .../content/_sort-query-results-php.mdx | 4 +- .../content/_sort-query-results-python.mdx | 4 +- .../_database-level-custom-sorters-csharp.mdx | 6 +- .../_database-level-custom-sorters-nodejs.mdx | 6 +- .../content/_overview-csharp.mdx | 8 +- .../content/_overview-nodejs.mdx | 8 +- .../_server-wide-custom-sorters-csharp.mdx | 8 +- .../_server-wide-custom-sorters-nodejs.mdx | 8 +- docs/server/administration/cli.mdx | 2 +- .../monitoring/open-telemetry.mdx | 46 +++--- .../administration/snmp/snmp-overview.mdx | 28 ++-- docs/server/clustering/cluster-api.mdx | 2 +- ...luster-best-practice-and-configuration.mdx | 4 +- .../clustering/cluster-transactions.mdx | 18 +-- .../distribution/cluster-observer.mdx | 16 +- .../distribution/distributed-database.mdx | 14 +- .../distribution/highly-available-tasks.mdx | 20 +-- docs/server/clustering/overview.mdx | 14 +- .../clustering/rachis/cluster-topology.mdx | 10 +- .../rachis/consensus-operations.mdx | 6 +- .../clustering/rachis/what-is-rachis.mdx | 6 +- .../replication/advanced-replication.mdx | 4 +- .../replication-and-embedded-instance.mdx | 10 +- .../replication/replication-conflicts.mdx | 8 +- .../replication/replication-overview.mdx | 10 +- .../configuration/configuration-options.mdx | 6 +- .../configuration/core-configuration.mdx | 6 +- .../configuration/database-configuration.mdx | 4 +- .../configuration/etl-configuration.mdx | 2 +- .../configuration/indexing-configuration.mdx | 10 +- .../configuration/logs-configuration.mdx | 6 +- .../configuration/memory-configuration.mdx | 2 +- .../queue-sink-configuration.mdx | 4 +- .../configuration/security-configuration.mdx | 6 +- .../configuration/server-configuration.mdx | 2 +- .../configuration/storage-configuration.mdx | 8 +- docs/server/content/_embedded-csharp.mdx | 4 +- docs/server/content/_embedded-java.mdx | 2 +- .../extensions/content/_refresh-csharp.mdx | 8 +- docs/server/kb/javascript-engine.mdx | 12 +- docs/server/kb/linux-thread-names.mdx | 2 +- docs/server/ongoing-tasks/etl/basics.mdx | 36 ++--- .../ongoing-tasks/etl/elasticsearch.mdx | 12 +- docs/server/ongoing-tasks/etl/olap.mdx | 4 +- .../etl/queue-etl/amazon-sqs.mdx | 6 +- .../etl/queue-etl/azure-queue.mdx | 8 +- .../ongoing-tasks/etl/queue-etl/kafka.mdx | 6 +- .../ongoing-tasks/etl/queue-etl/overview.mdx | 14 +- .../ongoing-tasks/etl/queue-etl/rabbit-mq.mdx | 6 +- docs/server/ongoing-tasks/etl/raven.mdx | 10 +- docs/server/ongoing-tasks/etl/snowflake.mdx | 2 +- docs/server/ongoing-tasks/etl/sql.mdx | 6 +- .../server/ongoing-tasks/etl/test-scripts.mdx | 2 +- .../ongoing-tasks/external-replication.mdx | 12 +- .../ongoing-tasks/hub-sink-replication.mdx | 6 +- .../azure-service-bus-queue-sink.mdx | 8 +- .../queue-sink/kafka-queue-sink.mdx | 12 +- .../ongoing-tasks/queue-sink/overview.mdx | 8 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 10 +- .../security/audit-log/audit-log-overview.mdx | 16 +- .../certificate-configuration.mdx | 16 +- .../authentication/certificate-management.mdx | 56 +++---- .../certificate-renewal-and-rotation.mdx | 4 +- .../client-certificate-usage.mdx | 2 +- .../lets-encrypt-certificates.mdx | 10 +- .../recover-from-expired-certificate.mdx | 12 +- ...olve-cluster-certificate-renewal-issue.mdx | 2 +- .../security-clearance-and-permissions.mdx | 2 +- .../server/security/common-errors-and-faq.mdx | 22 +-- .../encryption/database-encryption.mdx | 4 +- .../encryption/encryption-at-rest.mdx | 8 +- .../encryption/secret-key-management.mdx | 2 +- .../encryption/server-store-encryption.mdx | 8 +- docs/server/security/overview.mdx | 24 +-- .../content/_documents-compression-csharp.mdx | 2 +- .../content/_documents-compression-nodejs.mdx | 2 +- ...customizing-raven-data-files-locations.mdx | 20 +-- docs/server/storage/directory-structure.mdx | 2 +- docs/server/tcp-compression.mdx | 8 +- docs/server/troubleshooting/collect-info.mdx | 14 +- docs/server/troubleshooting/logging.mdx | 36 ++--- docs/server/troubleshooting/traffic-watch.mdx | 18 +-- .../administration/anchoring-documents.mdx | 4 +- docs/sharding/administration/api-admin.mdx | 2 +- .../administration/sharding-by-prefix.mdx | 10 +- docs/sharding/administration/studio-admin.mdx | 10 +- docs/sharding/backup-and-restore/backup.mdx | 12 +- docs/sharding/backup-and-restore/restore.mdx | 6 +- docs/sharding/document-extensions.mdx | 4 +- docs/sharding/etl.mdx | 10 +- docs/sharding/external-replication.mdx | 8 +- docs/sharding/import-and-export.mdx | 6 +- docs/sharding/indexing.mdx | 8 +- docs/sharding/migration.mdx | 24 +-- docs/sharding/overview.mdx | 22 +-- docs/sharding/querying.mdx | 12 +- docs/sharding/resharding.mdx | 14 +- docs/sharding/subscriptions.mdx | 4 +- docs/sharding/unsupported.mdx | 16 +- docs/start/getting-started.mdx | 12 +- docs/start/guides/aws-lambda/deployment.mdx | 2 +- .../guides/aws-lambda/existing-project.mdx | 6 +- .../content/_existing-project-csharp.mdx | 2 +- .../content/_existing-project-nodejs.mdx | 2 +- .../deployment-considerations.mdx | 2 +- docs/start/installation/gnu-linux/deb.mdx | 2 +- docs/start/installation/manual.mdx | 2 +- .../start/installation/running-as-service.mdx | 6 +- .../setup-examples/aws-linux-vm.mdx | 8 +- .../setup-examples/aws-windows-vm.mdx | 8 +- .../setup-wizard/additional-settings.mdx | 14 +- .../setup-wizard/choose-security-option.mdx | 18 +-- .../setup-wizard/choose-setup-method.mdx | 62 ++++---- .../setup-wizard/configure-node-addresses.mdx | 18 +-- .../setup-wizard/finish-setup.mdx | 16 +- .../installation/setup-wizard/overview.mdx | 6 +- .../setup-wizard/provide-license-key.mdx | 8 +- .../setup-wizard/review-setup.mdx | 6 +- .../setup-wizard/use-setup-package.mdx | 8 +- .../installation/system-requirements.mdx | 4 +- docs/studio/ai-assistant.mdx | 2 +- .../cluster-dashboard-overview.mdx | 4 +- .../cluster-dashboard-widgets.mdx | 6 +- docs/studio/cluster/cluster-view.mdx | 12 +- docs/studio/cluster/setting-a-cluster.mdx | 2 +- docs/studio/configuration.mdx | 4 +- .../create-new-database/from-legacy-files.mdx | 4 +- .../create-new-database/general-flow.mdx | 4 +- docs/studio/database/databases-list-view.mdx | 6 +- .../revisions/all-revisions.mdx | 14 +- .../revisions/revisions-bin.mdx | 10 +- .../revisions/revisions-overview.mdx | 8 +- .../document-extensions/time-series.mdx | 6 +- .../database/documents/conflicts-view.mdx | 2 +- .../documents/create-new-document.mdx | 2 +- .../database/documents/document-view.mdx | 6 +- .../documents/documents-and-collections.mdx | 6 +- docs/studio/database/documents/patch-view.mdx | 2 +- .../database/indexes/create-map-index.mdx | 4 +- .../indexes/create-map-reduce-index.mdx | 6 +- .../indexes/create-multi-map-index.mdx | 10 +- .../studio/database/indexes/index-history.mdx | 4 +- .../database/indexes/indexes-list-view.mdx | 8 +- .../database/indexes/indexes-overview.mdx | 18 +-- .../database/indexes/indexing-performance.mdx | 14 +- docs/studio/database/queries/query-view.mdx | 12 +- .../client-configuration-per-database.mdx | 4 +- .../database/settings/conflict-resolution.mdx | 2 +- .../database/settings/custom-analyzers.mdx | 2 +- .../database/settings/database-record.mdx | 24 +-- .../database/settings/database-settings.mdx | 4 +- .../database/settings/document-revisions.mdx | 2 +- .../settings/documents-compression.mdx | 2 +- .../settings/manage-database-group.mdx | 12 +- .../settings/studio-configuration.mdx | 14 +- .../external-replication-stats.mdx | 2 +- .../ongoing-tasks-stats/olap-etl-stats.mdx | 2 +- .../ongoing-tasks-stats/ravendb-etl-stats.mdx | 2 +- .../subscription-stats.mdx | 6 +- docs/studio/database/stats/storage-report.mdx | 2 +- .../database/tasks/create-sample-data.mdx | 14 +- .../studio/database/tasks/export-database.mdx | 6 +- .../tasks/import-data/import-data-file.mdx | 20 +-- .../tasks/import-data/import-from-other.mdx | 2 +- .../tasks/import-data/import-from-ravendb.mdx | 14 +- .../tasks/ongoing-tasks/amazon-sqs-etl.mdx | 4 +- .../ongoing-tasks/azure-queue-storage-etl.mdx | 4 +- .../azure-service-bus-queue-sink.mdx | 4 +- .../ongoing-tasks/elasticsearch-etl-task.mdx | 4 +- .../external-replication-task.mdx | 12 +- .../tasks/ongoing-tasks/general-info.mdx | 30 ++-- .../hub-sink-replication/overview.mdx | 4 +- .../replication-hub-task.mdx | 4 +- .../replication-sink-task.mdx | 4 +- .../tasks/ongoing-tasks/kafka-etl-task.mdx | 4 +- .../tasks/ongoing-tasks/kafka-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/rabbitmq-etl-task.mdx | 4 +- .../ongoing-tasks/rabbitmq-queue-sink.mdx | 6 +- .../tasks/ongoing-tasks/ravendb-etl-task.mdx | 10 +- .../ongoing-tasks/snowflake-etl-task.mdx | 4 +- docs/studio/overview.mdx | 32 ++-- .../certificates/read-only-access-level.mdx | 4 +- docs/studio/server/client-configuration.mdx | 2 +- .../debug/advanced/cluster-observer.mdx | 8 +- docs/studio/server/manage-server.mdx | 20 +-- docs/studio/server/server-settings.mdx | 2 +- ...work-with-bulk-insert-operation-csharp.mdx | 4 +- ...-subscribe-to-operation-changes-csharp.mdx | 4 +- .../content/_what-is-changes-api-csharp.mdx | 36 ++--- .../content/_what-is-changes-api-java.mdx | 22 +-- .../content/_what-is-changes-api-nodejs.mdx | 22 +-- ...es-with-replication-and-cluster-csharp.mdx | 4 +- ...ates-with-replication-and-cluster-java.mdx | 2 +- ...es-with-replication-and-cluster-nodejs.mdx | 2 +- .../client-api/cluster/speed-test.mdx | 2 +- ...multiple-commands-using-a-batch-csharp.mdx | 6 +- ...multiple-commands-using-a-batch-nodejs.mdx | 6 +- .../commands/content/_overview-csharp.mdx | 20 +-- .../commands/content/_overview-java.mdx | 12 +- .../commands/content/_overview-nodejs.mdx | 20 +-- .../documents/content/_delete-csharp.mdx | 2 +- .../documents/content/_delete-nodejs.mdx | 2 +- .../documents/content/_get-csharp.mdx | 2 +- .../documents/content/_get-nodejs.mdx | 2 +- .../documents/content/_put-csharp.mdx | 4 +- .../documents/content/_put-nodejs.mdx | 4 +- .../content/_conventions-csharp.mdx | 34 ++-- .../content/_conventions-nodejs.mdx | 18 +-- .../content/_deserialization-csharp.mdx | Bin 3313 -> 3268 bytes .../content/_serialization-csharp.mdx | 6 +- .../content/_global-csharp.mdx | 2 +- .../content/_global-java.mdx | 2 +- .../content/_global-nodejs.mdx | 2 +- .../content/_type-specific-csharp.mdx | 2 +- .../content/_type-specific-java.mdx | 2 +- .../content/_type-specific-nodejs.mdx | 2 +- .../content/_load-balance-behavior-csharp.mdx | 16 +- .../content/_load-balance-behavior-nodejs.mdx | 16 +- .../content/_load-balance-behavior-php.mdx | 16 +- .../content/_load-balance-behavior-python.mdx | 16 +- .../content/_read-balance-behavior-csharp.mdx | 14 +- .../content/_read-balance-behavior-nodejs.mdx | 14 +- .../content/_read-balance-behavior-php.mdx | 14 +- .../content/_read-balance-behavior-python.mdx | 14 +- .../configuration/load-balance/overview.mdx | 20 +-- .../_creating-document-store-csharp.mdx | 10 +- .../_setting-up-default-database-java.mdx | 2 +- .../_setting-up-default-database-nodejs.mdx | 2 +- .../_what-is-a-document-store-csharp.mdx | 18 +-- .../_what-is-a-document-store-java.mdx | 14 +- .../_what-is-a-document-store-nodejs.mdx | 12 +- .../_maintenance-operations-csharp.mdx | 4 +- .../_maintenance-operations-nodejs.mdx | 4 +- .../content/_api-overview-csharp.mdx | 4 +- .../content/_api-overview-java.mdx | 2 +- .../content/_api-overview-nodejs.mdx | 6 +- .../content/_api-overview-python.mdx | 6 +- ...ow-to-consume-data-subscription-csharp.mdx | 8 +- ..._how-to-consume-data-subscription-java.mdx | 4 +- ...ow-to-consume-data-subscription-nodejs.mdx | 8 +- ...ow-to-consume-data-subscription-python.mdx | 6 +- .../_concurrent-subscriptions-csharp.mdx | 8 +- .../_concurrent-subscriptions-nodejs.mdx | 8 +- .../_what-are-data-subscriptions-csharp.mdx | 14 +- .../_what-are-data-subscriptions-java.mdx | 8 +- .../_what-are-data-subscriptions-nodejs.mdx | 8 +- .../creation/content/_api-overview-csharp.mdx | 4 +- .../creation/content/_api-overview-nodejs.mdx | 12 +- .../creation/content/_api-overview-python.mdx | 2 +- .../creation/content/_examples-csharp.mdx | 10 +- .../creation/content/_examples-nodejs.mdx | 10 +- .../creation/content/_examples-python.mdx | 8 +- ...how-to-create-data-subscription-csharp.mdx | 6 +- .../_how-to-create-data-subscription-java.mdx | 4 +- ...how-to-create-data-subscription-nodejs.mdx | 6 +- ...how-to-create-data-subscription-python.mdx | 6 +- .../content/_hilo-algorithm-csharp.mdx | 12 +- ...rking-with-document-identifiers-csharp.mdx | 14 +- .../client-api/faq/transaction-support.mdx | 30 ++-- .../client-api/faq/what-is-a-collection.mdx | 4 +- .../_handle-document-relationships-csharp.mdx | 4 +- .../_handle-document-relationships-java.mdx | 2 +- .../_handle-document-relationships-nodejs.mdx | 4 +- .../_setup-aggressive-caching-csharp.mdx | 12 +- .../_setup-aggressive-caching-java.mdx | 12 +- .../how-to/integrate-with-excel.mdx | 2 +- .../how-to/subscribe-to-store-events.mdx | 20 +-- .../content/_delete-by-query-csharp.mdx | 8 +- .../content/_delete-by-query-nodejs.mdx | 8 +- .../common/content/_delete-by-query-php.mdx | 8 +- .../content/_delete-by-query-python.mdx | 6 +- .../_compare-exchange-expiration-csharp.mdx | 2 +- .../_compare-exchange-metadata-csharp.mdx | 6 +- .../_delete-compare-exchange-value-csharp.mdx | 4 +- .../_delete-compare-exchange-value-java.mdx | 4 +- .../_delete-compare-exchange-value-nodejs.mdx | 2 +- .../_get-compare-exchange-value-csharp.mdx | 6 +- .../_get-compare-exchange-value-java.mdx | 2 +- .../_get-compare-exchange-value-nodejs.mdx | 2 +- .../_get-compare-exchange-values-csharp.mdx | 6 +- .../_get-compare-exchange-values-java.mdx | 2 +- .../_get-compare-exchange-values-nodejs.mdx | 2 +- .../_include-compare-exchange-csharp.mdx | 12 +- .../_include-compare-exchange-nodejs.mdx | 10 +- .../content/_overview-csharp.mdx | 16 +- .../content/_overview-java.mdx | 10 +- .../content/_overview-php.mdx | 16 +- .../content/_overview-python.mdx | 16 +- .../_put-compare-exchange-value-csharp.mdx | 2 +- .../_put-compare-exchange-value-java.mdx | 2 +- .../_put-compare-exchange-value-nodejs.mdx | 4 +- .../content/_what-are-operations-csharp.mdx | 150 +++++++++--------- .../content/_what-are-operations-java.mdx | 74 ++++----- .../content/_what-are-operations-nodejs.mdx | 142 ++++++++--------- .../content/_what-are-operations-php.mdx | 150 +++++++++--------- .../content/_what-are-operations-python.mdx | 150 +++++++++--------- ...rations-to-a-different-database-csharp.mdx | 6 +- ...rations-to-a-different-database-nodejs.mdx | 6 +- ...operations-to-a-different-database-php.mdx | 6 +- ...rations-to-a-different-database-python.mdx | 6 +- ...-operations-to-a-different-node-csharp.mdx | 4 +- ...-operations-to-a-different-node-nodejs.mdx | 4 +- ...tch-operations-to-a-different-node-php.mdx | 4 +- .../maintenance/backup/backup-overview.mdx | 2 +- .../maintenance/backup/encrypted-backup.mdx | 8 +- .../operations/maintenance/backup/faq.mdx | 8 +- .../operations/maintenance/backup/restore.mdx | 8 +- .../_database-settings-operation-csharp.mdx | 2 +- .../_database-settings-operation-nodejs.mdx | 2 +- .../_database-settings-operation-php.mdx | 2 +- .../_get-client-configuration-csharp.mdx | 2 +- .../_get-client-configuration-nodejs.mdx | 2 +- .../content/_get-client-configuration-php.mdx | 2 +- .../_get-client-configuration-python.mdx | 2 +- .../_put-client-configuration-csharp.mdx | 10 +- .../_put-client-configuration-nodejs.mdx | 10 +- .../content/_put-client-configuration-php.mdx | 10 +- .../_put-client-configuration-python.mdx | 10 +- .../content/_get-connection-string-csharp.mdx | 4 +- .../maintenance/content/_get-stats-csharp.mdx | 2 +- .../maintenance/content/_get-stats-java.mdx | 2 +- .../maintenance/content/_get-stats-nodejs.mdx | 2 +- .../maintenance/content/_get-stats-php.mdx | 2 +- .../maintenance/content/_get-stats-python.mdx | 2 +- .../etl/content/_add-etl-csharp.mdx | 8 +- .../content/_get-identities-csharp.mdx | 2 +- .../content/_get-identities-php.mdx | 2 +- .../content/_get-identities-python.mdx | 2 +- .../content/_delete-index-errors-csharp.mdx | 4 +- .../content/_delete-index-errors-nodejs.mdx | 4 +- .../content/_delete-index-errors-php.mdx | 4 +- .../content/_delete-index-errors-python.mdx | 4 +- .../indexes/content/_disable-index-csharp.mdx | 12 +- .../indexes/content/_disable-index-java.mdx | 2 +- .../indexes/content/_disable-index-nodejs.mdx | 12 +- .../indexes/content/_disable-index-php.mdx | 12 +- .../indexes/content/_disable-index-python.mdx | 12 +- .../indexes/content/_enable-index-csharp.mdx | 8 +- .../indexes/content/_enable-index-nodejs.mdx | 8 +- .../indexes/content/_enable-index-php.mdx | 8 +- .../indexes/content/_enable-index-python.mdx | 8 +- .../indexes/content/_get-index-csharp.mdx | 4 +- .../content/_get-index-errors-csharp.mdx | 4 +- .../content/_get-index-errors-nodejs.mdx | 4 +- .../indexes/content/_get-index-errors-php.mdx | 4 +- .../content/_get-index-errors-python.mdx | 4 +- .../indexes/content/_get-index-nodejs.mdx | 4 +- .../indexes/content/_get-index-php.mdx | 2 +- .../indexes/content/_get-index-python.mdx | 4 +- .../indexes/content/_get-indexes-csharp.mdx | 4 +- .../indexes/content/_get-indexes-nodejs.mdx | 4 +- .../indexes/content/_get-indexes-php.mdx | 2 +- .../indexes/content/_get-indexes-python.mdx | 4 +- .../content/_index-has-changed-csharp.mdx | 2 +- .../content/_index-has-changed-nodejs.mdx | 2 +- .../content/_index-has-changed-php.mdx | 2 +- .../content/_index-has-changed-python.mdx | 2 +- .../indexes/content/_put-indexes-csharp.mdx | 2 +- .../indexes/content/_put-indexes-nodejs.mdx | 2 +- .../indexes/content/_put-indexes-php.mdx | 2 +- .../indexes/content/_put-indexes-python.mdx | 2 +- .../indexes/content/_reset-index-csharp.mdx | 8 +- .../indexes/content/_reset-index-nodejs.mdx | 8 +- .../indexes/content/_reset-index-php.mdx | 4 +- .../indexes/content/_reset-index-python.mdx | 8 +- .../content/_set-index-lock-csharp.mdx | 2 +- .../content/_set-index-lock-nodejs.mdx | 2 +- .../indexes/content/_set-index-lock-php.mdx | 2 +- .../content/_set-index-lock-python.mdx | 2 +- .../indexes/content/_start-index-csharp.mdx | 2 +- .../indexes/content/_start-index-nodejs.mdx | 2 +- .../indexes/content/_start-index-php.mdx | 2 +- .../indexes/content/_start-index-python.mdx | 2 +- .../content/_start-indexing-csharp.mdx | 4 +- .../content/_start-indexing-nodejs.mdx | 4 +- .../indexes/content/_start-indexing-php.mdx | 4 +- .../content/_start-indexing-python.mdx | 4 +- .../indexes/content/_stop-index-csharp.mdx | 10 +- .../indexes/content/_stop-index-nodejs.mdx | 10 +- .../indexes/content/_stop-index-php.mdx | 10 +- .../indexes/content/_stop-index-python.mdx | 10 +- .../indexes/content/_stop-indexing-csharp.mdx | 10 +- .../indexes/content/_stop-indexing-java.mdx | 4 +- .../indexes/content/_stop-indexing-nodejs.mdx | 10 +- .../indexes/content/_stop-indexing-php.mdx | 10 +- .../indexes/content/_stop-indexing-python.mdx | 10 +- .../_ongoing-task-operations-csharp.mdx | 2 +- .../sorters/content/_put-sorter-csharp.mdx | 6 +- .../sorters/content/_put-sorter-nodejs.mdx | 6 +- .../patching/content/_set-based-nodejs.mdx | 6 +- .../content/_single-document-csharp.mdx | 2 +- .../content/_single-document-nodejs.mdx | 12 +- .../operations/patching/json-patch-syntax.mdx | 2 +- ...serverwide-client-configuration-csharp.mdx | 6 +- ...serverwide-client-configuration-nodejs.mdx | 6 +- ...serverwide-client-configuration-csharp.mdx | 6 +- ...serverwide-client-configuration-nodejs.mdx | 6 +- .../content/_compact-database-csharp.mdx | 8 +- .../content/_compact-database-nodejs.mdx | 8 +- .../content/_compact-database-php.mdx | 6 +- .../content/_compact-database-python.mdx | 4 +- .../content/_create-database-csharp.mdx | 12 +- .../content/_create-database-java.mdx | 12 +- .../_put-sorter-server-wide-csharp.mdx | 6 +- .../_put-sorter-server-wide-nodejs.mdx | 6 +- .../document-commands/batch-commands.mdx | 8 +- .../document-commands/get-documents-by-id.mdx | 4 +- .../document-commands/put-documents.mdx | 2 +- .../rest-api/queries/delete-by-query.mdx | 2 +- .../rest-api/queries/patch-by-query.mdx | 4 +- .../rest-api/queries/query-the-database.mdx | 14 +- .../client-api/rest-api/rest-api-intro.mdx | 4 +- .../content/_atomic-guards-csharp.mdx | 16 +- .../content/_atomic-guards-nodejs.mdx | 16 +- .../content/_atomic-guards-php.mdx | 16 +- .../content/_atomic-guards-python.mdx | 16 +- .../content/_compare-exchange-csharp.mdx | 4 +- .../content/_compare-exchange-nodejs.mdx | 4 +- .../content/_compare-exchange-php.mdx | 4 +- .../content/_compare-exchange-python.mdx | 4 +- .../content/_overview-csharp.mdx | 6 +- .../content/_overview-nodejs.mdx | 6 +- .../content/_overview-php.mdx | 6 +- .../content/_overview-python.mdx | 6 +- .../_how-to-disable-caching-csharp.mdx | 2 +- .../content/_how-to-disable-caching-java.mdx | 2 +- .../_how-to-disable-caching-nodejs.mdx | 2 +- .../content/_how-to-disable-caching-php.mdx | 2 +- ...o-enable-optimistic-concurrency-csharp.mdx | 10 +- ...-to-enable-optimistic-concurrency-java.mdx | 6 +- ...o-enable-optimistic-concurrency-nodejs.mdx | 10 +- ...w-to-enable-optimistic-concurrency-php.mdx | 8 +- ...o-enable-optimistic-concurrency-python.mdx | 10 +- ...o-customize-id-generation-for-entities.mdx | 6 +- .../content/_deleting-entities-csharp.mdx | 2 +- .../content/_deleting-entities-java.mdx | 2 +- .../content/_deleting-entities-nodejs.mdx | 2 +- .../content/_deleting-entities-php.mdx | 2 +- .../content/_deleting-entities-python.mdx | 2 +- .../content/_loading-entities-csharp.mdx | 10 +- .../content/_loading-entities-java.mdx | 2 +- .../content/_loading-entities-nodejs.mdx | 2 +- .../session/content/_loading-entities-php.mdx | 6 +- .../content/_loading-entities-python.mdx | 12 +- .../content/_opening-a-session-csharp.mdx | 12 +- .../content/_opening-a-session-java.mdx | 6 +- .../content/_opening-a-session-nodejs.mdx | 12 +- .../content/_opening-a-session-php.mdx | 12 +- .../content/_opening-a-session-python.mdx | 12 +- .../content/_saving-changes-csharp.mdx | 6 +- .../session/content/_saving-changes-java.mdx | 6 +- .../content/_saving-changes-nodejs.mdx | 4 +- .../session/content/_saving-changes-php.mdx | 4 +- .../content/_saving-changes-python.mdx | 6 +- .../content/_updating-entities-csharp.mdx | 2 +- .../content/_updating-entities-nodejs.mdx | 2 +- .../content/_updating-entities-php.mdx | 4 +- .../content/_updating-entities-python.mdx | 2 +- ...-a-session-and-how-does-it-work-csharp.mdx | 42 ++--- ...is-a-session-and-how-does-it-work-java.mdx | 40 ++--- ...-a-session-and-how-does-it-work-nodejs.mdx | 42 ++--- ...-is-a-session-and-how-does-it-work-php.mdx | 40 ++--- ...-a-session-and-how-does-it-work-python.mdx | 40 ++--- .../_check-if-attachment-exists-csharp.mdx | 2 +- .../_check-if-attachment-exists-java.mdx | 2 +- .../_check-if-attachment-exists-nodejs.mdx | 2 +- .../_check-if-attachment-exists-php.mdx | 2 +- .../_check-if-attachment-exists-python.mdx | 2 +- .../_check-if-document-exists-csharp.mdx | 2 +- .../_check-if-document-exists-java.mdx | 2 +- .../_check-if-document-exists-nodejs.mdx | 2 +- .../content/_check-if-document-exists-php.mdx | 2 +- .../_check-if-document-exists-python.mdx | 2 +- .../_check-if-entity-has-changed-csharp.mdx | 6 +- .../_check-if-entity-has-changed-nodejs.mdx | 6 +- .../_check-if-entity-has-changed-php.mdx | 4 +- .../_check-if-entity-has-changed-python.mdx | 4 +- ...re-are-any-changes-on-a-session-csharp.mdx | 6 +- ...here-are-any-changes-on-a-session-java.mdx | 2 +- ...re-are-any-changes-on-a-session-nodejs.mdx | 6 +- ...there-are-any-changes-on-a-session-php.mdx | 4 +- ...re-are-any-changes-on-a-session-python.mdx | 4 +- .../content/_clear-a-session-csharp.mdx | 2 +- .../content/_clear-a-session-nodejs.mdx | 2 +- .../_evict-entity-from-a-session-csharp.mdx | 10 +- .../_evict-entity-from-a-session-java.mdx | 2 +- .../_evict-entity-from-a-session-nodejs.mdx | 10 +- .../_evict-entity-from-a-session-php.mdx | 2 +- .../_evict-entity-from-a-session-python.mdx | 2 +- .../_get-current-session-node-csharp.mdx | 4 +- .../_get-current-session-node-java.mdx | 4 +- .../_get-current-session-node-nodejs.mdx | 4 +- .../content/_get-current-session-node-php.mdx | 4 +- .../content/_get-tracked-entities-csharp.mdx | 6 +- .../content/_get-tracked-entities-nodejs.mdx | 6 +- .../content/_ignore-entity-changes-csharp.mdx | 8 +- .../content/_ignore-entity-changes-nodejs.mdx | 8 +- .../content/_ignore-entity-changes-php.mdx | 8 +- .../content/_ignore-entity-changes-python.mdx | 2 +- .../_perform-operations-lazily-csharp.mdx | 12 +- .../_perform-operations-lazily-nodejs.mdx | 12 +- .../_perform-operations-lazily-php.mdx | 12 +- .../_perform-operations-lazily-python.mdx | 12 +- .../content/_subscribe-to-events-csharp.mdx | 2 +- .../content/_subscribe-to-events-java.mdx | 2 +- .../content/_subscribe-to-events-nodejs.mdx | 2 +- .../_how-to-count-query-results-csharp.mdx | 2 +- .../_how-to-count-query-results-nodejs.mdx | 2 +- .../_how-to-count-query-results-php.mdx | 2 +- .../_how-to-count-query-results-python.mdx | 2 +- .../_how-to-customize-query-csharp.mdx | 24 +-- .../content/_how-to-customize-query-java.mdx | 2 +- .../_how-to-customize-query-nodejs.mdx | 18 +-- .../content/_how-to-customize-query-php.mdx | 16 +- .../_how-to-customize-query-python.mdx | 22 +-- .../_how-to-filter-by-field-csharp.mdx | 2 +- .../content/_how-to-filter-by-field-java.mdx | 2 +- .../_how-to-filter-by-field-python.mdx | 2 +- ...to-filter-by-non-existing-field-csharp.mdx | 6 +- ...to-filter-by-non-existing-field-nodejs.mdx | 6 +- ...ow-to-filter-by-non-existing-field-php.mdx | 6 +- ...to-filter-by-non-existing-field-python.mdx | 6 +- .../_how-to-get-query-statistics-csharp.mdx | 2 +- .../_how-to-get-query-statistics-php.mdx | 2 +- .../_how-to-get-query-statistics-python.mdx | 2 +- .../_how-to-perform-queries-lazily-csharp.mdx | 8 +- .../_how-to-perform-queries-lazily-nodejs.mdx | 8 +- .../_how-to-perform-queries-lazily-php.mdx | 6 +- .../_how-to-perform-queries-lazily-python.mdx | 12 +- .../_how-to-project-query-results-csharp.mdx | 4 +- .../_how-to-project-query-results-nodejs.mdx | 2 +- .../_how-to-project-query-results-php.mdx | 2 +- .../_how-to-project-query-results-python.mdx | 2 +- .../querying/content/_how-to-query-csharp.mdx | 60 +++---- .../querying/content/_how-to-query-nodejs.mdx | 66 ++++---- .../querying/content/_how-to-query-php.mdx | 54 +++---- .../querying/content/_how-to-query-python.mdx | 56 +++---- .../_how-to-stream-query-results-csharp.mdx | 8 +- .../_how-to-stream-query-results-java.mdx | 6 +- .../_how-to-stream-query-results-nodejs.mdx | 6 +- .../_how-to-work-with-suggestions-csharp.mdx | 2 +- .../_how-to-work-with-suggestions-nodejs.mdx | 2 +- .../_how-to-work-with-suggestions-php.mdx | 2 +- .../_how-to-work-with-suggestions-python.mdx | 2 +- .../content/_sort-query-results-csharp.mdx | 10 +- .../content/_sort-query-results-nodejs.mdx | 10 +- .../content/_sort-query-results-php.mdx | 10 +- .../content/_sort-query-results-python.mdx | 10 +- .../content/_include-explanations-csharp.mdx | 4 +- .../content/_include-explanations-nodejs.mdx | 2 +- .../content/_include-explanations-php.mdx | 2 +- .../content/_include-explanations-python.mdx | 2 +- .../_query-vs-document-query-csharp.mdx | 10 +- .../_query-vs-document-query-nodejs.mdx | 2 +- .../content/_query-vs-document-query-php.mdx | 8 +- .../_query-vs-document-query-python.mdx | 8 +- .../_what-is-document-query-csharp.mdx | 78 ++++----- .../content/_what-is-document-query-java.mdx | 36 ++--- .../_what-is-document-query-nodejs.mdx | 4 +- .../content/_what-is-document-query-php.mdx | 80 +++++----- .../_what-is-document-query-python.mdx | 74 ++++----- .../content/_boost-search-results-csharp.mdx | 2 +- .../content/_boost-search-results-nodejs.mdx | 2 +- .../content/_boost-search-results-php.mdx | 2 +- .../content/_boost-search-results-python.mdx | 2 +- .../content/_ends-with-query-csharp.mdx | 2 +- .../content/_ends-with-query-nodejs.mdx | 2 +- .../content/_ends-with-query-php.mdx | 2 +- .../content/_ends-with-query-python.mdx | 2 +- .../content/_full-text-search-csharp.mdx | 6 +- .../content/_full-text-search-nodejs.mdx | 4 +- .../content/_full-text-search-php.mdx | 4 +- .../content/_full-text-search-python.mdx | 4 +- .../content/_fuzzy-search-csharp.mdx | 2 +- .../content/_fuzzy-search-java.mdx | 2 +- .../_highlight-query-results-csharp.mdx | 4 +- .../_highlight-query-results-nodejs.mdx | 4 +- .../content/_highlight-query-results-php.mdx | 4 +- .../_highlight-query-results-python.mdx | 4 +- .../content/_proximity-search-csharp.mdx | 4 +- .../content/_proximity-search-java.mdx | 2 +- .../content/_proximity-search-nodejs.mdx | 2 +- .../content/_proximity-search-php.mdx | 2 +- .../content/_proximity-search-python.mdx | 2 +- .../session/querying/what-is-rql.mdx | 44 ++--- .../content/_what-is-smuggler-csharp.mdx | 2 +- .../content/_what-is-smuggler-java.mdx | 2 +- .../content/_what-is-smuggler-nodejs.mdx | 2 +- ...ed-documents-and-other-features-csharp.mdx | 8 +- .../content/_enable-data-archiving-csharp.mdx | 2 +- .../_schedule-document-archiving-csharp.mdx | 4 +- .../content/_unarchiving-documents-csharp.mdx | 2 +- .../version-6.2/data-archival/overview.mdx | 16 +- .../_counters-and-other-features-csharp.mdx | 6 +- .../_counters-and-other-features-java.mdx | 2 +- .../_counters-and-other-features-nodejs.mdx | 6 +- .../_counters-and-other-features-php.mdx | 4 +- .../_counters-and-other-features-python.mdx | 6 +- .../content/_create-or-modify-csharp.mdx | 2 +- .../content/_create-or-modify-java.mdx | 2 +- .../content/_create-or-modify-nodejs.mdx | 2 +- .../content/_create-or-modify-php.mdx | 2 +- .../content/_create-or-modify-python.mdx | 2 +- .../counters/content/_delete-csharp.mdx | 2 +- .../counters/content/_delete-java.mdx | 2 +- .../counters/content/_delete-nodejs.mdx | 2 +- .../counters/content/_delete-php.mdx | 4 +- .../counters/content/_delete-python.mdx | 4 +- .../counters/content/_overview-csharp.mdx | 10 +- .../counters/content/_overview-java.mdx | 10 +- .../counters/content/_overview-nodejs.mdx | 10 +- .../counters/content/_overview-php.mdx | 10 +- .../counters/content/_overview-python.mdx | 10 +- .../_retrieve-counter-values-csharp.mdx | 2 +- .../content/_retrieve-counter-values-java.mdx | 2 +- .../_retrieve-counter-values-nodejs.mdx | 2 +- .../content/_retrieve-counter-values-php.mdx | 2 +- .../_retrieve-counter-values-python.mdx | 2 +- .../counters/counters-in-clusters.mdx | 8 +- .../overview-extensions.mdx | 8 +- .../client-api/content/_overview-csharp.mdx | 22 +-- .../client-api/content/_overview-java.mdx | 32 ++-- .../client-api/content/_overview-nodejs.mdx | 22 +-- .../client-api/content/_overview-php.mdx | 16 +- .../client-api/content/_overview-python.mdx | 16 +- .../content/_configure-revisions-csharp.mdx | 4 +- .../content/_configure-revisions-java.mdx | 2 +- .../content/_configure-revisions-nodejs.mdx | 4 +- .../content/_configure-revisions-php.mdx | 4 +- .../content/_configure-revisions-python.mdx | 4 +- ...onflict-revisions-configuration-csharp.mdx | 4 +- ...onflict-revisions-configuration-nodejs.mdx | 4 +- .../_conflict-revisions-configuration-php.mdx | 4 +- .../content/_delete-revisions-csharp.mdx | 6 +- .../content/_get-revisions-csharp.mdx | 2 +- .../content/_get-revisions-nodejs.mdx | 2 +- .../operations/content/_get-revisions-php.mdx | 2 +- .../content/_get-revisions-python.mdx | 2 +- .../session/content/_including-csharp.mdx | 2 +- .../session/content/_including-nodejs.mdx | 2 +- .../session/content/_including-php.mdx | 2 +- .../revisions/content/_overview-csharp.mdx | 16 +- .../revisions/content/_overview-nodejs.mdx | 16 +- .../revisions/content/_overview-python.mdx | 22 +-- .../_revisions-and-other-features-csharp.mdx | 16 +- .../_revisions-and-other-features-nodejs.mdx | 14 +- .../_revisions-and-other-features-php.mdx | 14 +- .../_revisions-and-other-features-python.mdx | 14 +- ...documents-to-specific-revisions-csharp.mdx | 4 +- .../revert-documents-to-specific-time.mdx | 4 +- .../content/_append-in-bulk-csharp.mdx | 2 +- .../content/_append-in-bulk-nodejs.mdx | 2 +- .../content/_javascript-support-csharp.mdx | 10 +- .../content/_javascript-support-nodejs.mdx | 10 +- .../client-api/content/_overview-csharp.mdx | 30 ++-- .../client-api/content/_overview-nodejs.mdx | 30 ++-- .../content/_append-and-delete-csharp.mdx | 2 +- .../content/_append-and-delete-nodejs.mdx | 2 +- .../operations/content/_get-csharp.mdx | 8 +- .../operations/content/_get-nodejs.mdx | 4 +- .../operations/content/_patch-csharp.mdx | 12 +- .../operations/content/_patch-nodejs.mdx | 12 +- .../session/content/_append-csharp.mdx | 8 +- .../session/content/_append-nodejs.mdx | 8 +- .../session/content/_append-php.mdx | 2 +- .../session/content/_append-python.mdx | 8 +- .../session/content/_delete-csharp.mdx | 2 +- .../session/content/_delete-nodejs.mdx | 2 +- .../session/content/_delete-php.mdx | 2 +- .../session/content/_delete-python.mdx | 2 +- .../session/content/_patch-csharp.mdx | 4 +- .../session/content/_patch-nodejs.mdx | 4 +- .../session/content/_patch-python.mdx | 4 +- .../session/content/_querying-csharp.mdx | 8 +- .../session/content/_querying-nodejs.mdx | 8 +- .../get/content/_get-entries-csharp.mdx | 12 +- .../get/content/_get-entries-nodejs.mdx | 10 +- .../session/get/content/_get-entries-php.mdx | 6 +- .../get/content/_get-entries-python.mdx | 10 +- .../include/content/_overview-csharp.mdx | 6 +- .../include/content/_overview-nodejs.mdx | 6 +- .../timeseries/content/_design-csharp.mdx | 2 +- .../timeseries/content/_design-nodejs.mdx | 2 +- .../timeseries/content/_indexing-csharp.mdx | 6 +- .../timeseries/content/_indexing-nodejs.mdx | 6 +- .../timeseries/content/_indexing-php.mdx | 4 +- .../timeseries/content/_indexing-python.mdx | 6 +- .../content/_rollup-and-retention-csharp.mdx | 6 +- .../content/_rollup-and-retention-nodejs.mdx | 4 +- .../content/_rollup-and-retention-php.mdx | 4 +- .../content/_rollup-and-retention-python.mdx | 4 +- ..._time-series-and-other-features-csharp.mdx | 10 +- ..._time-series-and-other-features-nodejs.mdx | 10 +- .../client-api/javascript-support.mdx | 16 +- .../client-api/operations/get.mdx | 4 +- .../client-api/session/get.mdx | 14 +- .../client-api/session/increment.mdx | 4 +- .../client-api/session/overview.mdx | 16 +- .../incremental-time-series/overview.mdx | 16 +- .../timeseries/overview.mdx | 30 ++-- .../_aggregation-and-projections-csharp.mdx | 6 +- .../_aggregation-and-projections-nodejs.mdx | 6 +- .../_aggregation-and-projections-php.mdx | 4 +- .../content/_choosing-query-range-csharp.mdx | 2 +- .../content/_choosing-query-range-nodejs.mdx | 2 +- .../content/_choosing-query-range-python.mdx | 2 +- .../querying/content/_filtering-csharp.mdx | 10 +- .../querying/content/_filtering-nodejs.mdx | 10 +- .../querying/content/_filtering-php.mdx | 8 +- .../querying/content/_filtering-python.mdx | 8 +- .../querying/content/_gap-filling-csharp.mdx | 2 +- .../querying/content/_gap-filling-java.mdx | 2 +- .../querying/content/_gap-filling-nodejs.mdx | 2 +- .../content/_overview-and-syntax-csharp.mdx | 16 +- .../content/_overview-and-syntax-nodejs.mdx | 14 +- .../content/_overview-and-syntax-php.mdx | 14 +- .../content/_overview-and-syntax-python.mdx | 14 +- .../content/_stream-timeseries-csharp.mdx | 2 +- .../content/_using-indexes-csharp.mdx | 4 +- .../content/_using-indexes-nodejs.mdx | 4 +- .../querying/content/_using-indexes-php.mdx | 4 +- .../content/_using-indexes-python.mdx | 4 +- .../timeseries/querying/statistics.mdx | 4 +- .../indexes/additional-assemblies.mdx | 2 +- .../indexes/content/_boosting-java.mdx | 4 +- .../_creating-and-deploying-csharp.mdx | 6 +- .../content/_creating-and-deploying-java.mdx | 6 +- .../_creating-and-deploying-nodejs.mdx | 6 +- .../content/_extending-indexes-csharp.mdx | 2 +- .../content/_extending-indexes-java.mdx | 2 +- .../content/_extending-indexes-nodejs.mdx | 2 +- .../content/_indexing-basics-csharp.mdx | 8 +- .../indexes/content/_indexing-basics-java.mdx | 8 +- .../content/_indexing-basics-nodejs.mdx | 8 +- .../_indexing-linq-extensions-csharp.mdx | 4 +- .../_indexing-linq-extensions-java.mdx | 4 +- .../_indexing-linq-extensions-nodejs.mdx | 4 +- .../content/_indexing-metadata-csharp.mdx | 2 +- .../content/_indexing-metadata-nodejs.mdx | 2 +- .../content/_indexing-metadata-php.mdx | 2 +- .../content/_indexing-metadata-python.mdx | 2 +- .../content/_indexing-nested-data-csharp.mdx | 2 +- .../content/_indexing-nested-data-java.mdx | 2 +- .../content/_indexing-nested-data-nodejs.mdx | 2 +- .../content/_indexing-nested-data-php.mdx | 2 +- .../content/_indexing-nested-data-python.mdx | 2 +- .../_indexing-polymorphic-data-nodejs.mdx | 2 +- .../content/_indexing-spatial-data-csharp.mdx | 2 +- .../content/_indexing-spatial-data-java.mdx | 4 +- .../content/_indexing-spatial-data-nodejs.mdx | 2 +- .../content/_indexing-spatial-data-php.mdx | 2 +- .../content/_indexing-spatial-data-python.mdx | 2 +- .../content/_javascript-indexes-csharp.mdx | 12 +- .../content/_javascript-indexes-java.mdx | 8 +- .../indexes/content/_map-indexes-csharp.mdx | 16 +- .../indexes/content/_map-indexes-java.mdx | 12 +- .../indexes/content/_map-indexes-nodejs.mdx | 12 +- .../indexes/content/_map-indexes-php.mdx | 14 +- .../indexes/content/_map-indexes-python.mdx | 16 +- .../content/_map-reduce-indexes-csharp.mdx | 4 +- .../content/_map-reduce-indexes-java.mdx | 4 +- .../content/_map-reduce-indexes-nodejs.mdx | 4 +- .../content/_map-reduce-indexes-php.mdx | 4 +- .../content/_map-reduce-indexes-python.mdx | 4 +- .../content/_multi-map-indexes-csharp.mdx | 4 +- .../content/_multi-map-indexes-java.mdx | 4 +- .../content/_multi-map-indexes-nodejs.mdx | 4 +- .../content/_multi-map-indexes-php.mdx | 4 +- .../content/_multi-map-indexes-python.mdx | 4 +- .../_number-type-conversion-csharp.mdx | 2 +- .../content/_sorting-and-collation-csharp.mdx | 2 +- .../content/_sorting-and-collation-java.mdx | 2 +- .../content/_storing-data-in-index-csharp.mdx | 14 +- .../content/_storing-data-in-index-java.mdx | 4 +- .../content/_storing-data-in-index-nodejs.mdx | 4 +- .../content/_storing-data-in-index-php.mdx | 4 +- .../content/_storing-data-in-index-python.mdx | 4 +- .../content/_using-analyzers-csharp.mdx | 14 +- .../indexes/content/_using-analyzers-java.mdx | 6 +- .../content/_using-analyzers-nodejs.mdx | 14 +- .../content/_using-dynamic-fields-csharp.mdx | 26 +-- .../content/_using-dynamic-fields-java.mdx | 26 +-- .../content/_using-dynamic-fields-nodejs.mdx | 22 +-- .../content/_using-dynamic-fields-php.mdx | 26 +-- .../content/_using-dynamic-fields-python.mdx | 26 +-- .../content/_what-are-indexes-csharp.mdx | 16 +- .../content/_what-are-indexes-java.mdx | 16 +- .../content/_what-are-indexes-nodejs.mdx | 16 +- .../indexes/content/_what-are-indexes-php.mdx | 16 +- .../content/_what-are-indexes-python.mdx | 16 +- .../indexes/index-administration.mdx | 6 +- .../version-6.2/indexes/index-throttling.mdx | 2 +- .../querying/content/_distinct-csharp.mdx | 6 +- .../querying/content/_distinct-java.mdx | 6 +- .../querying/content/_distinct-nodejs.mdx | 6 +- .../content/_exploration-queries-csharp.mdx | 6 +- .../content/_exploration-queries-nodejs.mdx | 6 +- .../content/_exploration-queries-php.mdx | 6 +- .../content/_exploration-queries-python.mdx | 6 +- .../querying/content/_highlighting-csharp.mdx | 2 +- .../querying/content/_highlighting-nodejs.mdx | 2 +- .../querying/content/_highlighting-php.mdx | 2 +- .../querying/content/_highlighting-python.mdx | 2 +- .../content/_include-explanations-csharp.mdx | 2 +- .../content/_include-explanations-nodejs.mdx | 2 +- .../querying/content/_morelikethis-csharp.mdx | 4 +- .../querying/content/_morelikethis-java.mdx | 4 +- .../querying/content/_morelikethis-nodejs.mdx | 4 +- .../querying/content/_morelikethis-php.mdx | 4 +- .../querying/content/_morelikethis-python.mdx | 4 +- .../querying/content/_paging-csharp.mdx | 6 +- .../indexes/querying/content/_paging-java.mdx | 6 +- .../querying/content/_paging-nodejs.mdx | 6 +- .../indexes/querying/content/_paging-php.mdx | 6 +- .../querying/content/_paging-python.mdx | 6 +- .../querying/content/_projections-csharp.mdx | 4 +- .../querying/content/_projections-java.mdx | 2 +- .../querying/content/_projections-nodejs.mdx | 4 +- .../querying/content/_projections-php.mdx | 2 +- .../querying/content/_projections-python.mdx | 2 +- .../querying/content/_query-index-csharp.mdx | 4 +- .../querying/content/_query-index-java.mdx | 10 +- .../querying/content/_query-index-nodejs.mdx | 4 +- .../querying/content/_query-index-php.mdx | 4 +- .../querying/content/_query-index-python.mdx | 4 +- .../querying/content/_searching-csharp.mdx | 24 +-- .../querying/content/_searching-java.mdx | 4 +- .../querying/content/_searching-nodejs.mdx | 24 +-- .../querying/content/_searching-php.mdx | 8 +- .../querying/content/_searching-python.mdx | 8 +- .../querying/content/_sorting-csharp.mdx | 4 +- .../querying/content/_sorting-java.mdx | 2 +- .../querying/content/_sorting-nodejs.mdx | 4 +- .../indexes/querying/content/_sorting-php.mdx | 4 +- .../querying/content/_sorting-python.mdx | 4 +- .../querying/content/_spatial-csharp.mdx | 2 +- .../querying/content/_spatial-java.mdx | 2 +- .../querying/content/_spatial-nodejs.mdx | 2 +- .../indexes/querying/content/_spatial-php.mdx | 2 +- .../querying/content/_spatial-python.mdx | 2 +- .../querying/content/_suggestions-csharp.mdx | 2 +- .../querying/content/_suggestions-nodejs.mdx | 2 +- .../querying/content/_suggestions-php.mdx | 2 +- .../querying/content/_suggestions-python.mdx | 2 +- .../indexes/rolling-index-deployment.mdx | 4 +- .../indexes/search-engine/corax.mdx | 18 +-- .../events-and-snapshots.mdx | 4 +- .../integrating-with-akka-persistence.mdx | 6 +- .../postgresql-protocol/overview.mdx | 4 +- .../postgresql-protocol/power-bi.mdx | 8 +- .../version-6.2/server/administration/cli.mdx | 2 +- .../monitoring/open-telemetry.mdx | 46 +++--- .../administration/snmp/snmp-overview.mdx | 28 ++-- .../server/clustering/cluster-api.mdx | 2 +- ...luster-best-practice-and-configuration.mdx | 4 +- .../clustering/cluster-transactions.mdx | 18 +-- .../distribution/cluster-observer.mdx | 16 +- .../distribution/distributed-database.mdx | 14 +- .../distribution/highly-available-tasks.mdx | 24 +-- .../server/clustering/overview.mdx | 14 +- .../clustering/rachis/cluster-topology.mdx | 10 +- .../rachis/consensus-operations.mdx | 6 +- .../clustering/rachis/what-is-rachis.mdx | 6 +- .../replication/advanced-replication.mdx | 4 +- .../clustering/replication/change-vector.mdx | 2 +- .../replication-and-embedded-instance.mdx | 10 +- .../replication/replication-conflicts.mdx | 8 +- .../replication/replication-overview.mdx | 10 +- .../configuration/backup-configuration.mdx | 10 +- .../configuration/configuration-options.mdx | 6 +- .../configuration/core-configuration.mdx | 6 +- .../configuration/database-configuration.mdx | 4 +- .../configuration/etl-configuration.mdx | 2 +- .../configuration/indexing-configuration.mdx | 10 +- .../configuration/license-configuration.mdx | 2 +- .../configuration/memory-configuration.mdx | 2 +- .../queue-sink-configuration.mdx | 4 +- .../configuration/security-configuration.mdx | 6 +- .../configuration/server-configuration.mdx | 2 +- .../configuration/storage-configuration.mdx | 8 +- .../server/content/_embedded-csharp.mdx | 4 +- .../server/content/_embedded-java.mdx | 2 +- .../extensions/content/_refresh-csharp.mdx | 8 +- .../extensions/content/_refresh-nodejs.mdx | 8 +- .../server/kb/javascript-engine.mdx | 12 +- .../server/kb/linux-thread-names.mdx | 2 +- .../server/ongoing-tasks/backup-overview.mdx | 4 +- .../server/ongoing-tasks/etl/basics.mdx | 32 ++-- .../ongoing-tasks/etl/elasticsearch.mdx | 12 +- .../server/ongoing-tasks/etl/olap.mdx | 4 +- .../etl/queue-etl/azure-queue.mdx | 8 +- .../ongoing-tasks/etl/queue-etl/kafka.mdx | 6 +- .../ongoing-tasks/etl/queue-etl/overview.mdx | 12 +- .../ongoing-tasks/etl/queue-etl/rabbit-mq.mdx | 6 +- .../server/ongoing-tasks/etl/raven.mdx | 10 +- .../server/ongoing-tasks/etl/sql.mdx | 6 +- .../server/ongoing-tasks/etl/test-scripts.mdx | 2 +- .../ongoing-tasks/external-replication.mdx | 12 +- .../ongoing-tasks/hub-sink-replication.mdx | 6 +- .../queue-sink/kafka-queue-sink.mdx | 12 +- .../ongoing-tasks/queue-sink/overview.mdx | 2 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 10 +- .../security/audit-log/audit-log-overview.mdx | 14 +- .../certificate-configuration.mdx | 16 +- .../authentication/certificate-management.mdx | 56 +++---- .../certificate-renewal-and-rotation.mdx | 4 +- .../client-certificate-usage.mdx | 2 +- .../lets-encrypt-certificates.mdx | 10 +- .../recover-from-expired-certificate.mdx | 12 +- ...olve-cluster-certificate-renewal-issue.mdx | 2 +- .../security-clearance-and-permissions.mdx | 2 +- .../server/security/common-errors-and-faq.mdx | 22 +-- .../encryption/database-encryption.mdx | 4 +- .../encryption/encryption-at-rest.mdx | 8 +- .../encryption/secret-key-management.mdx | 2 +- .../encryption/server-store-encryption.mdx | 8 +- .../version-6.2/server/security/overview.mdx | 24 +-- .../content/_documents-compression-csharp.mdx | 2 +- .../content/_documents-compression-nodejs.mdx | 2 +- ...customizing-raven-data-files-locations.mdx | 22 +-- .../server/storage/directory-structure.mdx | 2 +- .../version-6.2/server/tcp-compression.mdx | 10 +- .../server/troubleshooting/collect-info.mdx | 14 +- .../server/troubleshooting/logging.mdx | 6 +- .../server/troubleshooting/traffic-watch.mdx | 18 +-- .../administration/anchoring-documents.mdx | 4 +- .../sharding/administration/api-admin.mdx | 2 +- .../administration/sharding-by-prefix.mdx | 10 +- .../sharding/administration/studio-admin.mdx | 10 +- .../sharding/backup-and-restore/backup.mdx | 12 +- .../sharding/backup-and-restore/restore.mdx | 8 +- .../sharding/document-extensions.mdx | 4 +- versioned_docs/version-6.2/sharding/etl.mdx | 10 +- .../sharding/external-replication.mdx | 8 +- .../sharding/import-and-export.mdx | 6 +- .../version-6.2/sharding/indexing.mdx | 8 +- .../version-6.2/sharding/migration.mdx | 24 +-- .../version-6.2/sharding/overview.mdx | 22 +-- .../version-6.2/sharding/querying.mdx | 12 +- .../version-6.2/sharding/resharding.mdx | 14 +- .../version-6.2/sharding/subscriptions.mdx | 4 +- .../version-6.2/sharding/unsupported.mdx | 16 +- .../version-6.2/start/getting-started.mdx | 12 +- .../start/guides/aws-lambda/deployment.mdx | 2 +- .../guides/aws-lambda/existing-project.mdx | 6 +- .../content/_existing-project-csharp.mdx | 2 +- .../content/_existing-project-nodejs.mdx | 2 +- .../deployment-considerations.mdx | 2 +- .../start/installation/gnu-linux/deb.mdx | 2 +- .../version-6.2/start/installation/manual.mdx | 2 +- .../start/installation/running-as-service.mdx | 6 +- .../setup-examples/aws-linux-vm.mdx | 8 +- .../setup-examples/aws-windows-vm.mdx | 8 +- .../setup-wizard/additional-settings.mdx | 14 +- .../setup-wizard/choose-security-option.mdx | 18 +-- .../setup-wizard/choose-setup-method.mdx | 62 ++++---- .../setup-wizard/configure-node-addresses.mdx | 18 +-- .../setup-wizard/finish-setup.mdx | 18 +-- .../installation/setup-wizard/overview.mdx | 6 +- .../setup-wizard/provide-license-key.mdx | 12 +- .../setup-wizard/review-setup.mdx | 6 +- .../setup-wizard/use-setup-package.mdx | 8 +- .../installation/system-requirements.mdx | 4 +- .../installation/upgrading-to-new-version.mdx | 2 +- .../start/licensing/force-update.mdx | 8 +- .../start/licensing/licensing-overview.mdx | 10 +- .../start/licensing/renew-license.mdx | 6 +- .../cluster-dashboard-overview.mdx | 4 +- .../cluster-dashboard-widgets.mdx | 6 +- .../studio/cluster/cluster-view.mdx | 12 +- .../studio/cluster/setting-a-cluster.mdx | 2 +- .../studio/database/code-assistance.mdx | 12 +- .../create-new-database/from-backup.mdx | 8 +- .../create-new-database/from-legacy-files.mdx | 4 +- .../create-new-database/general-flow.mdx | 6 +- .../studio/database/databases-list-view.mdx | 8 +- .../document-extensions/revisions.mdx | 2 +- .../document-extensions/time-series.mdx | 6 +- .../database/documents/conflicts-view.mdx | 2 +- .../documents/create-new-document.mdx | 2 +- .../database/documents/document-view.mdx | 6 +- .../documents/documents-and-collections.mdx | 6 +- .../studio/database/documents/patch-view.mdx | 2 +- .../database/indexes/create-map-index.mdx | 4 +- .../indexes/create-map-reduce-index.mdx | 6 +- .../indexes/create-multi-map-index.mdx | 10 +- .../studio/database/indexes/index-history.mdx | 4 +- .../database/indexes/indexes-list-view.mdx | 8 +- .../database/indexes/indexes-overview.mdx | 18 +-- .../database/indexes/indexing-performance.mdx | 14 +- .../studio/database/queries/query-view.mdx | 12 +- .../client-configuration-per-database.mdx | 4 +- .../database/settings/conflict-resolution.mdx | 2 +- .../database/settings/custom-analyzers.mdx | 2 +- .../database/settings/database-record.mdx | 26 +-- .../database/settings/database-settings.mdx | 4 +- .../database/settings/document-revisions.mdx | 4 +- .../settings/documents-compression.mdx | 2 +- .../settings/manage-database-group.mdx | 12 +- .../settings/studio-configuration.mdx | 14 +- .../external-replication-stats.mdx | 2 +- .../ongoing-tasks-stats/olap-etl-stats.mdx | 2 +- .../ongoing-tasks-stats/ravendb-etl-stats.mdx | 2 +- .../subscription-stats.mdx | 6 +- .../studio/database/stats/storage-report.mdx | 2 +- .../studio/database/tasks/backup-task.mdx | 20 +-- .../database/tasks/create-sample-data.mdx | 14 +- .../studio/database/tasks/export-database.mdx | 6 +- .../tasks/import-data/import-data-file.mdx | 22 +-- .../tasks/import-data/import-from-other.mdx | 2 +- .../tasks/import-data/import-from-ravendb.mdx | 16 +- .../ongoing-tasks/azure-queue-storage-etl.mdx | 4 +- .../ongoing-tasks/elasticsearch-etl-task.mdx | 4 +- .../external-replication-task.mdx | 18 +-- .../tasks/ongoing-tasks/general-info.mdx | 26 +-- .../hub-sink-replication/overview.mdx | 6 +- .../replication-hub-task.mdx | 4 +- .../replication-sink-task.mdx | 4 +- .../tasks/ongoing-tasks/kafka-etl-task.mdx | 4 +- .../tasks/ongoing-tasks/kafka-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/rabbitmq-etl-task.mdx | 4 +- .../ongoing-tasks/rabbitmq-queue-sink.mdx | 6 +- .../tasks/ongoing-tasks/ravendb-etl-task.mdx | 10 +- .../version-6.2/studio/overview.mdx | 28 ++-- .../certificates/read-only-access-level.mdx | 4 +- .../studio/server/client-configuration.mdx | 2 +- .../debug/advanced/cluster-observer.mdx | 8 +- .../studio/server/manage-server.mdx | 22 +-- .../studio/server/server-settings.mdx | 2 +- .../studio/server/server-wide-backup.mdx | 16 +- .../ai-agents/ai-agents_configuration.mdx | 2 +- .../ai-agents/ai-agents_security-concerns.mdx | 2 +- .../_creating-ai-agents_api-csharp.mdx | 14 +- .../_creating-ai-agents_api-nodejs.mdx | 26 +-- .../_creating-ai-agents_api-python.mdx | 14 +- .../creating-ai-agents_studio.mdx | 14 +- .../ai-integration/ai-agents/overview.mdx | 36 ++--- .../ai-integration/ai-tasks-list-view.mdx | 4 +- .../content/_azure-open-ai-csharp.mdx | 6 +- .../content/_azure-open-ai-nodejs.mdx | 6 +- .../content/_azure-open-ai-python.mdx | 6 +- .../content/_embedded-csharp.mdx | 4 +- .../content/_embedded-nodejs.mdx | 4 +- .../content/_embedded-python.mdx | 4 +- .../content/_google-ai-csharp.mdx | 4 +- .../content/_google-ai-nodejs.mdx | 4 +- .../content/_google-ai-python.mdx | 4 +- .../content/_hugging-face-csharp.mdx | 4 +- .../content/_hugging-face-nodejs.mdx | 4 +- .../content/_hugging-face-python.mdx | 4 +- .../content/_mistral-ai-csharp.mdx | 4 +- .../content/_mistral-ai-nodejs.mdx | 4 +- .../content/_mistral-ai-python.mdx | 4 +- .../content/_ollama-csharp.mdx | 6 +- .../content/_ollama-nodejs.mdx | 6 +- .../content/_ollama-python.mdx | 6 +- .../content/_open-ai-csharp.mdx | 6 +- .../content/_open-ai-nodejs.mdx | 6 +- .../content/_open-ai-python.mdx | 6 +- .../content/_vertex-ai-csharp.mdx | 4 +- .../content/_vertex-ai-nodejs.mdx | 4 +- .../content/_vertex-ai-python.mdx | 4 +- .../connection-strings/overview.mdx | 38 ++--- .../_create-gen-ai-task_api-csharp.mdx | 16 +- .../_create-gen-ai-task_api-nodejs.mdx | 24 +-- .../_create-gen-ai-task_api-python.mdx | 16 +- .../create-gen-ai-task_studio.mdx | 10 +- .../gen-ai-security-concerns.mdx | 8 +- .../_modify-gen-ai-task_api-csharp.mdx | 6 +- .../_modify-gen-ai-task_api-nodejs.mdx | 6 +- .../_modify-gen-ai-task_api-python.mdx | 6 +- .../modify-gen-ai-task_studio.mdx | 6 +- .../gen-ai-integration/overview.mdx | 14 +- .../_processing-attachments_api-csharp.mdx | 18 +-- .../_processing-attachments_api-nodejs.mdx | 18 +-- .../_processing-attachments_api-python.mdx | 18 +-- .../processing-attachments_studio.mdx | 6 +- .../_embeddings-generation-task-csharp.mdx | 24 +-- .../_embeddings-generation-task-nodejs.mdx | 22 +-- .../content/_overview-csharp.mdx | 42 ++--- .../content/_overview-nodejs.mdx | 42 ++--- .../embedding-collections.mdx | 8 +- .../generating-embeddings/start.mdx | 10 +- .../_data-types-for-vector-search-csharp.mdx | 4 +- .../_data-types-for-vector-search-nodejs.mdx | 4 +- ...g-attachments-for-vector-search-csharp.mdx | 6 +- ...g-attachments-for-vector-search-nodejs.mdx | 6 +- ...g-attachments-for-vector-search-python.mdx | 6 +- ...ctor-search-using-dynamic-query-csharp.mdx | 24 +-- ...ctor-search-using-dynamic-query-nodejs.mdx | 24 +-- ...ctor-search-using-dynamic-query-python.mdx | 22 +-- ...ector-search-using-static-index-csharp.mdx | 38 ++--- ...ector-search-using-static-index-nodejs.mdx | 26 +-- ...ector-search-using-static-index-python.mdx | 28 ++-- .../ai-integration/vector-search/overview.mdx | 32 ++-- .../ai-integration/vector-search/start.mdx | 8 +- .../what-affects-vector-search-results.mdx | 20 +-- ...work-with-bulk-insert-operation-csharp.mdx | 4 +- ...-subscribe-to-operation-changes-csharp.mdx | 4 +- .../content/_what-is-changes-api-csharp.mdx | 36 ++--- .../content/_what-is-changes-api-java.mdx | 22 +-- .../content/_what-is-changes-api-nodejs.mdx | 22 +-- ...es-with-replication-and-cluster-csharp.mdx | 4 +- ...ates-with-replication-and-cluster-java.mdx | 2 +- ...es-with-replication-and-cluster-nodejs.mdx | 2 +- .../client-api/cluster/speed-test.mdx | 2 +- ...multiple-commands-using-a-batch-csharp.mdx | 6 +- ...multiple-commands-using-a-batch-nodejs.mdx | 6 +- .../commands/content/_overview-csharp.mdx | 20 +-- .../commands/content/_overview-java.mdx | 12 +- .../commands/content/_overview-nodejs.mdx | 20 +-- .../documents/content/_delete-csharp.mdx | 2 +- .../documents/content/_delete-nodejs.mdx | 2 +- .../documents/content/_get-csharp.mdx | 2 +- .../documents/content/_get-nodejs.mdx | 2 +- .../documents/content/_put-csharp.mdx | 4 +- .../documents/content/_put-nodejs.mdx | 4 +- .../content/_conventions-csharp.mdx | 34 ++-- .../content/_conventions-nodejs.mdx | 18 +-- .../content/_deserialization-csharp.mdx | Bin 3313 -> 3268 bytes .../content/_serialization-csharp.mdx | 6 +- .../content/_global-csharp.mdx | 2 +- .../content/_global-java.mdx | 2 +- .../content/_global-nodejs.mdx | 2 +- .../content/_type-specific-csharp.mdx | 2 +- .../content/_type-specific-java.mdx | 2 +- .../content/_type-specific-nodejs.mdx | 2 +- .../content/_load-balance-behavior-csharp.mdx | 16 +- .../content/_load-balance-behavior-nodejs.mdx | 16 +- .../content/_load-balance-behavior-php.mdx | 16 +- .../content/_load-balance-behavior-python.mdx | 16 +- .../content/_read-balance-behavior-csharp.mdx | 14 +- .../content/_read-balance-behavior-nodejs.mdx | 14 +- .../content/_read-balance-behavior-php.mdx | 14 +- .../content/_read-balance-behavior-python.mdx | 14 +- .../configuration/load-balance/overview.mdx | 20 +-- .../_creating-document-store-csharp.mdx | 10 +- .../_setting-up-default-database-java.mdx | 2 +- .../_setting-up-default-database-nodejs.mdx | 2 +- .../_what-is-a-document-store-csharp.mdx | 18 +-- .../_what-is-a-document-store-java.mdx | 14 +- .../_what-is-a-document-store-nodejs.mdx | 12 +- .../_maintenance-operations-csharp.mdx | 4 +- .../_maintenance-operations-nodejs.mdx | 4 +- .../content/_api-overview-csharp.mdx | 4 +- .../content/_api-overview-java.mdx | 2 +- .../content/_api-overview-nodejs.mdx | 6 +- .../content/_api-overview-python.mdx | 6 +- ...ow-to-consume-data-subscription-csharp.mdx | 8 +- ..._how-to-consume-data-subscription-java.mdx | 4 +- ...ow-to-consume-data-subscription-nodejs.mdx | 8 +- ...ow-to-consume-data-subscription-python.mdx | 6 +- .../_concurrent-subscriptions-csharp.mdx | 8 +- .../_concurrent-subscriptions-nodejs.mdx | 8 +- .../_what-are-data-subscriptions-csharp.mdx | 14 +- .../_what-are-data-subscriptions-java.mdx | 8 +- .../_what-are-data-subscriptions-nodejs.mdx | 8 +- .../creation/content/_api-overview-csharp.mdx | 4 +- .../creation/content/_api-overview-nodejs.mdx | 12 +- .../creation/content/_api-overview-python.mdx | 2 +- .../creation/content/_examples-csharp.mdx | 10 +- .../creation/content/_examples-nodejs.mdx | 10 +- .../creation/content/_examples-python.mdx | 8 +- ...how-to-create-data-subscription-csharp.mdx | 6 +- .../_how-to-create-data-subscription-java.mdx | 4 +- ...how-to-create-data-subscription-nodejs.mdx | 6 +- ...how-to-create-data-subscription-python.mdx | 6 +- .../content/_hilo-algorithm-csharp.mdx | 12 +- ...rking-with-document-identifiers-csharp.mdx | 16 +- .../client-api/faq/transaction-support.mdx | 28 ++-- .../client-api/faq/what-is-a-collection.mdx | 4 +- .../_handle-document-relationships-csharp.mdx | 2 +- .../_handle-document-relationships-java.mdx | 2 +- .../_handle-document-relationships-nodejs.mdx | 2 +- .../_setup-aggressive-caching-csharp.mdx | 12 +- .../_setup-aggressive-caching-java.mdx | 12 +- .../how-to/integrate-with-excel.mdx | 2 +- .../how-to/subscribe-to-store-events.mdx | 20 +-- .../content/_delete-by-query-csharp.mdx | 4 +- .../content/_delete-by-query-nodejs.mdx | 4 +- .../common/content/_delete-by-query-php.mdx | 4 +- .../content/_delete-by-query-python.mdx | 2 +- .../content/_what-are-operations-csharp.mdx | 142 ++++++++--------- .../content/_what-are-operations-java.mdx | 72 ++++----- .../content/_what-are-operations-nodejs.mdx | 142 ++++++++--------- .../content/_what-are-operations-php.mdx | 142 ++++++++--------- .../content/_what-are-operations-python.mdx | 142 ++++++++--------- ...rations-to-a-different-database-csharp.mdx | 6 +- ...rations-to-a-different-database-nodejs.mdx | 6 +- ...operations-to-a-different-database-php.mdx | 6 +- ...rations-to-a-different-database-python.mdx | 6 +- ...-operations-to-a-different-node-csharp.mdx | 4 +- ...-operations-to-a-different-node-nodejs.mdx | 4 +- ...tch-operations-to-a-different-node-php.mdx | 4 +- .../maintenance/backup/backup-overview.mdx | 2 +- .../maintenance/backup/encrypted-backup.mdx | 8 +- .../operations/maintenance/backup/faq.mdx | 8 +- .../operations/maintenance/backup/restore.mdx | 8 +- .../_database-settings-operation-csharp.mdx | 2 +- .../_database-settings-operation-nodejs.mdx | 2 +- .../_database-settings-operation-php.mdx | 2 +- .../_get-client-configuration-csharp.mdx | 2 +- .../_get-client-configuration-nodejs.mdx | 2 +- .../content/_get-client-configuration-php.mdx | 2 +- .../_get-client-configuration-python.mdx | 2 +- .../_put-client-configuration-csharp.mdx | 10 +- .../_put-client-configuration-nodejs.mdx | 10 +- .../content/_put-client-configuration-php.mdx | 10 +- .../_put-client-configuration-python.mdx | 10 +- .../content/_get-connection-string-csharp.mdx | 4 +- .../maintenance/content/_get-stats-csharp.mdx | 2 +- .../maintenance/content/_get-stats-java.mdx | 2 +- .../maintenance/content/_get-stats-nodejs.mdx | 2 +- .../maintenance/content/_get-stats-php.mdx | 2 +- .../maintenance/content/_get-stats-python.mdx | 2 +- .../etl/content/_add-etl-csharp.mdx | 10 +- .../content/_get-identities-csharp.mdx | 2 +- .../content/_get-identities-php.mdx | 2 +- .../content/_get-identities-python.mdx | 2 +- .../content/_delete-index-errors-csharp.mdx | 4 +- .../content/_delete-index-errors-nodejs.mdx | 4 +- .../content/_delete-index-errors-php.mdx | 4 +- .../content/_delete-index-errors-python.mdx | 4 +- .../indexes/content/_disable-index-csharp.mdx | 12 +- .../indexes/content/_disable-index-java.mdx | 2 +- .../indexes/content/_disable-index-nodejs.mdx | 12 +- .../indexes/content/_disable-index-php.mdx | 12 +- .../indexes/content/_disable-index-python.mdx | 12 +- .../indexes/content/_enable-index-csharp.mdx | 8 +- .../indexes/content/_enable-index-nodejs.mdx | 8 +- .../indexes/content/_enable-index-php.mdx | 8 +- .../indexes/content/_enable-index-python.mdx | 8 +- .../indexes/content/_get-index-csharp.mdx | 4 +- .../content/_get-index-errors-csharp.mdx | 4 +- .../content/_get-index-errors-nodejs.mdx | 4 +- .../indexes/content/_get-index-errors-php.mdx | 4 +- .../content/_get-index-errors-python.mdx | 4 +- .../indexes/content/_get-index-nodejs.mdx | 4 +- .../indexes/content/_get-index-php.mdx | 2 +- .../indexes/content/_get-index-python.mdx | 4 +- .../indexes/content/_get-indexes-csharp.mdx | 4 +- .../indexes/content/_get-indexes-nodejs.mdx | 4 +- .../indexes/content/_get-indexes-php.mdx | 2 +- .../indexes/content/_get-indexes-python.mdx | 4 +- .../content/_index-has-changed-csharp.mdx | 2 +- .../content/_index-has-changed-nodejs.mdx | 2 +- .../content/_index-has-changed-php.mdx | 2 +- .../content/_index-has-changed-python.mdx | 2 +- .../indexes/content/_put-indexes-csharp.mdx | 2 +- .../indexes/content/_put-indexes-nodejs.mdx | 2 +- .../indexes/content/_put-indexes-php.mdx | 2 +- .../indexes/content/_put-indexes-python.mdx | 2 +- .../indexes/content/_reset-index-csharp.mdx | 8 +- .../indexes/content/_reset-index-nodejs.mdx | 8 +- .../indexes/content/_reset-index-php.mdx | 4 +- .../indexes/content/_reset-index-python.mdx | 8 +- .../content/_set-index-lock-csharp.mdx | 2 +- .../content/_set-index-lock-nodejs.mdx | 2 +- .../indexes/content/_set-index-lock-php.mdx | 2 +- .../content/_set-index-lock-python.mdx | 2 +- .../indexes/content/_start-index-csharp.mdx | 2 +- .../indexes/content/_start-index-nodejs.mdx | 2 +- .../indexes/content/_start-index-php.mdx | 2 +- .../indexes/content/_start-index-python.mdx | 2 +- .../content/_start-indexing-csharp.mdx | 4 +- .../content/_start-indexing-nodejs.mdx | 4 +- .../indexes/content/_start-indexing-php.mdx | 4 +- .../content/_start-indexing-python.mdx | 4 +- .../indexes/content/_stop-index-csharp.mdx | 10 +- .../indexes/content/_stop-index-nodejs.mdx | 10 +- .../indexes/content/_stop-index-php.mdx | 10 +- .../indexes/content/_stop-index-python.mdx | 10 +- .../indexes/content/_stop-indexing-csharp.mdx | 10 +- .../indexes/content/_stop-indexing-java.mdx | 4 +- .../indexes/content/_stop-indexing-nodejs.mdx | 10 +- .../indexes/content/_stop-indexing-php.mdx | 10 +- .../indexes/content/_stop-indexing-python.mdx | 10 +- .../_ongoing-task-operations-csharp.mdx | 2 +- .../sorters/content/_put-sorter-csharp.mdx | 6 +- .../sorters/content/_put-sorter-nodejs.mdx | 6 +- .../patching/content/_set-based-nodejs.mdx | 6 +- .../content/_single-document-csharp.mdx | 2 +- .../content/_single-document-nodejs.mdx | 12 +- .../operations/patching/json-patch-syntax.mdx | 2 +- ...serverwide-client-configuration-csharp.mdx | 6 +- ...serverwide-client-configuration-nodejs.mdx | 6 +- ...serverwide-client-configuration-csharp.mdx | 6 +- ...serverwide-client-configuration-nodejs.mdx | 6 +- .../content/_compact-database-csharp.mdx | 8 +- .../content/_compact-database-nodejs.mdx | 8 +- .../content/_compact-database-php.mdx | 6 +- .../content/_compact-database-python.mdx | 4 +- .../content/_create-database-csharp.mdx | 14 +- .../content/_create-database-java.mdx | 12 +- .../_put-sorter-server-wide-csharp.mdx | 6 +- .../_put-sorter-server-wide-nodejs.mdx | 6 +- .../document-commands/batch-commands.mdx | 8 +- .../document-commands/get-documents-by-id.mdx | 4 +- .../document-commands/put-documents.mdx | 2 +- .../rest-api/queries/delete-by-query.mdx | 2 +- .../rest-api/queries/patch-by-query.mdx | 4 +- .../rest-api/queries/query-the-database.mdx | 14 +- .../client-api/rest-api/rest-api-intro.mdx | 4 +- .../content/_overview-csharp.mdx | 4 +- .../content/_overview-nodejs.mdx | 4 +- .../content/_overview-php.mdx | 4 +- .../content/_overview-python.mdx | 4 +- .../_how-to-disable-caching-csharp.mdx | 2 +- .../content/_how-to-disable-caching-java.mdx | 2 +- .../_how-to-disable-caching-nodejs.mdx | 2 +- .../content/_how-to-disable-caching-php.mdx | 2 +- ...o-enable-optimistic-concurrency-csharp.mdx | 10 +- ...-to-enable-optimistic-concurrency-java.mdx | 6 +- ...o-enable-optimistic-concurrency-nodejs.mdx | 10 +- ...w-to-enable-optimistic-concurrency-php.mdx | 8 +- ...o-enable-optimistic-concurrency-python.mdx | 10 +- ...o-customize-id-generation-for-entities.mdx | 6 +- .../content/_deleting-entities-csharp.mdx | 2 +- .../content/_deleting-entities-java.mdx | 2 +- .../content/_deleting-entities-nodejs.mdx | 2 +- .../content/_deleting-entities-php.mdx | 2 +- .../content/_deleting-entities-python.mdx | 2 +- .../content/_loading-entities-csharp.mdx | 8 +- .../content/_loading-entities-java.mdx | 2 +- .../content/_loading-entities-nodejs.mdx | 2 +- .../session/content/_loading-entities-php.mdx | 4 +- .../content/_loading-entities-python.mdx | 10 +- .../content/_opening-a-session-csharp.mdx | 10 +- .../content/_opening-a-session-java.mdx | 6 +- .../content/_opening-a-session-nodejs.mdx | 10 +- .../content/_opening-a-session-php.mdx | 10 +- .../content/_opening-a-session-python.mdx | 10 +- .../content/_saving-changes-csharp.mdx | 6 +- .../session/content/_saving-changes-java.mdx | 6 +- .../content/_saving-changes-nodejs.mdx | 4 +- .../session/content/_saving-changes-php.mdx | 4 +- .../content/_saving-changes-python.mdx | 6 +- .../content/_updating-entities-csharp.mdx | 2 +- .../content/_updating-entities-nodejs.mdx | 2 +- .../content/_updating-entities-php.mdx | 4 +- .../content/_updating-entities-python.mdx | 2 +- ...-a-session-and-how-does-it-work-csharp.mdx | 42 ++--- ...is-a-session-and-how-does-it-work-java.mdx | 40 ++--- ...-a-session-and-how-does-it-work-nodejs.mdx | 42 ++--- ...-is-a-session-and-how-does-it-work-php.mdx | 40 ++--- ...-a-session-and-how-does-it-work-python.mdx | 40 ++--- .../_check-if-attachment-exists-csharp.mdx | 2 +- .../_check-if-attachment-exists-java.mdx | 2 +- .../_check-if-attachment-exists-nodejs.mdx | 2 +- .../_check-if-attachment-exists-php.mdx | 2 +- .../_check-if-attachment-exists-python.mdx | 2 +- .../_check-if-document-exists-csharp.mdx | 2 +- .../_check-if-document-exists-java.mdx | 2 +- .../_check-if-document-exists-nodejs.mdx | 2 +- .../content/_check-if-document-exists-php.mdx | 2 +- .../_check-if-document-exists-python.mdx | 2 +- .../_check-if-entity-has-changed-csharp.mdx | 6 +- .../_check-if-entity-has-changed-nodejs.mdx | 6 +- .../_check-if-entity-has-changed-php.mdx | 4 +- .../_check-if-entity-has-changed-python.mdx | 4 +- ...re-are-any-changes-on-a-session-csharp.mdx | 6 +- ...here-are-any-changes-on-a-session-java.mdx | 2 +- ...re-are-any-changes-on-a-session-nodejs.mdx | 6 +- ...there-are-any-changes-on-a-session-php.mdx | 4 +- ...re-are-any-changes-on-a-session-python.mdx | 4 +- .../content/_clear-a-session-csharp.mdx | 2 +- .../content/_clear-a-session-nodejs.mdx | 2 +- .../_evict-entity-from-a-session-csharp.mdx | 10 +- .../_evict-entity-from-a-session-java.mdx | 2 +- .../_evict-entity-from-a-session-nodejs.mdx | 10 +- .../_evict-entity-from-a-session-php.mdx | 2 +- .../_evict-entity-from-a-session-python.mdx | 2 +- .../_get-current-session-node-csharp.mdx | 4 +- .../_get-current-session-node-java.mdx | 4 +- .../_get-current-session-node-nodejs.mdx | 4 +- .../content/_get-current-session-node-php.mdx | 4 +- .../content/_get-tracked-entities-csharp.mdx | 6 +- .../content/_get-tracked-entities-nodejs.mdx | 6 +- .../content/_ignore-entity-changes-csharp.mdx | 8 +- .../content/_ignore-entity-changes-nodejs.mdx | 8 +- .../content/_ignore-entity-changes-php.mdx | 8 +- .../content/_ignore-entity-changes-python.mdx | 2 +- .../_perform-operations-lazily-csharp.mdx | 10 +- .../_perform-operations-lazily-nodejs.mdx | 10 +- .../_perform-operations-lazily-php.mdx | 10 +- .../_perform-operations-lazily-python.mdx | 10 +- .../content/_subscribe-to-events-csharp.mdx | 2 +- .../content/_subscribe-to-events-java.mdx | 2 +- .../content/_subscribe-to-events-nodejs.mdx | 2 +- .../_how-to-count-query-results-csharp.mdx | 2 +- .../_how-to-count-query-results-nodejs.mdx | 2 +- .../_how-to-count-query-results-php.mdx | 2 +- .../_how-to-count-query-results-python.mdx | 2 +- .../_how-to-customize-query-csharp.mdx | 24 +-- .../content/_how-to-customize-query-java.mdx | 2 +- .../_how-to-customize-query-nodejs.mdx | 18 +-- .../content/_how-to-customize-query-php.mdx | 16 +- .../_how-to-customize-query-python.mdx | 22 +-- .../_how-to-filter-by-field-csharp.mdx | 2 +- .../content/_how-to-filter-by-field-java.mdx | 2 +- .../_how-to-filter-by-field-python.mdx | 2 +- ...to-filter-by-non-existing-field-csharp.mdx | 6 +- ...to-filter-by-non-existing-field-nodejs.mdx | 6 +- ...ow-to-filter-by-non-existing-field-php.mdx | 6 +- ...to-filter-by-non-existing-field-python.mdx | 6 +- .../_how-to-get-query-statistics-csharp.mdx | 2 +- .../_how-to-get-query-statistics-php.mdx | 2 +- .../_how-to-get-query-statistics-python.mdx | 2 +- .../_how-to-perform-queries-lazily-csharp.mdx | 8 +- .../_how-to-perform-queries-lazily-nodejs.mdx | 8 +- .../_how-to-perform-queries-lazily-php.mdx | 6 +- .../_how-to-perform-queries-lazily-python.mdx | 12 +- .../_how-to-project-query-results-csharp.mdx | 4 +- .../_how-to-project-query-results-nodejs.mdx | 2 +- .../_how-to-project-query-results-php.mdx | 2 +- .../_how-to-project-query-results-python.mdx | 2 +- .../querying/content/_how-to-query-csharp.mdx | 60 +++---- .../querying/content/_how-to-query-nodejs.mdx | 66 ++++---- .../querying/content/_how-to-query-php.mdx | 54 +++---- .../querying/content/_how-to-query-python.mdx | 56 +++---- .../_how-to-stream-query-results-csharp.mdx | 8 +- .../_how-to-stream-query-results-java.mdx | 6 +- .../_how-to-stream-query-results-nodejs.mdx | 6 +- .../_how-to-work-with-suggestions-csharp.mdx | 2 +- .../_how-to-work-with-suggestions-nodejs.mdx | 2 +- .../_how-to-work-with-suggestions-php.mdx | 2 +- .../_how-to-work-with-suggestions-python.mdx | 2 +- .../content/_sort-query-results-csharp.mdx | 10 +- .../content/_sort-query-results-nodejs.mdx | 10 +- .../content/_sort-query-results-php.mdx | 10 +- .../content/_sort-query-results-python.mdx | 10 +- .../content/_include-explanations-csharp.mdx | 4 +- .../content/_include-explanations-nodejs.mdx | 2 +- .../content/_include-explanations-php.mdx | 2 +- .../content/_include-explanations-python.mdx | 2 +- .../_query-vs-document-query-csharp.mdx | 10 +- .../_query-vs-document-query-nodejs.mdx | 2 +- .../content/_query-vs-document-query-php.mdx | 8 +- .../_query-vs-document-query-python.mdx | 8 +- .../_what-is-document-query-csharp.mdx | 78 ++++----- .../content/_what-is-document-query-java.mdx | 36 ++--- .../_what-is-document-query-nodejs.mdx | 4 +- .../content/_what-is-document-query-php.mdx | 80 +++++----- .../_what-is-document-query-python.mdx | 74 ++++----- .../content/_boost-search-results-csharp.mdx | 2 +- .../content/_boost-search-results-nodejs.mdx | 2 +- .../content/_boost-search-results-php.mdx | 2 +- .../content/_boost-search-results-python.mdx | 2 +- .../content/_ends-with-query-csharp.mdx | 2 +- .../content/_ends-with-query-nodejs.mdx | 2 +- .../content/_ends-with-query-php.mdx | 2 +- .../content/_ends-with-query-python.mdx | 2 +- .../content/_full-text-search-csharp.mdx | 6 +- .../content/_full-text-search-nodejs.mdx | 4 +- .../content/_full-text-search-php.mdx | 4 +- .../content/_full-text-search-python.mdx | 4 +- .../content/_fuzzy-search-csharp.mdx | 2 +- .../content/_fuzzy-search-java.mdx | 2 +- .../content/_fuzzy-search-nodejs.mdx | 2 +- .../_highlight-query-results-csharp.mdx | 4 +- .../_highlight-query-results-nodejs.mdx | 4 +- .../content/_highlight-query-results-php.mdx | 4 +- .../_highlight-query-results-python.mdx | 4 +- .../content/_proximity-search-csharp.mdx | 4 +- .../content/_proximity-search-java.mdx | 2 +- .../content/_proximity-search-nodejs.mdx | 2 +- .../content/_proximity-search-php.mdx | 2 +- .../content/_proximity-search-python.mdx | 2 +- .../session/querying/what-is-rql.mdx | 42 ++--- .../content/_what-is-smuggler-csharp.mdx | 2 +- .../content/_what-is-smuggler-java.mdx | 2 +- .../content/_what-is-smuggler-nodejs.mdx | 2 +- .../client-api-references.mdx | 46 +++--- .../studio-references.mdx | 10 +- .../compare-exchange/configuration.mdx | 2 +- .../content/_atomic-guards-csharp.mdx | 10 +- .../content/_atomic-guards-nodejs.mdx | 10 +- .../content/_atomic-guards-php.mdx | 10 +- .../content/_atomic-guards-python.mdx | 10 +- .../_cmpxchg-in-dynamic-queries-csharp.mdx | 2 +- .../_cmpxchg-in-dynamic-queries-nodejs.mdx | 2 +- .../_cmpxchg-item-expiration-csharp.mdx | 8 +- .../_cmpxchg-item-expiration-nodejs.mdx | 8 +- .../content/_create-cmpxchg-items-csharp.mdx | 6 +- .../content/_create-cmpxchg-items-java.mdx | 6 +- .../content/_create-cmpxchg-items-nodejs.mdx | 6 +- .../content/_create-cmpxchg-items-php.mdx | 4 +- .../content/_create-cmpxchg-items-python.mdx | 4 +- .../content/_delete-cmpxchg-items-csharp.mdx | 6 +- .../content/_delete-cmpxchg-items-java.mdx | 6 +- .../content/_delete-cmpxchg-items-nodejs.mdx | 6 +- .../content/_delete-cmpxchg-items-php.mdx | 6 +- .../content/_delete-cmpxchg-items-python.mdx | 6 +- .../content/_get-cmpxchg-item-csharp.mdx | 4 +- .../content/_get-cmpxchg-item-java.mdx | 4 +- .../content/_get-cmpxchg-item-nodejs.mdx | 4 +- .../content/_get-cmpxchg-item-php.mdx | 4 +- .../content/_get-cmpxchg-item-python.mdx | 4 +- .../content/_get-cmpxchg-items-csharp.mdx | 6 +- .../content/_get-cmpxchg-items-java.mdx | 4 +- .../content/_get-cmpxchg-items-nodejs.mdx | 6 +- .../content/_get-cmpxchg-items-php.mdx | 4 +- .../content/_get-cmpxchg-items-python.mdx | 4 +- ..._include-compare-exchange-items-csharp.mdx | 2 +- ..._include-compare-exchange-items-nodejs.mdx | 2 +- ...ndexing-compare-exchange-values-csharp.mdx | 2 +- ...ndexing-compare-exchange-values-nodejs.mdx | 2 +- .../content/_overview-csharp.mdx | 16 +- .../content/_overview-java.mdx | 14 +- .../content/_overview-php.mdx | 14 +- .../content/_overview-python.mdx | 14 +- .../content/_update-cmpxchg-item-csharp.mdx | 4 +- .../content/_update-cmpxchg-item-java.mdx | 2 +- .../content/_update-cmpxchg-item-nodejs.mdx | 4 +- .../client-api-references.mdx | 2 +- ...ed-documents-and-other-features-csharp.mdx | 26 +-- .../content/_enable-data-archiving-csharp.mdx | 2 +- .../_schedule-document-archiving-csharp.mdx | 4 +- .../content/_unarchiving-documents-csharp.mdx | 8 +- .../version-7.1/data-archival/overview.mdx | 16 +- .../_counters-and-other-features-csharp.mdx | 6 +- .../_counters-and-other-features-java.mdx | 2 +- .../_counters-and-other-features-nodejs.mdx | 6 +- .../_counters-and-other-features-php.mdx | 4 +- .../_counters-and-other-features-python.mdx | 6 +- .../content/_create-or-modify-csharp.mdx | 2 +- .../content/_create-or-modify-java.mdx | 2 +- .../content/_create-or-modify-nodejs.mdx | 2 +- .../content/_create-or-modify-php.mdx | 2 +- .../content/_create-or-modify-python.mdx | 2 +- .../counters/content/_delete-csharp.mdx | 2 +- .../counters/content/_delete-java.mdx | 2 +- .../counters/content/_delete-nodejs.mdx | 2 +- .../counters/content/_delete-php.mdx | 4 +- .../counters/content/_delete-python.mdx | 4 +- .../counters/content/_overview-csharp.mdx | 10 +- .../counters/content/_overview-java.mdx | 10 +- .../counters/content/_overview-nodejs.mdx | 10 +- .../counters/content/_overview-php.mdx | 10 +- .../counters/content/_overview-python.mdx | 10 +- .../_retrieve-counter-values-csharp.mdx | 2 +- .../content/_retrieve-counter-values-java.mdx | 2 +- .../_retrieve-counter-values-nodejs.mdx | 2 +- .../content/_retrieve-counter-values-php.mdx | 2 +- .../_retrieve-counter-values-python.mdx | 2 +- .../counters/counters-in-clusters.mdx | 8 +- .../overview-extensions.mdx | 8 +- .../client-api/content/_overview-csharp.mdx | 22 +-- .../client-api/content/_overview-java.mdx | 32 ++-- .../client-api/content/_overview-nodejs.mdx | 22 +-- .../client-api/content/_overview-php.mdx | 16 +- .../client-api/content/_overview-python.mdx | 16 +- .../content/_configure-revisions-csharp.mdx | 4 +- .../content/_configure-revisions-java.mdx | 2 +- .../content/_configure-revisions-nodejs.mdx | 4 +- .../content/_configure-revisions-php.mdx | 4 +- .../content/_configure-revisions-python.mdx | 4 +- ...onflict-revisions-configuration-csharp.mdx | 4 +- ...onflict-revisions-configuration-nodejs.mdx | 4 +- .../_conflict-revisions-configuration-php.mdx | 4 +- .../content/_delete-revisions-csharp.mdx | 6 +- .../content/_get-revisions-csharp.mdx | 2 +- .../content/_get-revisions-nodejs.mdx | 2 +- .../operations/content/_get-revisions-php.mdx | 2 +- .../content/_get-revisions-python.mdx | 2 +- .../session/content/_including-csharp.mdx | 2 +- .../session/content/_including-nodejs.mdx | 2 +- .../session/content/_including-php.mdx | 2 +- .../revisions/content/_overview-csharp.mdx | 16 +- .../revisions/content/_overview-nodejs.mdx | 16 +- .../revisions/content/_overview-python.mdx | 22 +-- .../_revisions-and-other-features-csharp.mdx | 16 +- .../_revisions-and-other-features-nodejs.mdx | 14 +- .../_revisions-and-other-features-php.mdx | 14 +- .../_revisions-and-other-features-python.mdx | 14 +- ...documents-to-specific-revisions-csharp.mdx | 4 +- .../revert-documents-to-specific-time.mdx | 4 +- .../content/_append-in-bulk-csharp.mdx | 2 +- .../content/_append-in-bulk-nodejs.mdx | 2 +- .../content/_javascript-support-csharp.mdx | 10 +- .../content/_javascript-support-nodejs.mdx | 10 +- .../client-api/content/_overview-csharp.mdx | 30 ++-- .../client-api/content/_overview-nodejs.mdx | 30 ++-- .../content/_append-and-delete-csharp.mdx | 2 +- .../content/_append-and-delete-nodejs.mdx | 2 +- .../operations/content/_get-csharp.mdx | 8 +- .../operations/content/_get-nodejs.mdx | 4 +- .../operations/content/_patch-csharp.mdx | 12 +- .../operations/content/_patch-nodejs.mdx | 12 +- .../session/content/_append-csharp.mdx | 8 +- .../session/content/_append-nodejs.mdx | 8 +- .../session/content/_append-php.mdx | 2 +- .../session/content/_append-python.mdx | 8 +- .../session/content/_delete-csharp.mdx | 2 +- .../session/content/_delete-nodejs.mdx | 2 +- .../session/content/_delete-php.mdx | 2 +- .../session/content/_delete-python.mdx | 2 +- .../session/content/_patch-csharp.mdx | 4 +- .../session/content/_patch-nodejs.mdx | 4 +- .../session/content/_patch-python.mdx | 4 +- .../session/content/_querying-csharp.mdx | 8 +- .../session/content/_querying-nodejs.mdx | 8 +- .../get/content/_get-entries-csharp.mdx | 12 +- .../get/content/_get-entries-nodejs.mdx | 10 +- .../session/get/content/_get-entries-php.mdx | 6 +- .../get/content/_get-entries-python.mdx | 10 +- .../include/content/_overview-csharp.mdx | 6 +- .../include/content/_overview-nodejs.mdx | 6 +- .../timeseries/content/_design-csharp.mdx | 2 +- .../timeseries/content/_design-nodejs.mdx | 2 +- .../timeseries/content/_indexing-csharp.mdx | 6 +- .../timeseries/content/_indexing-nodejs.mdx | 6 +- .../timeseries/content/_indexing-php.mdx | 4 +- .../timeseries/content/_indexing-python.mdx | 6 +- .../content/_rollup-and-retention-csharp.mdx | 6 +- .../content/_rollup-and-retention-nodejs.mdx | 4 +- .../content/_rollup-and-retention-php.mdx | 4 +- .../content/_rollup-and-retention-python.mdx | 4 +- ..._time-series-and-other-features-csharp.mdx | 10 +- ..._time-series-and-other-features-nodejs.mdx | 10 +- .../client-api/javascript-support.mdx | 16 +- .../client-api/operations/get.mdx | 4 +- .../client-api/session/get.mdx | 14 +- .../client-api/session/increment.mdx | 4 +- .../client-api/session/overview.mdx | 16 +- .../incremental-time-series/overview.mdx | 16 +- .../timeseries/overview.mdx | 30 ++-- .../_aggregation-and-projections-csharp.mdx | 6 +- .../_aggregation-and-projections-nodejs.mdx | 6 +- .../_aggregation-and-projections-php.mdx | 4 +- .../content/_choosing-query-range-csharp.mdx | 2 +- .../content/_choosing-query-range-nodejs.mdx | 2 +- .../content/_choosing-query-range-python.mdx | 2 +- .../querying/content/_filtering-csharp.mdx | 10 +- .../querying/content/_filtering-nodejs.mdx | 10 +- .../querying/content/_filtering-php.mdx | 8 +- .../querying/content/_filtering-python.mdx | 8 +- .../querying/content/_gap-filling-csharp.mdx | 2 +- .../querying/content/_gap-filling-java.mdx | 2 +- .../querying/content/_gap-filling-nodejs.mdx | 2 +- .../content/_overview-and-syntax-csharp.mdx | 16 +- .../content/_overview-and-syntax-nodejs.mdx | 14 +- .../content/_overview-and-syntax-php.mdx | 14 +- .../content/_overview-and-syntax-python.mdx | 14 +- .../content/_stream-timeseries-csharp.mdx | 2 +- .../content/_using-indexes-csharp.mdx | 4 +- .../content/_using-indexes-nodejs.mdx | 4 +- .../querying/content/_using-indexes-php.mdx | 4 +- .../content/_using-indexes-python.mdx | 4 +- .../timeseries/querying/statistics.mdx | 4 +- .../version-7.1/glossary/cluster-node.mdx | 2 +- .../version-7.1/glossary/database-group.mdx | 2 +- .../version-7.1/glossary/node-tag.mdx | 4 +- .../version-7.1/glossary/raft-command.mdx | 2 +- .../indexes/additional-assemblies.mdx | 2 +- .../indexes/content/_boosting-java.mdx | 4 +- .../_creating-and-deploying-csharp.mdx | 6 +- .../content/_creating-and-deploying-java.mdx | 6 +- .../_creating-and-deploying-nodejs.mdx | 6 +- .../content/_extending-indexes-csharp.mdx | 2 +- .../content/_extending-indexes-java.mdx | 2 +- .../content/_extending-indexes-nodejs.mdx | 2 +- .../content/_indexing-basics-csharp.mdx | 8 +- .../indexes/content/_indexing-basics-java.mdx | 8 +- .../content/_indexing-basics-nodejs.mdx | 8 +- .../_indexing-linq-extensions-csharp.mdx | 4 +- .../_indexing-linq-extensions-java.mdx | 4 +- .../_indexing-linq-extensions-nodejs.mdx | 4 +- .../content/_indexing-metadata-csharp.mdx | 2 +- .../content/_indexing-metadata-nodejs.mdx | 2 +- .../content/_indexing-metadata-php.mdx | 2 +- .../content/_indexing-metadata-python.mdx | 2 +- .../content/_indexing-nested-data-csharp.mdx | 2 +- .../content/_indexing-nested-data-java.mdx | 2 +- .../content/_indexing-nested-data-nodejs.mdx | 2 +- .../content/_indexing-nested-data-php.mdx | 2 +- .../content/_indexing-nested-data-python.mdx | 2 +- .../_indexing-polymorphic-data-nodejs.mdx | 2 +- .../content/_indexing-spatial-data-csharp.mdx | 2 +- .../content/_indexing-spatial-data-java.mdx | 4 +- .../content/_indexing-spatial-data-nodejs.mdx | 2 +- .../content/_indexing-spatial-data-php.mdx | 2 +- .../content/_indexing-spatial-data-python.mdx | 2 +- .../content/_javascript-indexes-csharp.mdx | 12 +- .../content/_javascript-indexes-java.mdx | 8 +- .../indexes/content/_map-indexes-csharp.mdx | 16 +- .../indexes/content/_map-indexes-java.mdx | 12 +- .../indexes/content/_map-indexes-nodejs.mdx | 12 +- .../indexes/content/_map-indexes-php.mdx | 14 +- .../indexes/content/_map-indexes-python.mdx | 16 +- .../content/_map-reduce-indexes-csharp.mdx | 4 +- .../content/_map-reduce-indexes-java.mdx | 4 +- .../content/_map-reduce-indexes-nodejs.mdx | 4 +- .../content/_map-reduce-indexes-php.mdx | 4 +- .../content/_map-reduce-indexes-python.mdx | 4 +- .../content/_multi-map-indexes-csharp.mdx | 4 +- .../content/_multi-map-indexes-java.mdx | 4 +- .../content/_multi-map-indexes-nodejs.mdx | 4 +- .../content/_multi-map-indexes-php.mdx | 4 +- .../content/_multi-map-indexes-python.mdx | 4 +- .../_number-type-conversion-csharp.mdx | 2 +- .../content/_sorting-and-collation-csharp.mdx | 2 +- .../content/_sorting-and-collation-java.mdx | 2 +- .../content/_storing-data-in-index-csharp.mdx | 14 +- .../content/_storing-data-in-index-java.mdx | 4 +- .../content/_storing-data-in-index-nodejs.mdx | 4 +- .../content/_storing-data-in-index-php.mdx | 4 +- .../content/_storing-data-in-index-python.mdx | 4 +- .../content/_using-analyzers-csharp.mdx | 14 +- .../indexes/content/_using-analyzers-java.mdx | 6 +- .../content/_using-analyzers-nodejs.mdx | 14 +- .../content/_using-dynamic-fields-csharp.mdx | 26 +-- .../content/_using-dynamic-fields-java.mdx | 26 +-- .../content/_using-dynamic-fields-nodejs.mdx | 22 +-- .../content/_using-dynamic-fields-php.mdx | 26 +-- .../content/_using-dynamic-fields-python.mdx | 26 +-- .../content/_what-are-indexes-csharp.mdx | 16 +- .../content/_what-are-indexes-java.mdx | 16 +- .../content/_what-are-indexes-nodejs.mdx | 16 +- .../indexes/content/_what-are-indexes-php.mdx | 16 +- .../content/_what-are-indexes-python.mdx | 16 +- .../indexes/index-administration.mdx | 6 +- .../version-7.1/indexes/index-throttling.mdx | 2 +- .../querying/content/_distinct-csharp.mdx | 6 +- .../querying/content/_distinct-java.mdx | 6 +- .../querying/content/_distinct-nodejs.mdx | 6 +- .../content/_exploration-queries-csharp.mdx | 6 +- .../content/_exploration-queries-nodejs.mdx | 6 +- .../content/_exploration-queries-php.mdx | 6 +- .../content/_exploration-queries-python.mdx | 6 +- .../querying/content/_highlighting-csharp.mdx | 2 +- .../querying/content/_highlighting-nodejs.mdx | 2 +- .../querying/content/_highlighting-php.mdx | 2 +- .../querying/content/_highlighting-python.mdx | 2 +- .../content/_include-explanations-csharp.mdx | 2 +- .../content/_include-explanations-nodejs.mdx | 2 +- .../querying/content/_morelikethis-csharp.mdx | 4 +- .../querying/content/_morelikethis-java.mdx | 4 +- .../querying/content/_morelikethis-nodejs.mdx | 4 +- .../querying/content/_morelikethis-php.mdx | 4 +- .../querying/content/_morelikethis-python.mdx | 4 +- .../querying/content/_paging-csharp.mdx | 6 +- .../indexes/querying/content/_paging-java.mdx | 6 +- .../querying/content/_paging-nodejs.mdx | 6 +- .../indexes/querying/content/_paging-php.mdx | 6 +- .../querying/content/_paging-python.mdx | 6 +- .../querying/content/_projections-csharp.mdx | 4 +- .../querying/content/_projections-java.mdx | 2 +- .../querying/content/_projections-nodejs.mdx | 4 +- .../querying/content/_projections-php.mdx | 2 +- .../querying/content/_projections-python.mdx | 2 +- .../querying/content/_query-index-csharp.mdx | 4 +- .../querying/content/_query-index-java.mdx | 10 +- .../querying/content/_query-index-nodejs.mdx | 4 +- .../querying/content/_query-index-php.mdx | 4 +- .../querying/content/_query-index-python.mdx | 4 +- .../querying/content/_searching-csharp.mdx | 24 +-- .../querying/content/_searching-java.mdx | 4 +- .../querying/content/_searching-nodejs.mdx | 24 +-- .../querying/content/_searching-php.mdx | 8 +- .../querying/content/_searching-python.mdx | 8 +- .../querying/content/_sorting-csharp.mdx | 4 +- .../querying/content/_sorting-java.mdx | 2 +- .../querying/content/_sorting-nodejs.mdx | 4 +- .../indexes/querying/content/_sorting-php.mdx | 4 +- .../querying/content/_sorting-python.mdx | 4 +- .../querying/content/_spatial-csharp.mdx | 2 +- .../querying/content/_spatial-java.mdx | 2 +- .../querying/content/_spatial-nodejs.mdx | 2 +- .../indexes/querying/content/_spatial-php.mdx | 2 +- .../querying/content/_spatial-python.mdx | 2 +- .../querying/content/_suggestions-csharp.mdx | 2 +- .../querying/content/_suggestions-nodejs.mdx | 2 +- .../querying/content/_suggestions-php.mdx | 2 +- .../querying/content/_suggestions-python.mdx | 2 +- .../indexes/rolling-index-deployment.mdx | 4 +- .../indexes/search-engine/corax.mdx | 18 +-- .../events-and-snapshots.mdx | 4 +- .../integrating-with-akka-persistence.mdx | 6 +- .../postgresql-protocol/overview.mdx | 4 +- .../postgresql-protocol/power-bi.mdx | 8 +- .../client-api/client-breaking-changes.mdx | 2 +- .../migration/client-api/client-migration.mdx | 2 +- .../server/server-breaking-changes.mdx | 2 +- .../version-7.1/server/administration/cli.mdx | 2 +- .../monitoring/open-telemetry.mdx | 46 +++--- .../administration/snmp/snmp-overview.mdx | 28 ++-- .../server/clustering/cluster-api.mdx | 2 +- ...luster-best-practice-and-configuration.mdx | 4 +- .../clustering/cluster-transactions.mdx | 18 +-- .../distribution/cluster-observer.mdx | 16 +- .../distribution/distributed-database.mdx | 14 +- .../distribution/highly-available-tasks.mdx | 24 +-- .../server/clustering/overview.mdx | 14 +- .../clustering/rachis/cluster-topology.mdx | 10 +- .../rachis/consensus-operations.mdx | 6 +- .../clustering/rachis/what-is-rachis.mdx | 6 +- .../replication/advanced-replication.mdx | 4 +- .../clustering/replication/change-vector.mdx | 2 +- .../replication-and-embedded-instance.mdx | 10 +- .../replication/replication-conflicts.mdx | 8 +- .../replication/replication-overview.mdx | 10 +- .../ai-integration-configuration.mdx | 2 +- .../configuration/backup-configuration.mdx | 10 +- .../configuration/configuration-options.mdx | 6 +- .../configuration/core-configuration.mdx | 6 +- .../configuration/database-configuration.mdx | 4 +- .../configuration/etl-configuration.mdx | 2 +- .../configuration/indexing-configuration.mdx | 10 +- .../configuration/license-configuration.mdx | 2 +- .../configuration/logs-configuration.mdx | 6 +- .../configuration/memory-configuration.mdx | 2 +- .../queue-sink-configuration.mdx | 4 +- .../configuration/security-configuration.mdx | 6 +- .../configuration/server-configuration.mdx | 2 +- .../configuration/storage-configuration.mdx | 8 +- .../server/content/_embedded-csharp.mdx | 4 +- .../server/content/_embedded-java.mdx | 2 +- .../extensions/content/_refresh-csharp.mdx | 8 +- .../server/kb/javascript-engine.mdx | 12 +- .../server/kb/linux-thread-names.mdx | 2 +- .../server/ongoing-tasks/backup-overview.mdx | 4 +- .../server/ongoing-tasks/etl/basics.mdx | 36 ++--- .../ongoing-tasks/etl/elasticsearch.mdx | 12 +- .../server/ongoing-tasks/etl/olap.mdx | 4 +- .../etl/queue-etl/amazon-sqs.mdx | 6 +- .../etl/queue-etl/azure-queue.mdx | 8 +- .../ongoing-tasks/etl/queue-etl/kafka.mdx | 6 +- .../ongoing-tasks/etl/queue-etl/overview.mdx | 14 +- .../ongoing-tasks/etl/queue-etl/rabbit-mq.mdx | 6 +- .../server/ongoing-tasks/etl/raven.mdx | 10 +- .../server/ongoing-tasks/etl/snowflake.mdx | 2 +- .../server/ongoing-tasks/etl/sql.mdx | 6 +- .../server/ongoing-tasks/etl/test-scripts.mdx | 2 +- .../ongoing-tasks/external-replication.mdx | 12 +- .../ongoing-tasks/hub-sink-replication.mdx | 6 +- .../queue-sink/kafka-queue-sink.mdx | 12 +- .../ongoing-tasks/queue-sink/overview.mdx | 2 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 10 +- .../security/audit-log/audit-log-overview.mdx | 16 +- .../certificate-configuration.mdx | 16 +- .../authentication/certificate-management.mdx | 56 +++---- .../certificate-renewal-and-rotation.mdx | 4 +- .../client-certificate-usage.mdx | 2 +- .../lets-encrypt-certificates.mdx | 10 +- .../recover-from-expired-certificate.mdx | 12 +- ...olve-cluster-certificate-renewal-issue.mdx | 2 +- .../security-clearance-and-permissions.mdx | 2 +- .../server/security/common-errors-and-faq.mdx | 22 +-- .../encryption/database-encryption.mdx | 4 +- .../encryption/encryption-at-rest.mdx | 8 +- .../encryption/secret-key-management.mdx | 2 +- .../encryption/server-store-encryption.mdx | 8 +- .../version-7.1/server/security/overview.mdx | 24 +-- .../content/_documents-compression-csharp.mdx | 2 +- .../content/_documents-compression-nodejs.mdx | 2 +- ...customizing-raven-data-files-locations.mdx | 22 +-- .../server/storage/directory-structure.mdx | 2 +- .../version-7.1/server/tcp-compression.mdx | 10 +- .../server/troubleshooting/collect-info.mdx | 14 +- .../server/troubleshooting/logging.mdx | 36 ++--- .../server/troubleshooting/traffic-watch.mdx | 18 +-- .../administration/anchoring-documents.mdx | 4 +- .../sharding/administration/api-admin.mdx | 2 +- .../administration/sharding-by-prefix.mdx | 10 +- .../sharding/administration/studio-admin.mdx | 10 +- .../sharding/backup-and-restore/backup.mdx | 12 +- .../sharding/backup-and-restore/restore.mdx | 8 +- .../sharding/document-extensions.mdx | 4 +- versioned_docs/version-7.1/sharding/etl.mdx | 10 +- .../sharding/external-replication.mdx | 8 +- .../sharding/import-and-export.mdx | 6 +- .../version-7.1/sharding/indexing.mdx | 8 +- .../version-7.1/sharding/migration.mdx | 24 +-- .../version-7.1/sharding/overview.mdx | 22 +-- .../version-7.1/sharding/querying.mdx | 12 +- .../version-7.1/sharding/resharding.mdx | 14 +- .../version-7.1/sharding/subscriptions.mdx | 4 +- .../version-7.1/sharding/unsupported.mdx | 16 +- .../version-7.1/start/getting-started.mdx | 12 +- .../start/guides/aws-lambda/deployment.mdx | 2 +- .../guides/aws-lambda/existing-project.mdx | 6 +- .../content/_existing-project-csharp.mdx | 2 +- .../content/_existing-project-nodejs.mdx | 2 +- .../deployment-considerations.mdx | 2 +- .../start/installation/gnu-linux/deb.mdx | 2 +- .../version-7.1/start/installation/manual.mdx | 2 +- .../start/installation/running-as-service.mdx | 6 +- .../setup-examples/aws-linux-vm.mdx | 8 +- .../setup-examples/aws-windows-vm.mdx | 8 +- .../setup-wizard/additional-settings.mdx | 14 +- .../setup-wizard/choose-security-option.mdx | 18 +-- .../setup-wizard/choose-setup-method.mdx | 62 ++++---- .../setup-wizard/configure-node-addresses.mdx | 18 +-- .../setup-wizard/finish-setup.mdx | 16 +- .../installation/setup-wizard/overview.mdx | 6 +- .../setup-wizard/provide-license-key.mdx | 12 +- .../setup-wizard/review-setup.mdx | 6 +- .../setup-wizard/use-setup-package.mdx | 8 +- .../installation/system-requirements.mdx | 4 +- .../installation/upgrading-to-new-version.mdx | 2 +- .../start/licensing/force-update.mdx | 8 +- .../start/licensing/licensing-faq.mdx | 2 +- .../start/licensing/licensing-overview.mdx | 6 +- .../start/licensing/renew-license.mdx | 6 +- .../cluster-dashboard-overview.mdx | 4 +- .../cluster-dashboard-widgets.mdx | 6 +- .../studio/cluster/cluster-view.mdx | 12 +- .../studio/cluster/setting-a-cluster.mdx | 2 +- .../studio/database/code-assistance.mdx | 12 +- .../create-new-database/from-backup.mdx | 8 +- .../create-new-database/from-legacy-files.mdx | 4 +- .../create-new-database/general-flow.mdx | 6 +- .../studio/database/databases-list-view.mdx | 8 +- .../revisions/all-revisions.mdx | 14 +- .../revisions/revisions-bin.mdx | 10 +- .../revisions/revisions-overview.mdx | 8 +- .../document-extensions/time-series.mdx | 6 +- .../database/documents/conflicts-view.mdx | 2 +- .../documents/create-new-document.mdx | 2 +- .../database/documents/document-view.mdx | 6 +- .../documents/documents-and-collections.mdx | 6 +- .../studio/database/documents/patch-view.mdx | 2 +- .../database/indexes/create-map-index.mdx | 4 +- .../indexes/create-map-reduce-index.mdx | 6 +- .../indexes/create-multi-map-index.mdx | 10 +- .../studio/database/indexes/index-history.mdx | 4 +- .../database/indexes/indexes-list-view.mdx | 8 +- .../database/indexes/indexes-overview.mdx | 18 +-- .../database/indexes/indexing-performance.mdx | 14 +- .../studio/database/queries/query-view.mdx | 12 +- .../client-configuration-per-database.mdx | 4 +- .../database/settings/conflict-resolution.mdx | 2 +- .../database/settings/custom-analyzers.mdx | 2 +- .../database/settings/database-record.mdx | 26 +-- .../database/settings/database-settings.mdx | 4 +- .../database/settings/document-revisions.mdx | 2 +- .../settings/documents-compression.mdx | 2 +- .../settings/manage-database-group.mdx | 12 +- .../settings/studio-configuration.mdx | 14 +- .../external-replication-stats.mdx | 2 +- .../ongoing-tasks-stats/olap-etl-stats.mdx | 2 +- .../ongoing-tasks-stats/ravendb-etl-stats.mdx | 2 +- .../subscription-stats.mdx | 6 +- .../studio/database/stats/storage-report.mdx | 2 +- .../studio/database/tasks/backup-task.mdx | 20 +-- .../database/tasks/create-sample-data.mdx | 14 +- .../studio/database/tasks/export-database.mdx | 6 +- .../tasks/import-data/import-data-file.mdx | 22 +-- .../tasks/import-data/import-from-other.mdx | 2 +- .../tasks/import-data/import-from-ravendb.mdx | 16 +- .../tasks/ongoing-tasks/amazon-sqs-etl.mdx | 4 +- .../ongoing-tasks/azure-queue-storage-etl.mdx | 4 +- .../ongoing-tasks/elasticsearch-etl-task.mdx | 4 +- .../external-replication-task.mdx | 18 +-- .../tasks/ongoing-tasks/general-info.mdx | 26 +-- .../hub-sink-replication/overview.mdx | 6 +- .../replication-hub-task.mdx | 4 +- .../replication-sink-task.mdx | 4 +- .../tasks/ongoing-tasks/kafka-etl-task.mdx | 4 +- .../tasks/ongoing-tasks/kafka-queue-sink.mdx | 8 +- .../tasks/ongoing-tasks/rabbitmq-etl-task.mdx | 4 +- .../ongoing-tasks/rabbitmq-queue-sink.mdx | 6 +- .../tasks/ongoing-tasks/ravendb-etl-task.mdx | 10 +- .../ongoing-tasks/snowflake-etl-task.mdx | 4 +- .../version-7.1/studio/overview.mdx | 30 ++-- .../certificates/read-only-access-level.mdx | 4 +- .../studio/server/client-configuration.mdx | 2 +- .../debug/advanced/cluster-observer.mdx | 8 +- .../studio/server/manage-server.mdx | 24 +-- .../studio/server/server-settings.mdx | 2 +- .../studio/server/server-wide-backup.mdx | 16 +- 2757 files changed, 11836 insertions(+), 11836 deletions(-) diff --git a/cloud/cloud-api.mdx b/cloud/cloud-api.mdx index 03f89e9057..657b29859c 100644 --- a/cloud/cloud-api.mdx +++ b/cloud/cloud-api.mdx @@ -62,7 +62,7 @@ RavenDB Cloud does not send reminders about upcoming API key expiration. You can change the expiration date or extend it for another *12 months*. -For more details, please check the [Edit API Key](../cloud/portal/cloud-portal-api-tab.mdx#edit-api-key) section. +For more details, please check the [Edit API Key](./portal/cloud-portal-api-tab.mdx#edit-api-key) section. diff --git a/cloud/cloud-aws-marketplace.mdx b/cloud/cloud-aws-marketplace.mdx index 7c3fd387f4..99d6f75782 100644 --- a/cloud/cloud-aws-marketplace.mdx +++ b/cloud/cloud-aws-marketplace.mdx @@ -43,7 +43,7 @@ Countries and regions outside this list do not currently have automated tax hand If your country is not listed below, you can still use *RavenDB Cloud* by signing up directly at [cloud.ravendb.net](https://cloud.ravendb.net) and paying via credit card or wire transfer. -See [Pricing, Payment and Billing](../cloud/cloud-pricing-payment-billing.mdx) for more details. +See [Pricing, Payment and Billing](./cloud-pricing-payment-billing.mdx) for more details. The following countries and regions are currently supported: diff --git a/cloud/cloud-backup-and-restore.mdx b/cloud/cloud-backup-and-restore.mdx index a741f1f789..137b13887d 100644 --- a/cloud/cloud-backup-and-restore.mdx +++ b/cloud/cloud-backup-and-restore.mdx @@ -15,12 +15,12 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Cloud: Backup And Restore -* RavenDB cloud instances of the [Free](../cloud/cloud-instances.mdx#a-free-cloud-node) and - [Production](../cloud/cloud-instances.mdx#a-production-cloud-cluster) tiers are regularly and automatically backed up. +* RavenDB cloud instances of the [Free](./cloud-instances.mdx#a-free-cloud-node) and + [Production](./cloud-instances.mdx#a-production-cloud-cluster) tiers are regularly and automatically backed up. * You can also define custom backup tasks, as you would with an on-premises RavenDB server. -* [Development](../cloud/cloud-instances.mdx#a-development-cloud-server) products do **not** offer mandatory backup by RavenDB Cloud. +* [Development](./cloud-instances.mdx#a-development-cloud-server) products do **not** offer mandatory backup by RavenDB Cloud. You **can** define custom backup tasks for them. * In this page: @@ -45,7 +45,7 @@ The mandatory backup process cannot be disabled. We keep your backup files for no less than 14 days. -You can [contact support](../cloud/portal/cloud-portal-support-tab.mdx) to prolong this period, but not reduce it. +You can [contact support](./portal/cloud-portal-support-tab.mdx) to prolong this period, but not reduce it. #### The Backup Task @@ -94,7 +94,7 @@ of resources during the backup run. Upgrade your product tier to resolve the iss -See [Tiers and Instances](../cloud/cloud-instances.mdx) for a full comparison of available tiers +See [Tiers and Instances](./cloud-instances.mdx) for a full comparison of available tiers and their resource allocations. diff --git a/cloud/cloud-instances.mdx b/cloud/cloud-instances.mdx index 16e334a6af..dfd688d155 100644 --- a/cloud/cloud-instances.mdx +++ b/cloud/cloud-instances.mdx @@ -16,13 +16,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; -- Use your portal's [Products tab](../cloud/portal/cloud-portal-products-tab.mdx) to raise or modify +- Use your portal's [Products tab](./portal/cloud-portal-products-tab.mdx) to raise or modify a Free node, a Development node, a Production cluster, or a Serverless product. - Free and Development nodes, as well as Production "basic" grade clusters, are operated by -[burstable instances](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters). +[burstable instances](./cloud-overview.mdx#burstable-vs-reserved-clusters). - The Production cluster grades [Standard](#standard-grade-production-cluster) and [Performance](#performance-grade-production-cluster) are -[Reserved clusters](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters). +[Reserved clusters](./cloud-overview.mdx#burstable-vs-reserved-clusters). In this page: @@ -41,9 +41,9 @@ In this page: Free RavenDB cloud nodes are great for experiments and evaluation. They are equipped with the most basic configuration and capabilities. They have a single node and no Service-Level Agreement (SLA). -You can run only one free node per [account](../cloud/cloud-overview.mdx#your-account). +You can run only one free node per [account](./cloud-overview.mdx#your-account). -To raise a free cloud node, use the [Products tab](../cloud/portal/cloud-portal-products-tab.mdx) +To raise a free cloud node, use the [Products tab](./portal/cloud-portal-products-tab.mdx) to create a **free**-tier instance. !["Tiers and Instances: Free"](./assets/tiers-and-instances-001-free.png) @@ -67,9 +67,9 @@ A development server is equipped with all of RavenDB's [features](https://ravend but is **not** suitable for production for the following reasons: * A single-node configuration (no [replication](../7.2/server/clustering/replication/replication-overview)). -* [Burstable](../cloud/cloud-overview.mdx#burstable-instances) CPU usage, suitable for small to medium production loads. +* [Burstable](./cloud-overview.mdx#burstable-instances) CPU usage, suitable for small to medium production loads. Burstable instances can become throttled if usage exceeds allocated resources. -* Lack of [backup](../cloud/cloud-backup-and-restore.mdx#cloud-backup) procedure. +* Lack of [backup](./cloud-backup-and-restore.mdx#cloud-backup) procedure. * No [Service Level Agreement](../cloud/cloud-support#available-support-options). To raise a cloud Development server, create a product using the Products tab and select the **Development** tier. @@ -109,7 +109,7 @@ with a **higher number of nodes** to further distribute the cluster's workload. [Contact Support](https://ravendb.net/contact) to provision customized cloud-based clusters with configurations that suit your needs. -*Production tier* clusters can be also extended by [additional product nodes](../cloud/portal/cloud-portal-products-tab.mdx#nodes-additional-product-nodes). +*Production tier* clusters can be also extended by [additional product nodes](./portal/cloud-portal-products-tab.mdx#nodes-additional-product-nodes). This option is not available for **PS** instance types. @@ -131,21 +131,21 @@ The production tier offers three instance levels: The tier you select must have sufficient compute, memory, and disk resources to run backups on top of your normal workload. Undersized tiers can cause backup jobs to fail. -See [Tier Requirements and Failure Disclaimer](../cloud/cloud-backup-and-restore.mdx#tier-requirements-and-failure-disclaimer) +See [Tier Requirements and Failure Disclaimer](./cloud-backup-and-restore.mdx#tier-requirements-and-failure-disclaimer) for details. #### 1. Basic-grade Production Cluster -Basic production clusters are [burstable](../cloud/cloud-overview.mdx#burstable-instances). +Basic production clusters are [burstable](./cloud-overview.mdx#burstable-instances). While suitable for low to medium workloads, they trade-off peak efficiency for lower costs. - If burstable instances use more than their allocated budget, they can become [throttled](../cloud/cloud-overview.mdx#budget-credits-and-throttling). + If burstable instances use more than their allocated budget, they can become [throttled](./cloud-overview.mdx#budget-credits-and-throttling). !["Production: Basic"](./assets/tiers-and-instances-0031-production-basic.png) #### 2. Standard-grade Production Cluster -The resources of standard production clusters are [reserved](../cloud/cloud-overview.mdx#reserved-clusters). +The resources of standard production clusters are [reserved](./cloud-overview.mdx#reserved-clusters). The cluster can utilize them at all times, and is equipped to handle constant production load. Use the slide-bars to select your Standard Production cluster's configuration and storage. @@ -168,7 +168,7 @@ high I/O latencies, RavenDB will alert you to the issue so you can upgrade the t number of IOPS reserved for your instances. #### 3. Performance-grade Production Cluster -Performance tier cluster are special [reserved](../cloud/cloud-overview.mdx#reserved-clusters) production clusters featuring high-throughput and low latency with a directly mapped local NVMe storage. When multiple NVME disks are available, in order to achieve the best possible throughput and to get as many IOPS as possible, multiple NVME volumes are striped together with RAID0. +Performance tier cluster are special [reserved](./cloud-overview.mdx#reserved-clusters) production clusters featuring high-throughput and low latency with a directly mapped local NVMe storage. When multiple NVME disks are available, in order to achieve the best possible throughput and to get as many IOPS as possible, multiple NVME volumes are striped together with RAID0. **Scaling up and ephemeral drives** @@ -209,7 +209,7 @@ Serverless is available on **On-Demand** billing only. It is not available for y For instructions on how to create a Serverless product, see -[Provisioning a New Product](../cloud/portal/cloud-portal-products-tab.mdx#provisioning-a-new-product). +[Provisioning a New Product](./portal/cloud-portal-products-tab.mdx#provisioning-a-new-product). !["Serverless Product Details"](./portal/assets/portal-product-details-serverless.png) @@ -229,5 +229,5 @@ The billing period closes on the **25th of each month (UTC)**. ### Switching to Regular Deployment For instructions on how to convert a Serverless product to a regular deployment, see -[Maintenance and Danger Zones](../cloud/portal/cloud-portal-products-tab.mdx#maintenance-and-danger-zones). +[Maintenance and Danger Zones](./portal/cloud-portal-products-tab.mdx#maintenance-and-danger-zones). diff --git a/cloud/cloud-microsoft-azure-marketplace.mdx b/cloud/cloud-microsoft-azure-marketplace.mdx index 8042587bf7..a596ce4016 100644 --- a/cloud/cloud-microsoft-azure-marketplace.mdx +++ b/cloud/cloud-microsoft-azure-marketplace.mdx @@ -44,7 +44,7 @@ Countries and regions outside this list do not currently have automated tax hand If your country is not listed below, you can still use *RavenDB Cloud* by signing up directly at [cloud.ravendb.net](https://cloud.ravendb.net) and paying via credit card or wire transfer. -See [Pricing, Payment and Billing](../cloud/cloud-pricing-payment-billing.mdx) for more details. +See [Pricing, Payment and Billing](./cloud-pricing-payment-billing.mdx) for more details. The following countries and regions are currently supported: diff --git a/cloud/cloud-migration.mdx b/cloud/cloud-migration.mdx index c02cffeece..2d93cfde50 100644 --- a/cloud/cloud-migration.mdx +++ b/cloud/cloud-migration.mdx @@ -30,10 +30,10 @@ You can easily migrate your database using the [import data from RavenDB](../7.2 In order to do so, the **source server** needs to have the **destination server's cluster certificate**. Open the [Management Studio](../7.2/studio/overview) of each server. -Each server's Studio is available in the [Portal](../cloud/portal/cloud-portal.mdx#cloud-portal)'s -[Product tab](../cloud/portal/cloud-portal-products-tab.mdx#cloud-account-portal-products). +Each server's Studio is available in the [Portal](./portal/cloud-portal.mdx#cloud-portal)'s +[Product tab](./portal/cloud-portal-products-tab.mdx#cloud-account-portal-products). -Learn how to [install the certificate and access RavenDB Cloud Studio](../cloud/cloud-overview.mdx#ravendb-studio---graphic-user-interface) if this is your first time using Cloud Studio. +Learn how to [install the certificate and access RavenDB Cloud Studio](./cloud-overview.mdx#ravendb-studio---graphic-user-interface) if this is your first time using Cloud Studio. If you have already installed the certificate and accessed Studio, click the URLs in the Products tab to open a Studio GUI for each node. diff --git a/cloud/cloud-overview.mdx b/cloud/cloud-overview.mdx index f1e055f1d0..46f485bae9 100644 --- a/cloud/cloud-overview.mdx +++ b/cloud/cloud-overview.mdx @@ -21,7 +21,7 @@ like adding or removing nodes, and run recurring tasks like backing up your data * **Our and your administration** Ridding you of administrative chores that don't require your attention is complemented by providing you with - comfortable control over your data and database management via your account's [Portal](../cloud/portal/cloud-portal.mdx) + comfortable control over your data and database management via your account's [Portal](./portal/cloud-portal.mdx) and the cloud version of our [Studio](../7.2/studio/overview) management GUI. * **Resources** @@ -52,18 +52,18 @@ Some of the key reasons for running RavenDB on the cloud are - * The high availability of a cloud service. * The constant monitoring and healthcare of your products and their accommodating equipment. * Your insulation from the cloud infrastructure's administration as we handle and continuously optimize it. -* The high [security](../cloud/cloud-security.mdx) level. -* Regular [backups](../cloud/cloud-backup-and-restore.mdx) to your database and settings. -* Our [support](../cloud/portal/cloud-portal-support-tab.mdx). +* The high [security](./cloud-security.mdx) level. +* Regular [backups](./cloud-backup-and-restore.mdx) to your database and settings. +* Our [support](./portal/cloud-portal-support-tab.mdx). ## Your Account Your cloud-RavenDB account gathers your products' information, your details, and your contracts and -billing data. We create your account and send you a link to its [Portal](../cloud/portal/cloud-portal.mdx) +billing data. We create your account and send you a link to its [Portal](./portal/cloud-portal.mdx) as soon as you finish registering, so you can immediately start creating and handling your -[cloud products](../cloud/portal/cloud-portal-products-tab.mdx). +[cloud products](./portal/cloud-portal-products-tab.mdx). ## Register Your Account @@ -149,7 +149,7 @@ You can sign in either with a **magic link** sent to your email, or by using you - We advise you to enable 2FA. Setup is described [here](../cloud/cloud-security.mdx#enable-mfa). + We advise you to enable 2FA. Setup is described [here](./cloud-security.mdx#enable-mfa). #### Login with GitHub or Google @@ -206,7 +206,7 @@ while those of a higher-grade production cluster are [reserved](#reserved-cluste ## RavenDB Tiers There are three types of RavenDB cloud products. They are explained in detail in the -[Tiers and Instances ](../cloud/cloud-instances.mdx) section, in the meantime - here are +[Tiers and Instances ](./cloud-instances.mdx) section, in the meantime - here are a few words about each. #### The Free Tier This tier offers a single product: a single-node RavenDB cloud server designated for experiments and evaluation. @@ -226,8 +226,8 @@ HW selection or a multi-region cluster. | **Tier** | **Sub-tiers** | **CPU** | **Options** | **SLA** | | -- | -- | -- | -- | -- | | Free | - | Very low | None | No | -| Development | Dev10-Dev70 | Very low - High | All | [Yes](../cloud/portal/cloud-portal-support-tab.mdx#support-entitlement) | -| Production | **By CPU Priority** (Basic/Standard/Performance)
**By Cluster Size**| Up to extra performance, high network and reserved NVMe | All | [Yes](../cloud/portal/cloud-portal-support-tab.mdx#support-entitlement) | +| Development | Dev10-Dev70 | Very low - High | All | [Yes](./portal/cloud-portal-support-tab.mdx#support-entitlement) | +| Production | **By CPU Priority** (Basic/Standard/Performance)
**By Cluster Size**| Up to extra performance, high network and reserved NVMe | All | [Yes](./portal/cloud-portal-support-tab.mdx#support-entitlement) | ## Burstable vs. Reserved clusters @@ -265,7 +265,7 @@ Credits are **consumed** when the instance uses computing and I/O resources, and * **Burstable CLUSTERS and throttling** - [Basic-grade production clusters](../cloud/cloud-instances.mdx#basic-grade-production-cluster) are burstable: each node of such a cluster + [Basic-grade production clusters](./cloud-instances.mdx#basic-grade-production-cluster) are burstable: each node of such a cluster is accommodated by a burstable instance. When the budget of a burstable cluster is drained or nearly so, the cluster automatically shifts the workload to cluster nodes that still have credits to work with. @@ -274,7 +274,7 @@ Credits are **consumed** when the instance uses computing and I/O resources, and **Use a suitable configuration**. The stronger your burstable instances are, the less susceptible they are to budget drainage and throttling. -If you are regularly warned or your product is actually throttled, consider [upscaling](../cloud/cloud-scaling.mdx) its configuration. +If you are regularly warned or your product is actually throttled, consider [upscaling](./cloud-scaling.mdx) its configuration. #### Throttling Warnings Your instances will warn you when their credits are about to finish, and inform you when throttling is performed. @@ -334,7 +334,7 @@ RavenDB provides a built-in [GUI to monitor and manage](../7.2/studio/overview) * Manage documents and their extensions. * Adjust settings. * Occasionally, cloud instance settings are different than general RavenDB defaults. - See [cloud-specific settings](../cloud/cloud-settings.mdx). + See [cloud-specific settings](./cloud-settings.mdx). diff --git a/cloud/cloud-pricing-payment-billing.mdx b/cloud/cloud-pricing-payment-billing.mdx index 8be2d2b58a..90915aa14d 100644 --- a/cloud/cloud-pricing-payment-billing.mdx +++ b/cloud/cloud-pricing-payment-billing.mdx @@ -84,11 +84,11 @@ Committing for a year and **paying for it all in advance**, grants you a **10% d ![Yearly Upfront](./assets/pricing-004-payment-models-yearly-upfront.png) -Yearly contracts are relevant only for [production products](../cloud/cloud-instances.mdx#a-production-cloud-cluster). -[Development products](../cloud/cloud-instances.mdx#a-development-cloud-server) can only use the on-demand model. +Yearly contracts are relevant only for [production products](./cloud-instances.mdx#a-production-cloud-cluster). +[Development products](./cloud-instances.mdx#a-development-cloud-server) can only use the on-demand model. #### Viewing current configuration price -While [provisioning or editing](../cloud/portal/cloud-portal-products-tab.mdx) your product, +While [provisioning or editing](./portal/cloud-portal-products-tab.mdx) your product, costs are shown in the **Your Order** slot. The overall price is an outcome of your hardware configuration and pricing model, @@ -102,7 +102,7 @@ See for example the price differences between the production basic-grade configu * Production Basic 20: ![PB30](./assets/pricing-001-PB30.png) -You will also be able to find your products' costs in the [Billing & Costs tab](../cloud/portal/cloud-portal-billing-tab.mdx). +You will also be able to find your products' costs in the [Billing & Costs tab](./portal/cloud-portal-billing-tab.mdx). #### Additional Expenses Your pricing model does **not** cover incidental expenses over - @@ -131,7 +131,7 @@ Your pricing model does **not** cover incidental expenses over - You can currently pay by credit card or wire transfer. #### Credit Card You can provide your credit card details while creating your account, or skip this stage and return to it later. -To provide your credit card details at any time, enter your [Account tab](../cloud/portal/cloud-portal-account-tab.mdx) +To provide your credit card details at any time, enter your [Account tab](./portal/cloud-portal-account-tab.mdx) and click the Add Credit Card button. Select your main credit card using the **Active** button, so we know which card to try first. If charging your active card fails, we'll try to charge other cards you may have provided. @@ -143,7 +143,7 @@ Approach our Support personnel to use wire transfer or purchase order. ## Billing -Your Portal's [Billing & Costs tab](../cloud/portal/cloud-portal-billing-tab.mdx) summarizes your +Your Portal's [Billing & Costs tab](./portal/cloud-portal-billing-tab.mdx) summarizes your outstanding charges and past invoices. Additional data you can see there includes Daily cost, Total cost, and the expected charge at the end of this month. #### Charging failures diff --git a/cloud/cloud-scaling.mdx b/cloud/cloud-scaling.mdx index 7e55fd4c89..5648aea58f 100644 --- a/cloud/cloud-scaling.mdx +++ b/cloud/cloud-scaling.mdx @@ -15,10 +15,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Cloud: Scaling -After a RavenDB [Cloud instance](../cloud/cloud-instances.mdx) has been set up, you can **scale it** up and down to modify the +After a RavenDB [Cloud instance](./cloud-instances.mdx) has been set up, you can **scale it** up and down to modify the workload it can handle. -Instances of the [Development Tier](../cloud/cloud-instances.mdx#a-development-cloud-server) and [Production Tier](../cloud/cloud-instances.mdx#a-production-cloud-cluster) can be scaled up or down **within their own Tier**. +Instances of the [Development Tier](./cloud-instances.mdx#a-development-cloud-server) and [Production Tier](./cloud-instances.mdx#a-production-cloud-cluster) can be scaled up or down **within their own Tier**. Instance cannot be moved between Tiers, but data can be [migrated](cloud-migration) between any two RavenDB instances using: - [Import/Export](cloud-migration#import-from-live-ravendb-instance) @@ -35,7 +35,7 @@ two RavenDB instances using: ## Scaling Up/Down - General -To scale a RavenDB Cloud instance, open your [portal](../cloud/portal/cloud-portal.mdx)'s [Products tab](../cloud/portal/cloud-portal-products-tab.mdx) +To scale a RavenDB Cloud instance, open your [portal](./portal/cloud-portal.mdx)'s [Products tab](./portal/cloud-portal-products-tab.mdx) and click the **Manage** button for the product you want to change. ![Manage product](./assets/portal-product-list-manage-button.png) @@ -43,9 +43,9 @@ and click the **Manage** button for the product you want to change. In the main section, you can find controls to **Change Instance Type** or **Change Storage**. -The scaling buttons are presented only for [Development](../cloud/cloud-instances.mdx#a-development-cloud-server) and -[Production](../cloud/cloud-instances.mdx#a-production-cloud-cluster) products. -The [Free](../cloud/cloud-instances.mdx#a-free-cloud-node) product doesn't show them because its Tier includes only one configuration. +The scaling buttons are presented only for [Development](./cloud-instances.mdx#a-development-cloud-server) and +[Production](./cloud-instances.mdx#a-production-cloud-cluster) products. +The [Free](./cloud-instances.mdx#a-free-cloud-node) product doesn't show them because its Tier includes only one configuration. ![Scaling buttons](./assets/portal-product-edit-storage-and-instance-type-area.png) @@ -54,9 +54,9 @@ The [Free](../cloud/cloud-instances.mdx#a-free-cloud-node) product doesn't show **2.** Click [Change Storage](#scaling---change-storage) to modify your product's storage parameters. -Scaling a [Development](../cloud/cloud-instances.mdx#a-development-cloud-server) product **brings it down** +Scaling a [Development](./cloud-instances.mdx#a-development-cloud-server) product **brings it down** temporarily, while its single-node instance is being reconfigured. -Scaling a [Production](../cloud/cloud-instances.mdx#a-production-cloud-cluster) product does **not** bring it down, +Scaling a [Production](./cloud-instances.mdx#a-production-cloud-cluster) product does **not** bring it down, because it is a multi-node cluster and the nodes are updated in a **rolling update** - one node at a time. @@ -177,7 +177,7 @@ There are two ways to start using **Premium SSD v2**: 2. **Upgrade an existing Premium Single Data disk to Premium SSD v2** — if your product already runs on a **Premium** *Single Data Disk* and is eligible, the **Upgrade to Premium V2** button is shown in the *Storage* section of the product page. See - [Managing an Existing Product](../cloud/portal/cloud-portal-products-tab.mdx#change-instance-type-and-storage) + [Managing an Existing Product](./portal/cloud-portal-products-tab.mdx#change-instance-type-and-storage) in the portal documentation. !["Figure - Upgrade to Azure Premium SSD v2 modal with IOPS and Throughput fields"](./assets/portal-product-details-upgrade-to-premium-v2-modal.png) diff --git a/cloud/cloud-security.mdx b/cloud/cloud-security.mdx index 2765583c4a..c59bd3769c 100644 --- a/cloud/cloud-security.mdx +++ b/cloud/cloud-security.mdx @@ -40,7 +40,7 @@ The certificate will be automatically regenerated **30 days** before its expirat #### Download certificate -Go to the [Products tab](../cloud/portal/cloud-portal-products-tab.mdx) in the cloud [portal](../cloud/portal/cloud-portal.mdx) +Go to the [Products tab](./portal/cloud-portal-products-tab.mdx) in the cloud [portal](./portal/cloud-portal.mdx) and click the **Download Certificate** button. !["Download Certificate"](./assets/security-001-download-certificate.png) @@ -93,15 +93,15 @@ Cross-instance communication **inside the cluster** is **not** subject to these Your initial [operator-level](../7.2/server/security/authorization/security-clearance-and-permissions#operator) certificate allows you to perform operations like creating and deleting databases, managing access to the cluster, and inspecting the cluster's state. -Operations like adding and removing cluster nodes are left for your [products administrators](../cloud/cloud-overview.mdx#ravendb-on-the-cloud-overview). +Operations like adding and removing cluster nodes are left for your [products administrators](./cloud-overview.mdx#ravendb-on-the-cloud-overview). We recommend that you generate and use **different certificates** for your client applications, for maximum security. -If your instance runs on a [burstable CPU](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters), especially if it is a low-end one, -RavenDB may take a while to generate certificates and spend a lot of your [CPU credits](../cloud/cloud-overview.mdx#budget-credits-and-throttling) in the +If your instance runs on a [burstable CPU](./cloud-overview.mdx#burstable-vs-reserved-clusters), especially if it is a low-end one, +RavenDB may take a while to generate certificates and spend a lot of your [CPU credits](./cloud-overview.mdx#budget-credits-and-throttling) in the process. We therefore recommend that you generate your certificates off-cloud and import them to your cloud instance. diff --git a/cloud/cloud-settings.mdx b/cloud/cloud-settings.mdx index ab304aa2f4..52d0191f3e 100644 --- a/cloud/cloud-settings.mdx +++ b/cloud/cloud-settings.mdx @@ -35,7 +35,7 @@ If you want to change configurations for cloud instances, they must be set in St * [Database Configurations](../7.2/studio/database/settings/database-settings) * [Indexing Configurations](../7.2/studio/database/indexes/create-map-index#configuration) -To learn how to access the RavenDB Cloud Studio interface, see the [Studio section in the Cloud Overview](../cloud/cloud-overview.mdx#ravendb-studio---graphic-user-interface) article. +To learn how to access the RavenDB Cloud Studio interface, see the [Studio section in the Cloud Overview](./cloud-overview.mdx#ravendb-studio---graphic-user-interface) article. @@ -59,7 +59,7 @@ The factors to consider when adjusting the max indexing batch size: * [Size of documents](https://ravendb.net/articles/dealing-with-large-documents-100-mb#:~:text=RavenDB%20can%20handle%20large%20documents,isn't%20a%20practical%20one.) * [The Complexity of calculations](../7.2/studio/database/indexes/indexing-performance#common-indexing-issues) that static indexes do. -* [IOPS](../cloud/cloud-scaling.mdx#change-storage) - Input/Output Operations Per Second +* [IOPS](./cloud-scaling.mdx#change-storage) - Input/Output Operations Per Second #### Cloud Indexing Batch Size RavenDB Cloud sets batch sizes with the following default formula: diff --git a/cloud/portal/cloud-portal-account-tab.mdx b/cloud/portal/cloud-portal-account-tab.mdx index 094fb9bdfa..c103117e2e 100644 --- a/cloud/portal/cloud-portal-account-tab.mdx +++ b/cloud/portal/cloud-portal-account-tab.mdx @@ -56,7 +56,7 @@ Users with the **Account with User Management role** can modify the roles of oth Only the **Account Owner** can modify the roles of users who have the **Account with User Management** role, or assign/remove that specific role. The **Account Owner** can modify any role for any user. -You can read more about *account roles* in the [Account](../../cloud/cloud-account.mdx#account-roles) page. +You can read more about *account roles* in the [Account](../cloud-account.mdx#account-roles) page. !["Account Tab - User management"](./assets/portal-account-tab-user-management-overview.png) diff --git a/cloud/portal/cloud-portal-api-tab.mdx b/cloud/portal/cloud-portal-api-tab.mdx index c8dd4a244a..b20e3678db 100644 --- a/cloud/portal/cloud-portal-api-tab.mdx +++ b/cloud/portal/cloud-portal-api-tab.mdx @@ -28,7 +28,7 @@ The RavenDB Cloud API allows you to automate actions on your RavenDB Cloud produ !["Figure 1 - The API Tab"](./assets/portal-api-tab-overview.png) -You can read more about the *RavenDB Cloud API* in the [API](../../cloud/cloud-api.mdx) page. +You can read more about the *RavenDB Cloud API* in the [API](../cloud-api.mdx) page. ### Create API Key !["Figure 2 - Create API Key"](./assets/portal-api-tab-empty-api-key-list.png) diff --git a/cloud/portal/cloud-portal-backups-tab.mdx b/cloud/portal/cloud-portal-backups-tab.mdx index cb19166cce..17b8dcf332 100644 --- a/cloud/portal/cloud-portal-backups-tab.mdx +++ b/cloud/portal/cloud-portal-backups-tab.mdx @@ -16,9 +16,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; -Your RavenDB cloud products run [a mandatory backup routine](../../cloud/cloud-backup-and-restore.mdx#the-mandatory-backup-routine). +Your RavenDB cloud products run [a mandatory backup routine](../cloud-backup-and-restore.mdx#the-mandatory-backup-routine). Backup files created by this routine are stored in a RavenDB cloud you have no direct access to, but you can see their list -from the portal's Backups tab and [restore them](../../cloud/cloud-backup-and-restore.mdx#restore-mandatory-backup-files) using your +from the portal's Backups tab and [restore them](../cloud-backup-and-restore.mdx#restore-mandatory-backup-files) using your management Studio. * In this page: diff --git a/cloud/portal/cloud-portal-products-tab.mdx b/cloud/portal/cloud-portal-products-tab.mdx index 0119fce182..0feaa3abbe 100644 --- a/cloud/portal/cloud-portal-products-tab.mdx +++ b/cloud/portal/cloud-portal-products-tab.mdx @@ -16,11 +16,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; -The Products tab lets you [provision](../../cloud/cloud-overview.mdx#provisioning) a new cloud product, or manage an existing one. +The Products tab lets you [provision](../cloud-overview.mdx#provisioning) a new cloud product, or manage an existing one. -You can provision products of three types: [Free](../../cloud/cloud-overview.mdx#the-free-tier), -[Development](../../cloud/cloud-overview.mdx#the-development-tier) -and [Production](../../cloud/cloud-overview.mdx#the-production-tier). +You can provision products of three types: [Free](../cloud-overview.mdx#the-free-tier), +[Development](../cloud-overview.mdx#the-development-tier) +and [Production](../cloud-overview.mdx#the-production-tier). * In this page: * [Provisioning a New Product](#provisioning-a-new-product) @@ -60,14 +60,14 @@ Use the Plan page to choose your product's cloud **Provider**, **Region**, **Tie Select where your equipment would be physically located. 3. **Tier** - You can raise a [Free node](../../cloud/cloud-instances.mdx#a-free-cloud-node), - a [Development node](../../cloud/cloud-instances.mdx#a-development-cloud-server) or a - [Production cluster](../../cloud/cloud-instances.mdx#a-production-cloud-cluster). - Learn more about them in the [Tiers and Instances](../../cloud/cloud-instances.mdx) page. + You can raise a [Free node](../cloud-instances.mdx#a-free-cloud-node), + a [Development node](../cloud-instances.mdx#a-development-cloud-server) or a + [Production cluster](../cloud-instances.mdx#a-production-cloud-cluster). + Learn more about them in the [Tiers and Instances](../cloud-instances.mdx) page. 4. **Instance** Choose the instance type that best suits your requirements. - Learn more about them in the [Tiers and Instance](../../cloud/cloud-instances.mdx) page. + Learn more about them in the [Tiers and Instance](../cloud-instances.mdx) page. 5. **Storage** Select disk type and size. @@ -180,7 +180,7 @@ You can view your configuration and change your product's instance type and stor Click this button to open the RavenDB Studio of node A. ### Security: Your Certificate, Audit Logs and Allowed IPs -Use the security tab to download your [certificate](../../cloud/cloud-security.mdx) or determine which addresses are +Use the security tab to download your [certificate](../cloud-security.mdx) or determine which addresses are allowed to connect your database instance. !["Figure 19 - Manage Product: Manage access"](./assets/portal-product-details-manage-access.png) diff --git a/cloud/portal/cloud-portal-support-tab.mdx b/cloud/portal/cloud-portal-support-tab.mdx index 84844f37b0..251115dc31 100644 --- a/cloud/portal/cloud-portal-support-tab.mdx +++ b/cloud/portal/cloud-portal-support-tab.mdx @@ -40,7 +40,7 @@ The root selection is between submitting a support request regarding a **general **5**. Enter your question. **6**. Submit your support request. -You can read more about the *Severity* and *Response time* types in the [Support](../../cloud/cloud-support.mdx#response-time-types) page. +You can read more about the *Severity* and *Response time* types in the [Support](../cloud-support.mdx#response-time-types) page. ### Submit a Product-Related Support Request !["Figure 3 - Support Product-Related Message"](./assets/portal-support-instance-related-question-cloud-support.png) @@ -55,7 +55,7 @@ You can read more about the *Severity* and *Response time* types in the [Support **8**. Enter your question. **9**. Submit your support request. -You can read more about the *Severity* and *Response time* types in the [Support](../../cloud/cloud-support.mdx#response-time-types) page. +You can read more about the *Severity* and *Response time* types in the [Support](../cloud-support.mdx#response-time-types) page. ### Request to enable the Cloud Support option !["Figure 4 - Request to enable the Cloud Support option"](./assets/portal-support-request-cloud-support-on-free-support.png) @@ -74,6 +74,6 @@ will be confirmed in a separate email. Cloud Support activation takes up to **3 business days**. -You can read more about available *support options* in the [Support](../../cloud/cloud-support.mdx#available-support-options) page. +You can read more about available *support options* in the [Support](../cloud-support.mdx#available-support-options) page. diff --git a/cloud/portal/cloud-portal.mdx b/cloud/portal/cloud-portal.mdx index 2df4954fd4..6274ee340a 100644 --- a/cloud/portal/cloud-portal.mdx +++ b/cloud/portal/cloud-portal.mdx @@ -16,7 +16,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; -[Logging into your account](../../cloud/cloud-overview.mdx#login-to-your-account) +[Logging into your account](../cloud-overview.mdx#login-to-your-account) takes you to your account's Portal, which gives you access to all the different aspects of your cloud account. * In this page: @@ -26,28 +26,28 @@ takes you to your account's Portal, which gives you access to all the different !["Figure 1 - Cloud Portal overview"](./assets/portal-tabs.png) -* **[The Home Tab](../../cloud/portal/cloud-portal-home-tab.mdx)** +* **[The Home Tab](./cloud-portal-home-tab.mdx)** Use this tab to manage your account and assigned roles, and to view useful resources. -* **[The Products Tab](../../cloud/portal/cloud-portal-products-tab.mdx)** - Use this tab to [provision new products](../../cloud/portal/cloud-portal-products-tab.mdx#provisioning-a-new-product) and - [manage existing ones](../../cloud/portal/cloud-portal-products-tab.mdx#managing-an-existing-product). +* **[The Products Tab](./cloud-portal-products-tab.mdx)** + Use this tab to [provision new products](./cloud-portal-products-tab.mdx#provisioning-a-new-product) and + [manage existing ones](./cloud-portal-products-tab.mdx#managing-an-existing-product). -* **[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab.mdx)** - Use this tab to view and restore [mandatory database backups](../../cloud/cloud-backup-and-restore.mdx#the-mandatory-backup-routine) +* **[The Backups Tab](./cloud-portal-backups-tab.mdx)** + Use this tab to view and restore [mandatory database backups](../cloud-backup-and-restore.mdx#the-mandatory-backup-routine) that your instances have created for you. -* **[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab.mdx)** +* **[The Billing & Costs Tab](./cloud-portal-billing-tab.mdx)** Use the Billing & Costs tab to view your billing history and expected payments. -* **[The API Tab](../../cloud/portal/cloud-portal-api-tab.mdx)** +* **[The API Tab](./cloud-portal-api-tab.mdx)** Use the API tab to explore the RavenDB Cloud API and manage your API keys. -* **[The Support Tab](../../cloud/portal/cloud-portal-support-tab.mdx)** - Use this tab to contact Support regarding [general issues](../../cloud/portal/cloud-portal-support-tab.mdx#submit-a-general-support-request), - [product-specific issues](../../cloud/portal/cloud-portal-support-tab.mdx#submit-a-product-related-support-request) and special requests. +* **[The Support Tab](./cloud-portal-support-tab.mdx)** + Use this tab to contact Support regarding [general issues](./cloud-portal-support-tab.mdx#submit-a-general-support-request), + [product-specific issues](./cloud-portal-support-tab.mdx#submit-a-product-related-support-request) and special requests. -* **[The Account Tab](../../cloud/portal/cloud-portal-account-tab.mdx)** +* **[The Account Tab](./cloud-portal-account-tab.mdx)** Use the account tab to view and edit your invoices and credit card information. * **[The Service Status Tab](https://status.ravendb.net/)** diff --git a/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx b/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx index 797e625fe5..706af9a90f 100644 --- a/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx +++ b/docs/ai-integration/ai-agents/content/_reading-conversation-history-csharp.mdx @@ -19,7 +19,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; * This page covers: reading and paging through a conversation's messages, choosing the level of detail, and inspecting tool calls and sub-conversations. -* Learn how to create and run a conversation in [Managing conversations](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations). +* Learn how to create and run a conversation in [Managing conversations](../creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations). * In this article: * [Get the conversation messages](#get-the-conversation-messages) @@ -197,7 +197,7 @@ At the `Detailed` or `Full` detail level, the `ToolCalls` list of a message from the tool calls the LLM made. Each entry is an [AiToolCallResult](#conversation-history-classes) object, giving the tool's `Name`, the `Arguments` the LLM passed, and the `Result` the tool returned. -An agent can hand work to another agent (a [sub-agent](../../../ai-integration/ai-agents/multi-agents.mdx)). +An agent can hand work to another agent (a [sub-agent](../multi-agents.mdx)). The exchange with a sub-agent is held in its own conversation (a **sub-conversation**). When a tool call invoked a sub-agent, the tool call's `SubConversationId` points to the @@ -247,7 +247,7 @@ foreach (AiConversationMessage message in trace.Messages) See [AiConversationMessage](#conversation-history-classes) and [AiToolCallResult](#conversation-history-classes) in the [Syntax](#syntax) section. -See [Multi-agents](../../../ai-integration/ai-agents/multi-agents.mdx) for the full sub-agent picture. +See [Multi-agents](../multi-agents.mdx) for the full sub-agent picture. @@ -363,7 +363,7 @@ class AiConversationMessagesResult | **ConversationId** | `string` | The conversation document ID. | | **Agent** | `string` | The identifier of the AI agent this conversation belongs to. | | **Parameters** | `Dictionary` | The conversation parameters as a name-to-value map. | -| **TotalUsage** | `AiUsage` | Cumulative token usage across all turns of the conversation.
See [AiUsage](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes). | +| **TotalUsage** | `AiUsage` | Cumulative token usage across all turns of the conversation.
See [AiUsage](../creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes). | | **LastMessageAt** | `DateTime` | The time the last message was added to the conversation. | | **Messages** | `List` | The returned messages, in chronological order (oldest first). | | **HasMoreMessages** | `bool` | `true` when more messages exist beyond the returned page: older messages when `Before` is set (or neither is set), newer messages when `After` is set. | @@ -399,7 +399,7 @@ class AiConversationMessage | **Attachments** | `List` | Names of the attachments associated with this message, if any. | | **Timestamp** | `DateTime` | The time the message was recorded (UTC). Unique within the conversation and rising in message order, so a `Timestamp` value can be used to page through the conversation. | | **ToolCalls** | `List` | Tool calls initiated by the LLM in this message, with their results inlined. `null` when the message has no tool calls. | -| **Usage** | `AiUsage` | Token usage for this message, or `null` for messages the LLM did not generate (such as user messages and system prompts).
See [AiUsage](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes). | +| **Usage** | `AiUsage` | Token usage for this message, or `null` for messages the LLM did not generate (such as user messages and system prompts).
See [AiUsage](../creating-ai-agents/creating-ai-agents_api.mdx#conversation-and-response-classes). | | **SubConversationId** | `string` | For an `Internal` role message, the ID of the sub-conversation the message relates to. | diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx index 3f8ad128ba..2a1a0791ab 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx @@ -51,7 +51,7 @@ import ContentFrame from "@site/src/components/ContentFrame"; Your agent will need a connection string to connect with the LLM. Create a connection string using an `AiConnectionString` instance and the `PutConnectionStringOperation` operation. -You can also create a connection string using Studio, see [here](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-basic-settings) +You can also create a connection string using Studio, see [here](../creating-ai-agents_studio.mdx#configure-basic-settings) Choose a provider based on your needs. @@ -458,7 +458,7 @@ own trust requirements regardless of which parent invokes it. * **Note** that this policy is only meaningful when the agent is used as a sub-agent. On a root agent, the value is always provided when the conversation is started. -See [Multi-agents](../../../../ai-integration/ai-agents/multi-agents.mdx#forbidding-the-parent-from-generating-a-parameter-value) +See [Multi-agents](../../multi-agents.mdx#forbidding-the-parent-from-generating-a-parameter-value) for the full picture, including an end-to-end example. --- @@ -504,7 +504,7 @@ agent tools in response to a single user prompt. Use `MaxModelIterationsPerCall` Note that you can improve the TTFB (Time To First Byte) by getting the LLM's response in chunks using streaming. -Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). +Find more about streaming in the [overview](../../overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). @@ -512,7 +512,7 @@ Find more about streaming in the [overview](../../../../ai-integration/ai-agents ### Set chat trimming configuration -To [summarize the conversation](../../../../ai-integration/ai-agents/overview.mdx#define-a-chat-trimming-configuration), create an `AiAgentChatTrimmingConfiguration` instance, +To [summarize the conversation](../../overview.mdx#define-a-chat-trimming-configuration), create an `AiAgentChatTrimmingConfiguration` instance, use it to configure your trimming strategy, and set the agent's `ChatTrimming` property with the instance. @@ -554,11 +554,11 @@ After defining agent tools and submitting them to the LLM, it is up to the LLM t ### Query tools -[Query tools](../../../../ai-integration/ai-agents/overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database. +[Query tools](../../overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database. A query tool includes a natural-language **description** that explains the LLM what the tool is for, and an **RQL query**. * **Passing values to query tools** - * Query tools optionally include [parameters](../../../../ai-integration/ai-agents/overview.mdx#query-parameters), identified by a `$` prefix. + * Query tools optionally include [parameters](../../overview.mdx#query-parameters), identified by a `$` prefix. Both the user and the LLM can pass values to these parameters. * **Passing values from the user** Users can pass values to queries through **agent parameters**. @@ -634,7 +634,7 @@ A query tool includes a natural-language **description** that explains the LLM w #### Initial-context queries -* You can set a query tool as an [initial-context query](../../../../ai-integration/ai-agents/overview.mdx#initial-context-queries) using its `Options.AddToInitialContext` property, to execute the query and provide the LLM with its results immediately when the agent is started. +* You can set a query tool as an [initial-context query](../../overview.mdx#initial-context-queries) using its `Options.AddToInitialContext` property, to execute the query and provide the LLM with its results immediately when the agent is started. * An initial-context query is **not allowed** to use LLM parameters, since the query runs before the conversation starts, earlier than the first communication with the LLM, and the LLM will have no opportunity to fill the parameters with values. * An initial-context query **is** allowed to use agent parameters, whose values are provided by the user even before the query is executed. @@ -730,7 +730,7 @@ deciding whether to delegate to that sub-agent. For the full conceptual picture - parameter propagation, sub-conversation isolation, action-tool path routing, and security considerations - see -[Multi-agents](../../../../ai-integration/ai-agents/multi-agents.mdx). +[Multi-agents](../../multi-agents.mdx). **Example** ```csharp @@ -759,7 +759,7 @@ they can be referenced. An agent cannot spawn a new agent at runtime.
See [AiAgentToolSubAgent](#agent-tool-classes) in the [Syntax](#syntax) section. -See [Multi-agents](../../../../ai-integration/ai-agents/multi-agents.mdx) for the end-to-end picture. +See [Multi-agents](../../multi-agents.mdx) for the end-to-end picture. @@ -900,7 +900,7 @@ See [Conversation](#conversation-execution), [SetUserPrompt](#conversation-execu
To read the messages of a stored conversation back from the server, see -[Reading conversation history](../../../../ai-integration/ai-agents/reading-conversation-history.mdx). +[Reading conversation history](../../reading-conversation-history.mdx). @@ -980,7 +980,7 @@ levels.
-See [Multi-agents: Action tool routing back to the client](../../../../ai-integration/ai-agents/multi-agents.mdx#action-tool-routing-back-to-the-client) +See [Multi-agents: Action tool routing back to the client](../../multi-agents.mdx#action-tool-routing-back-to-the-client) for the full picture. @@ -1251,7 +1251,7 @@ See [AddAttachment](#conversation-execution) and [CopyAttachmentFrom](#conversat -You can set the agent to [stream the LLM's response to the client](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `StreamAsync` method, instead of using [RunAsync](#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. +You can set the agent to [stream the LLM's response to the client](../../overview.mdx#streaming-llm-responses) in real time as the LLM generates it, using the `StreamAsync` method, instead of using [RunAsync](#setting-user-prompt-and-running-the-conversation) which sends the whole response to the client when it is fully prepared. Streaming the response allows the client to start processing it before it is complete, which can improve the application's responsiveness. @@ -2268,7 +2268,7 @@ class AiAgentToolSubAgent | **Identifier** | `string` | The identifier of an existing agent that this agent may invoke as a sub-agent.
The referenced agent must be created in the same database. | | **Description** | `string` | A short description the LLM reads when deciding whether to delegate to this sub-agent. | -See [Multi-agents](../../../../ai-integration/ai-agents/multi-agents.mdx) for the full picture, including parameter propagation and sub-conversation isolation. +See [Multi-agents](../../multi-agents.mdx) for the full picture, including parameter propagation and sub-conversation isolation. diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx index ca0f096c55..408577370f 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-nodejs.mdx @@ -14,7 +14,7 @@ import Panel from "@site/src/components/Panel"; * Once the agent is created, the client can initiate or resume **conversations**, get LLM responses, and perform actions based on LLM insights. * This article provides a step-by-step guide to creating an AI agent and interacting with it using the **client API**. - To create an AI agent from Studio, see [Creating AI agents - Studio](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx). + To create an AI agent from Studio, see [Creating AI agents - Studio](../creating-ai-agents_studio.mdx). * In this article: * [Create a connection string](#creating-a-connection-string) @@ -43,9 +43,9 @@ import Panel from "@site/src/components/Panel"; Your agent will need a connection string to connect to a **conversational or text generation LLM**. RavenDB supports the following providers for these model types: -[Ollama](../../../../ai-integration/connection-strings/ollama.mdx), -[OpenAI and compatible providers](../../../../ai-integration/connection-strings/open-ai.mdx), -and [Azure OpenAI](../../../../ai-integration/connection-strings/azure-open-ai.mdx). +[Ollama](../../../connection-strings/ollama.mdx), +[OpenAI and compatible providers](../../../connection-strings/open-ai.mdx), +and [Azure OpenAI](../../../connection-strings/azure-open-ai.mdx). Choose the model that best suits your needs: You can use a local _Ollama_ model if your priorities are speed, cost, open-source usage, or security. @@ -56,9 +56,9 @@ Or use a remote _OpenAI_ service for its broader resources and capabilities. * **From the Studio**: You can define a connection string in the _AI Connection Strings_ view. - See [AI connection strings - Overview](../../../../ai-integration/connection-strings/overview.mdx). + See [AI connection strings - Overview](../../../connection-strings/overview.mdx). You can also create a connection string when defining an AI agent. - See [Configure basic settings](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-basic-settings). + See [Configure basic settings](../creating-ai-agents_studio.mdx#configure-basic-settings). --- @@ -139,9 +139,9 @@ const putConnectionStringResult = await documentStore.maintenance.send(putConnec **Syntax reference** See the dedicated syntax sections in the following articles for full configuration details: -* [Ollama (syntax)](../../../../ai-integration/connection-strings/ollama.mdx#syntax) -* [OpenAI and compatible providers (syntax)](../../../../ai-integration/connection-strings/open-ai.mdx#syntax) -* [Azure OpenAI (syntax)](../../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax) +* [Ollama (syntax)](../../../connection-strings/ollama.mdx#syntax) +* [OpenAI and compatible providers (syntax)](../../../connection-strings/open-ai.mdx#syntax) +* [Azure OpenAI (syntax)](../../../connection-strings/azure-open-ai.mdx#syntax) @@ -333,7 +333,7 @@ agentConfiguration.maxModelIterationsPerCall = 3; * Note that you can reduce Time To First Byte (TTFB) by streaming the LLM response as it is being generated. This allows the LLM to return selected fields in chunks before the full response is complete. -* Find more about streaming in [Streaming LLM responses - overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) +* Find more about streaming in [Streaming LLM responses - overview](../../overview.mdx#streaming-llm-responses) and in [Stream LLM responses](#stream-llm-responses) below. @@ -383,7 +383,7 @@ agentConfiguration.chatTrimming = { ### Query tools -* [Query tools](../../../../ai-integration/ai-agents/overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database. +* [Query tools](../../overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database. Each query tool includes: * **Description** - a natural-language description that tells the LLM when to use it, * **RQL** - an [RQL query](../../../../querying/rql/what-is-rql.mdx) that defines what data to retrieve. @@ -471,7 +471,7 @@ agentConfiguration.chatTrimming = { #### Initial-context queries -* Use the `options.addToInitialContext` property to configure a query tool as an [initial-context query](../../../../ai-integration/ai-agents/overview.mdx#initial-context-queries) +* Use the `options.addToInitialContext` property to configure a query tool as an [initial-context query](../../overview.mdx#initial-context-queries) so that it executes immediately when the agent starts, before the LLM receives any user input. The results are provided to the LLM as part of the initial conversation context. @@ -841,7 +841,7 @@ The status can be: ### Stream LLM responses * Instead of calling `run`, which returns the LLM's response to the client when it is fully prepared, - you can call `stream` to [Stream LLM responses](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses), + you can call `stream` to [Stream LLM responses](../../overview.mdx#streaming-llm-responses), and receive the LLM's response in real time as it is being generated. * Streaming allows the client to start processing the response before it is complete, diff --git a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx index 1110ec9a62..dea60de083 100644 --- a/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx +++ b/docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-python.mdx @@ -46,7 +46,7 @@ import Panel from "@site/src/components/Panel"; Your agent will need a connection string to connect with the LLM. Create a connection string using an `AiConnectionString` instance and the `PutConnectionStringOperation` operation. -(You can also create a connection string using Studio, see [here](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-basic-settings)) +(You can also create a connection string using Studio, see [here](../creating-ai-agents_studio.mdx#configure-basic-settings)) You can use a local `Ollama` model if your considerations are mainly speed, cost, open-source, or security, Or you can use a remote `OpenAI` service for its additional resources and capabilities. @@ -371,7 +371,7 @@ agent tools in response to a single user prompt. Use `max_model_iterations_per_c Note that you can improve the TTFB (Time To First Byte) by getting the LLM's response in chunks using streaming. -Find more about streaming in the [overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). +Find more about streaming in the [overview](../../overview.mdx#streaming-llm-responses) and [below](#stream-llm-responses). @@ -379,7 +379,7 @@ Find more about streaming in the [overview](../../../../ai-integration/ai-agents ### Set chat trimming configuration -To [summarize the conversation](../../../../ai-integration/ai-agents/overview.mdx#define-a-chat-trimming-configuration), create an `AiAgentChatTrimmingConfiguration` instance, +To [summarize the conversation](../../overview.mdx#define-a-chat-trimming-configuration), create an `AiAgentChatTrimmingConfiguration` instance, use it to configure your trimming strategy, and set the agent's `chat_trimming` property with the instance. @@ -446,11 +446,11 @@ After defining agent tools and submitting them to the LLM, it is up to the LLM t ### Query tools -[Query tools](../../../../ai-integration/ai-agents/overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database. +[Query tools](../../overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database. A query tool includes a natural-language **description** that explains the LLM what the tool is for, and an **RQL query**. * **Passing values to query tools** - * Query tools optionally include [parameters](../../../../ai-integration/ai-agents/overview.mdx#query-parameters), identified by a `$` prefix. + * Query tools optionally include [parameters](../../overview.mdx#query-parameters), identified by a `$` prefix. Both the user and the LLM can pass values to these parameters. * **Passing values from the user** Users can pass values to queries through **agent parameters**. @@ -538,7 +538,7 @@ A query tool includes a natural-language **description** that explains the LLM w